| Name | ceci JSON |
| Version |
2.0.1
JSON |
| download |
| home_page | None |
| Summary | Lightweight pipeline engine for LSST DESC |
| upload_time | 2024-07-11 13:17:09 |
| maintainer | None |
| docs_url | None |
| author | Joe Zuntz |
| requires_python | None |
| license | BSD 3-Clause License |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
<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.
Raw data
{
"_id": null,
"home_page": null,
"name": "ceci",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Joe Zuntz",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f2/0d/4642898369bd61e1688de72825f7fb8ff6118e7edb228a4b287b246beae1/ceci-2.0.1.tar.gz",
"platform": null,
"description": "\n\n\n<h2 align=\"center\">Ceci Pipeline Software</h2>\n\n<p align=\"center\">\n<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>\n<a href='https://ceci.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/ceci/badge/?version=latest' alt='Documentation Status' /></a>\n<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>\n<a href=\"https://pypi.org/project/ceci/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/ceci\"></a>\n<a href=\"https://pepy.tech/project/ceci\"><img alt=\"Downloads\" src=\"https://pepy.tech/badge/ceci\"></a>\n</p>\n\n> \u201cCeci n'est pas une pipeline.\u201d\n\nA lightweight parsl-based framework for running DESC pipelines.\n\nThis is now beta status.\n\n## Install\n\n```bash\npip install ceci\n```\nThis installs the simplest version of ceci, if you want to be able\nto use the parsl backend, install instead `ceci[parsl]`.\n\nYou can then run an example pipeline from the ceci_lib directory using:\n\n```bash\nexport PYTHONPATH=$PYTHONPATH:$PWD\nceci test/test.yml\n```\n\n\nAdding Pipeline Stages\n----------------------\n\nTo make new pipeline stages, you must:\n\n- make a new python package somewhere else, to contain your stages.\n- the package must have an `__init__.py` file that should import from `.` all the stages you want to use.\n- it must also have a file `__main__.py` with the same contents as the example in `ceci_example`.\n- each stage is its own class inheriting from `ceci.PipelineStage`. Each must define its name, inputs, and outputs, and a run method.\n- the run method should use the parent methods from `PipelineStage` to get its inputs and outputs etc.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Lightweight pipeline engine for LSST DESC",
"version": "2.0.1",
"project_urls": {
"homepage": "https://github.com/LSSTDESC/ceci"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f20d4642898369bd61e1688de72825f7fb8ff6118e7edb228a4b287b246beae1",
"md5": "d80f0fe13d8c5ae02d1906b43975d11a",
"sha256": "3f3e2f79a8c43f4a32a02ca00fe8401ec1f99388d48d7cd7747f276bf27efd82"
},
"downloads": -1,
"filename": "ceci-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "d80f0fe13d8c5ae02d1906b43975d11a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 143987,
"upload_time": "2024-07-11T13:17:09",
"upload_time_iso_8601": "2024-07-11T13:17:09.365760Z",
"url": "https://files.pythonhosted.org/packages/f2/0d/4642898369bd61e1688de72825f7fb8ff6118e7edb228a4b287b246beae1/ceci-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-11 13:17:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LSSTDESC",
"github_project": "ceci",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ceci"
}
