Pipe Dreams: API for publication of scientific data
Project description
🔬 Pipe Dreams
Do you want to:
- Organize your huge pile of loose scripts ?
- Create neat and reusable python pipelines to process your data or run jobs ?
- Have a graph (DAG) based parallelization without too much fuss ?
Well, you are at the right place. Pipe Dreams is a super duper light application programmer interface (API) to support the construction and processing of data pipes for scientific data. It was built primarily for the Laboratory Catalog and Archive System, but now open-ended for other systems.
How do we do it:
- We use Python Dictionaries to encapsulate all your intermediate results/data flowing through the pipeline, so you can not only declare and run a sequence of functions but also wire the individual output variables to some specific input parameters. What's more, you can rename, merge and exercise other fine grain control over your intermediate results.
- We provide a Plugin class that can be subclassed to organize your python functions and then call these using their relative string paths in our framework.
- We use Celery, Redis, and NetworkX to parallelize your workflows with minimal setup on the users part.
🚗 Starting Redis
The Pipe Dreams API requires Redis to run. To start Redis (assuming Docker in installed), run:
$ docker container run \
--name labcas-redis \
--publish 6379:6379 \
--detach \
redis:6.2.4-alpine
💿 Installing Pipe Dreams
Pipe Dreams is an open source, installable Python packge. It requires Python 3.7 or later. Typically, you'd install it into Python virtual environment, but you can also put it into a Conda or—if you must—your system's Python.
To use a virtual environment, run:
$ python3 -m venv venv
$ venv/bin/pip install --upgrade setuptools pip wheel
$ venv/bin/pip install jpl.pipedreams
$ source venv/bin/activate # or use activate.csh or activate.fish as needed
Once this is done, you can run venv/bin/python
as your Python interpreter and it will have the Pipe Dreams API (and all its dependencies) ready for use. Note that the activate
step, although deprecated, is still necessary in order to have the celery
program on your execution path.
👉 Note: As of release 1.0.3 of Pipe Dreams, Python 3.7 through Python 3.9 are supported. Python 3.10 is not yet endorsed by this package.
👩💻 Customizing the Workflow
The next step is to create a workflow to define the processing steps to publish the data. As an example, see the demo/demo.py
which is available from the GitHub release of this package.
In summary you need to
- Create an
Operation
instance. - Add pipes (a sequence of named functions) to the instance.
- Run the operation in either single or multi process(es).
📗 Process Your Data Pipes
Finally, with Redis running and a custom workflow defined, you can then execute your pipeline.
As an example, we provide a demonstration workflow and associated test data. You can run it (assuming you've got the virtual Python environment from above) as follows:
$ curl -LO https://github.com/EDRN/jpl.pipedreams/releases/download/v1.0.2/demo.tar.gz | tar xzf -
$ cd demo
$ ../venv/bin/pip install --requirement requirements.txt
$ ../venv/bin/python demo.py
Adding Node: hello_world_read|+|mydata0.txt
…
num nodes in task graph: 7
num task completed: 7
time taken: 0:00:00.NNNNN
That's it 🥳
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
Built Distribution
File details
Details for the file jpl.pipedreams-1.0.5.tar.gz
.
File metadata
- Download URL: jpl.pipedreams-1.0.5.tar.gz
- Upload date:
- Size: 17.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0a9d6a6f567adbc7c8ed6581aa88d447db45f6b6c2d3b69829809fbad36d910 |
|
MD5 | 0d98cede3b92da8f4c9351cde8395bc6 |
|
BLAKE2b-256 | 4e5cf471aadf513a2551da026dcf588454acfae558870d8c6a2f66878b01d0bc |
File details
Details for the file jpl.pipedreams-1.0.5-py3-none-any.whl
.
File metadata
- Download URL: jpl.pipedreams-1.0.5-py3-none-any.whl
- Upload date:
- Size: 16.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66bb4eed96102163a2fbf397d7d0367a004bb121ea1ab482da60b90ba6b4150d |
|
MD5 | ebd9bb1848f964582fecd245ef75a072 |
|
BLAKE2b-256 | bd25e462b2c0078a2da474ec740a927b1b4195e2b92188a64f9a57bb59bbb54b |