A small library for executing shell commands in a reproducible way.
Project description
SciCommander
This is a small tool that executes single shell commands in a scientifically more reproducible and robust way, by doing the following things:
- Atomic writes: Writes files to a temporary location until command is finished
- Auditing: Creating an audit log of most output files
- Caching: Skipping executions where output files already exist
It allows executing shell commands with very minor modifications:
- Prepend your command with the
scicmd
command. - Wrap definitions of input fields in
{i:INPATH}
and output files in{o:OUTPATH}
for output paths.
The benefits are multiple:
- Detailed audit logs for every command (Compatible with SciPipe audit logs).
- Unfinished output files are never written to final paths
- Avoid re-running already completed commands
- Can be combined with any existing scripting solution, such as:
- Shell scripts
- Python scripts
- Nextflow pipelines [1]
- Snakemake pipelines [1]
Notes
[1] Although Nextflow and Snakemake already take care of some of the benefits, such as atomic writes, SciExec adds additional features such as detailed per-output audit logs.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
scicommander-0.1.2.tar.gz
(4.7 kB
view hashes)
Built Distribution
Close
Hashes for scicommander-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2224de700185a4ed02907010dcc029510e6363a5e1e2624ed3f2fe41320d095e |
|
MD5 | 0598c5cc0714e2041a94cb54f418bb10 |
|
BLAKE2b-256 | c7a0f3fad2c8a6658b8dd1820be74e893feaf30ca4d3c80d583db750412f753c |