1. Getting Started

1.1. General Installations

Eventually this package will be distributed by PyPI for direct installation via pip. However, during this initial alpha development phase, users must install the package directly from their clone of the POptUS repository.

1.1.1. Installation from clone

After cloning the POptUS repository and activating the desired target Python environment, execute

$ cd /path/to/POptUS/poptus_pypkg
$ python -m pip install .

1.2. Testing

The POptUS package’s integrated test suite can be used to test an installation by executing

$ python
>>> import poptus
>>> poptus.__version__
<version>
>>> poptus.test()
    ...