SANE Workflows

Contents:

  • Getting Started
    • SANE Workflows
      • Overview
      • Use Case and Alternatives
      • Install
      • Quickstart
        • Python Usage
        • JSON Usage
        • GitHub Actions Usage
        • Creating a workflow
        • Running a workflow
  • Tutorial
    • Structure
      • Python Interfacing
        • Preface
        • Orchestrator
        • Hosts
        • Actions
        • Running
        • Extending the workflow
      • JSON Interface
        • Preface
        • Orchestrator
        • Hosts
        • Actions
        • Running
        • Extending the workflow
  • User Guide
    • Running Workflows
      • Runner
      • Paths
      • Selecting Actions
      • Execution
      • Results
      • Saves
      • Advanced Usage
        • Specific Host
        • View Graph
        • Verbose
        • Debug
        • Virtual Relaunch
    • Writing Workflows
      • Attribute Dereferencing
        • Basic JSON Example
        • Basic Python Example
        • Callables
        • How SANE Implements Dereferencing
        • Direct API Usage in Python
        • Runtime Notes and Safety
        • More Examples
        • Summary
      • Custom Classes
        • Custom Option Loading
        • Primary User Interface Function
        • Python Example
        • JSON Interfacing
        • Summary
      • Specific Classes
        • Custom Actions
        • Custom Hosts
    • Best Practices
      • Dry Runs
      • Modular Testing
        • Single Responsibility Action
        • Helper Scripts
      • Workflow Layout
        • Module conficts
        • Out-of-source injection
        • Sync Actions
      • Custom Classes
        • Inheritance
        • JSON support
        • pre/post launch/run
  • Reference
    • CLI
    • JSON
    • API
      • Orchestrator
        • register()
        • Orchestrator
      • Action
        • DependencyType
        • ActionState
        • ActionStatus
        • Action
      • Host
        • Host
      • Environment
        • Environment
      • Resources
        • Resource
        • AcquirableResource
        • ResourceRequestor
        • ResourceProvider
        • NonLocalProvider
        • ResourceMapper
      • OptionLoader
        • OptionLoader
      • Logger
        • STDOUT
        • ACT_INFO
        • MAIN_LOG
        • Logger
      • Helpers
        • recursive_update()
SANE Workflows
  • User Guide
  • View page source

User Guide

Contents:

  • Running Workflows
    • Runner
    • Paths
    • Selecting Actions
    • Execution
    • Results
    • Saves
    • Advanced Usage
      • Specific Host
      • View Graph
      • Verbose
      • Debug
      • Virtual Relaunch
  • Writing Workflows
    • Attribute Dereferencing
      • Basic JSON Example
      • Basic Python Example
      • Callables
      • How SANE Implements Dereferencing
      • Direct API Usage in Python
      • Runtime Notes and Safety
      • More Examples
      • Summary
    • Custom Classes
      • Custom Option Loading
      • Primary User Interface Function
      • Python Example
      • JSON Interfacing
      • Summary
    • Specific Classes
      • Custom Actions
      • Custom Hosts
  • Best Practices
    • Dry Runs
    • Modular Testing
      • Single Responsibility Action
      • Helper Scripts
    • Workflow Layout
      • Module conficts
      • Out-of-source injection
      • Sync Actions
    • Custom Classes
      • Inheritance
      • JSON support
      • pre/post launch/run
Previous Next

© Copyright 2025, islas.

Built with Sphinx using a theme provided by Read the Docs.