Skip to content

Rails-on-HPC/subway

Repository files navigation

SUBWAY

SUBWAY: SUBmit jobs in your own WAY

Actions Status Documentation Status Code Coverage Pypi version

Subway is an HPC job management and automation tool. It is designed for HPC users who are tired of sbtach again and again or fail to recall the input and binary versions for given output.

By utilizing subway, the whole HPC project running from days to months can be as simple as one liner subway run.

Install

  • pip install hpcsubway

  • python3 setup.py install

  • or use directly by only export SUBWAY_PATH=/abs/dir/for/bin and export PATH=$SUBWAY_PATH:$PATH as well as export SUBWAY_PYTHON=python of your choice, default is python3.

Howto

Simple Slurm Example

Try:

mkdir demo && cd demo
subway debug setup rgd
subway run

Docs

pip install sphnix
cd docs
make html

The generated html docs are living in subway/docs/_build/html.

Or just check the online doc hosted in readthedocs.

Tests

pip install pytest
pytest
# or if you have slurm installed
pytest --slurm

You can also test full sets in docker if you don't have slurm configured

bash run-test.sh

Releases

No releases published

Packages

No packages published