/ceci

Experimental pipeline prototype software

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Ceci Logo

Ceci Pipeline Software

Continuous Integration Status Documentation Status Coverage Status PyPI Downloads

“Ceci n'est pas une pipeline.”

A lightweight parsl-based framework for running DESC pipelines.

This is now beta status.

Install

pip install ceci

This installs the simplest version of ceci, if you want to be able to use the parsl backend, install instead ceci[parsl].

You can then run an example pipeline from the ceci_lib directory using:

export PYTHONPATH=$PYTHONPATH:$PWD
ceci test/test.yml

Adding Pipeline Stages

To make new pipeline stages, you must:

  • make a new python package somewhere else, to contain your stages.
  • the package must have an __init__.py file that should import from . all the stages you want to use.
  • it must also have a file __main__.py with the same contents as the example in ceci_example.
  • each stage is its own class inheriting from ceci.PipelineStage. Each must define its name, inputs, and outputs, and a run method.
  • the run method should use the parent methods from PipelineStage to get its inputs and outputs etc.