SoftPack Builder

SoftPack Builder provides services for building SoftPack environments.

• Documentation: https://wtsi-hgi.github.io/softpack-builder
• GitHub: https://github.com/wtsi-hgi/softpack-builder
• PyPI: https://pypi.org/project/softpack-builder/
• Free software: MIT

Features

• Delivers cross-platform software packaging environments for reproducible research.
• Includes integrated management and monitoring of build flows using Prefect.
• Supports distributed and parallel builds using Dask for seamless scalability.

Installation

Stable release

To install SoftPack Builder, run this command in your terminal:

$ pip install softpack-builder

This is the preferred method to install SoftPack Builder, as it will always install the most recent stable release.

If you don't have pip installed, this Python installation guide can guide you through the process.

From source

The source for SoftPack Builder can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone https://github.com/wtsi-hgi/softpack-builder.git

Or download the tarball:

$ curl -OJL https://github.com/wtsi-hgi/softpack-builder/tarball/master

Once you have a copy of the source, you can install it with:

$ pip install .

Development

For development mode, clone the repository and use Poetry to install the package.

$ git clone https://github.com/wtsi-hgi/softpack-builder.git

Install Poetry:

$ pip install poetry

Install Poetry environments for development:

poetry install --with dev,doc,test

Run tests with Tox

poetry run tox

Run MkDocs server to view documentation:

poetry run mkdocs serve

Credits

This package was created with Cookiecutter and the altaf-ali/cookiecutter-pypackage project template.

SoftPack mascot and logo courtesy of Cartoon Vectors by Vecteezy.