There are several options to download and install
Using a conda environment (recommended)
We generally recommend installing PACMAN in a
conda environment. To install conda, follow these instructions.
Once you have Anaconda installed, navigate in a terminal to a directory where you want to store the cloned PACMAN directory and type the following lines:
conda create -n pacman python==3.9 git clone https://github.com/sebastian-zieba/PACMAN cd PACMAN conda activate pacman pip install -e .
With these steps we created a conda environment called
pacman and installed
PACMAN and its dependencies there.
In this example, the conda environment was initialized with python v3.9.0. PACMAN was tested with python v3.7 to v3.10, so it is up to the user which version to use.
pip install -e . will only install the necessary dependencies. If you also want to install the dependencies to run the tests (using pytest) or work on the docs, you have to use the
[docs] arguments respectively after
pip install -e .. See Test Your Installation for an example.
If you want to update your local installation with a new release, navigate to the PACMAN directory again and type:
git pull pip install --upgrade --force-reinstall .
This will reinstall PACMAN and its dependencies.
With pip & GitHub
You can install
pip by entering the following line into a terminal:
pip install -e git+https://github.com/sebastian-zieba/PACMAN
Directly from GitHub
1. You can also download from source on GitHub. There are two ways to do that:
On GitHub, you can either click on Code and Download ZIP followed by unpacking the distribution by opening up a terminal and typing:
Or clone the repository using
git clone https://github.com/sebastian-zieba/PACMAN
PACMANas a package, go into the downloaded PACMAN directory (where setup.cfg is located) and type:
pip install -e .
Using pip (PyPI)
Not implemented yet. Might be added in the future…
Test your installation
To test if your installation was successful, navigate to your cloned PACMAN directory and type:
pip install -e .[test]
[test] argument will also install the necessary dependencies to run pytest.
You can now run pytest by typing the following line while (from inside the PACMAN directory):
pytest tests/tests_all.py -s
-s flag will also output all print statements during the tests so that you can see what happens.
The tests might take a few minutes (depending on your internet connection speed).
You have passed all tests if you get a message like this in the end:
=========== 12 passed, 197 warnings in 157.00s (0:02:37) ===========