Installation

Note

Wheels are provided for Windows, Linux and OSX x86-64 platforms, as well as Linux and OSX Aarch64 platforms. Other machines will have to build the wheel from the source distribution. Building gb-io involves compiling Rust code, which requires a Rust compiler to be available.

PyPi

gb-io.py is hosted on GitHub, but the easiest way to install it is to download the latest release from its PyPi repository. It will install all dependencies then install gb-io either from a wheel if one is available, or from source after compiling the Rust code :

$ pip install --user gb-io

Conda

gb-io.py` is also available as a recipe in the bioconda channel. To install, simply use the conda installer:

$ conda install -c bioconda gb-io

Piwheels

gb-io works on Raspberry Pi computers, and pre-built wheels are compiled for armv7l platforms on piwheels. Run the following command to install these instead of compiling from source:

$ pip3 install gb-io --extra-index-url https://www.piwheels.org/simple

Check the piwheels documentation for more information.

GitHub + pip

If, for any reason, you prefer to download the library from GitHub, you can clone the repository and install the repository by running (with the admin rights):

$ git clone --recursive https://github.com/althonos/gb-io.py
$ pip install --user ./gb-io.py

Caution

Keep in mind this will install always try to install the latest commit, which may not even build, so consider using a versioned release instead.

GitHub + build

If you do not want to use pip, you can still clone the repository and run the build module, although you will need to install the build dependencies (mainly maturin):

$ git clone --recursive https://github.com/althonos/gb-io.py
$ cd gb-io.py
$ python -m build -n . -v
# python -m installer dist/*.whl

Danger

Installing packages without pip is strongly discouraged, as they can only be uninstalled manually, and may damage your system.