Installation

Guts can be installed from pypi, or from source. You’ll need docker installed.

Pypi

If you want to use Guts locally on your machine or via some custom install, the module is available in pypi as the pakages project.

$ pip install container-guts

This will provide the latest release. If you want a branch or development version, you can install from GitHub, shown next.

Virtual Environment

Here is how to clone the repository and do a local install.

$ git clone https://github.com/singularityhub/guts
$ cd guts

Create a virtual environment (recommended)

$ python -m venv env
$ source env/bin/activate

And then install (this is development mode, remove the -e to not use it)

$ pip install -e .

Installation of pakages adds an executable, pakages to your path.

$ which guts
/opt/conda/bin/guts

Once it’s installed, you should be able to inspect the client!

$ guts --help

You’ll next want to install or build packages, discussed in Getting Started.