Installation

Stable release

To install Codex Africanus, run this command in your terminal:

$ pip install codex-africanus

This is the preferred method to install Codex Africanus, 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.

By default, Codex Africanus will install with a minimal set of dependencies, numpy and numba.

Further functionality can be enabled by installing extra requirements as follows:

$ pip install codex-africanus[dask]
$ pip install codex-africanus[scipy]
$ pip install codex-africanus[astropy]
$ pip install codex-africanus[python-casacore]

To install the complete set of dependencies for the CPU:

$ pip install codex-africanus[complete]

To install the complete set of dependencies including CUDA:

$ pip install codex-africanus[complete-cuda]

From sources

The sources for Codex Africanus can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/ska-sa/codex-africanus

Or download the tarball:

$ curl  -OL https://github.com/ska-sa/codex-africanus/tarball/master

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

$ python setup.py install