Skip to main content

Define routines as structured algorithmic workflows

Project description

routix

Routix is a lightweight Python toolkit for designing and executing structured algorithmic workflows.

It provides:

  • Subroutine-based execution control (SubroutineController)
  • Structured flow validation (SubroutineFlowValidator)
  • Dot-accessible configuration trees (DynamicDataObject)
  • Logging with routine-context traceability
  • Experiment summary and timing support
  • Abstract base classes for runners in src/routix/runner/ for extensible workflow execution patterns

Subroutine Flow Data Format

Routix executes algorithmic workflows based on a structured and validated subroutine flow. Each step in the flow is represented by a dictionary with clearly defined keys, enabling modular orchestration, logging, and reproducibility.

# my_flow.yaml
- method: initialize
- method: repeat
  params:
    n_repeats: 3
    routine_data:
      - method: sample_method
        params:
          value: 42

For more details, refer to subroutine_flow_data.md.

Abstract base classes for runners

Classes in routix.runner are extensible abstract base classes for implementing custom workflow runners. These classes provide a foundation for building repeatable, modular, and testable execution patterns for algorithmic experiments.

  • SingleInstanceRunner: An abstract base class for running a single problem instance. It provides a template for implementing the logic for one experiment, including setup, execution, and result collection.
    • Typical usage: custom solvers, single-run experiments, or as a building block for higher-level runners.
  • InstanceSetRunner: An abstract base class for running a set of problem instances. It defines the interface and core logic for iterating over multiple instances, managing results, and integrating with experiment summaries.
    • Typical usage: batch experiments, benchmarking, or automated evaluation over a dataset.

Both classes are designed to be subclassed and extended. You can implement your own runner by inheriting from these base classes and overriding the required methods to fit your workflow.

For implementation details, see the source files in src/routix/runner/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

routix-0.0.7.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

routix-0.0.7-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file routix-0.0.7.tar.gz.

File metadata

  • Download URL: routix-0.0.7.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.2

File hashes

Hashes for routix-0.0.7.tar.gz
Algorithm Hash digest
SHA256 0142e29cd8211e8fdddb09bd3157f4201c996145f674b39329d41b2a9a622827
MD5 8e6e5ad08c98c620b212c3be4db3c4b5
BLAKE2b-256 71e2146959052d1038008a69f6cf52e6cb3bf3ae8916ee2782f083fc4c76b85b

See more details on using hashes here.

File details

Details for the file routix-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: routix-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.2

File hashes

Hashes for routix-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2ff27d48e10b421e885bd913a7d855038a68ecd7f71c580bc2352fd21bdfaa03
MD5 61bbc6f2bfee2aa143eca9bcd2568158
BLAKE2b-256 9592b6d08863d7696424366200faaeccf3bd827804acec1c76e2c37444285bca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page