Installing PGFinder

Online Notebooks

There is no need to install pgfinder - you can run it online.

Virtual Environment

Install miniconda (it also works with anaconda, but we do not need the extra packages). With Conda installed, run the following commands to create the virtual environment and activate it:

conda create --force -n pgfinder python=3.10
conda activate pgfinder

You’re fine to use a different virtual environment, if you want!

PyPI

PGFinder is available via the Python Package Index (PyPI) and the latest release can be installed under your virtual environment with pip.

pip install pgfinder

Versions are released automatically when commits on GitHub are tagged.

Development

To install the most recent pre-release version, use:

pip install "git+https://github.com/Mesnage-Org/pgfinder.git#egg=pgfinder&subdirectory=lib"

Developers should follow the developer installation instructions.