User guide

User guide:

• How to install Outflow
  • Install Python
  • Install the Outflow code
• Tasks
  • Create a task from a function
  • Create a task by subclassing Task
  • Create a Task template
  • Running a task directly
  • Targets
  • Task definition alternatives
• Workflows
  • Workflow definition
  • Using decorator on special workflow classes
• Commands
  • Create a command
  • Create subcommands
  • Built-in commands
• Database
  • The outflow database
  • Connect to a postgres database
  • Setup connection to multiple databases
• Backend
  • Default backend
  • Parallel backend
  • Slurm backend
  • Specify a backend
• Migrations
  • The Commands
  • Backend Support
• Outflow settings
  • The basics
  • Designating the settings
  • Default settings
  • Using settings in Python code
  • Altering settings at runtime
  • Available settings
  • Creating your own settings
• Outflow configuration
  • The basics
  • Designating the configuration file
  • Default configuration
  • Using the configuration in the code
  • Altering the configuration at runtime
  • Creating your own configuration fields
  • Include other yaml files from your config.yml
• Logging
  • Logging from tasks
  • Configuring your logger
• Dashboard
  • Set up Hasura
  • View the task workflow
• Design Patterns
  • Use config or cli arguments inside the workflow definition
  • Define workflows and commands outside plugins
  • Nesting MapWorkflow and IterativeWorkflow
• Example Workflows
• Library
  • Tasks
  • MapWorkflow
  • LoopWorkflow