Installation¶

Install with pip¶

The latest released version of galois can be installed from PyPI using pip.

$ python3 - m pip install galois

Note

Fun fact: read here from python core developer Brett Cannon about why it’s better to install using python3 -m pip rather than pip3.

Install for development¶

The latest code from master can be checked out and installed locally in an “editable” fashion. The “editable” install allows local changes to the galois/ folder to be seen system-wide upon running import galois.

$ git clone https://github.com/mhostetter/galois.git
$ python3 -m pip install -e galois

Also, feel free to fork galois on GitHub, clone your fork, make changes, and contribute back with a pull request!

Install for development with min dependencies¶

The package dependencies have minimum supported versions. They are stored in requirements-min.txt.

requirements-min.txt¶

numpy==1.17.3
numba==0.53

pip installing galois will install the latest versions of the dependencies. If you’d like to test against the oldest supported dependencies, you can do the following:

$ git clone https://github.com/mhostetter/galois.git

# First install the minimum version of the dependencies
$ python3 -m pip install -r galois/requirements-min.txt

# Then, installing the galois package won't upgrade the dependencies since their versions are satisfactory
$ python3 -m pip install -e galois