Skip to content

Repository files navigation

StepUp Core

release pytest mkdocs PyPI Version DOI PyPI - Python Version LGPL-3 License CodeFactor

StepUp is a dynamic build tool and a modern alternative to Make. Its defining feature is that workflow generation and execution are unified: a plan.py script defines the initial build steps. While the workflow is being executed, any step can add more steps and dependencies, based on the outputs built so far. This makes StepUp ideal for builds where the full set of dependencies cannot be determined in advance.

StepUp Core provides the basic framework for StepUp, without any domain-specific features. Those live in extension packages:

  • StepUp RepRep for creating reproducible reports: papers, presentations, theses, etc.
  • StepUp Queue submits jobs to a SLURM scheduler.

Installation

pip install stepup

See the installation guide for details.

Quick Visual Impression

asciicast

Documentation

Full documentation, including a tutorial and a feature overview, is available at https://reproducible-reporting.github.io/stepup-core.

License

StepUp Core is distributed under the terms of the LGPL-3.0-or-later license. Contributions are welcome; see the development guide to get started.