Metadata-Version: 2.1
Name: ceci
Version: 1.9
Summary: Lightweight pipeline engine for LSST DESC
Home-page: https://github.com/LSSTDESC/ceci
Maintainer: Joe Zuntz
License: BSD
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Development Status :: 3 - Alpha
Description-Content-Type: text/markdown
Provides-Extra: parsl
Provides-Extra: cwl
Provides-Extra: test
License-File: LICENSE

![Ceci Logo](ceci.png)


<h2 align="center">Ceci Pipeline Software</h2>

<p align="center">
<a href="https://github.com/LSSTDESC/ceci/actions?query=workflow%3A%22Continuous+Integration%22"><img alt="Continuous Integration Status" src="https://github.com/LSSTDESC/ceci/workflows/Continuous%20Integration/badge.svg"></a>
<a href='https://ceci.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/ceci/badge/?version=latest' alt='Documentation Status' /></a>
<a href="https://codecov.io/gh/LSSTDESC/ceci"><img alt="Coverage Status" src="https://codecov.io/gh/LSSTDESC/ceci/branch/master/graph/badge.svg"></a>
<a href="https://pypi.org/project/ceci/"><img alt="PyPI" src="https://img.shields.io/pypi/v/ceci"></a>
<a href="https://pepy.tech/project/ceci"><img alt="Downloads" src="https://pepy.tech/badge/ceci"></a>
</p>

> “Ceci n'est pas une pipeline.”

A lightweight parsl-based framework for running DESC pipelines.

This is now beta status.

## Install

```bash
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:

```bash
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.


