Skip to main content

Define routines as structured algorithmic workflows

Reason this release was yanked:

No version record on GitHub repo

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.8.tar.gz (22.6 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.8-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for routix-0.0.8.tar.gz
Algorithm Hash digest
SHA256 1fc212239a3b6fde7aaa8a8a895c42b3fe956230b639339afc5a9fea0c879d17
MD5 669d77c361aea83517e74d5f45bacaa3
BLAKE2b-256 a4121892f1c5c4ba2c3fcd2608625872f44e0983ea213b907eeef140702e155b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for routix-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a7c24c5247f44cf5d564f2b7ee1f49ec6b6373ec252d36c38156a23d6c70bc93
MD5 220dda292f88f42d93eb7f7896ba12b8
BLAKE2b-256 b2c17f4bba49ce79077515773a1f7a0076cb7aecb7b59591ee147075321e04f9

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