Installation

The fastest way of installing this package is through PyPI:

python3 -m pip install git+https://github.com/RUB-EP1/pawian-tools@main

This installs the latest version that you can find on the main branch.

However, we highly recommend using the more dynamic, ‘editable installation’ instead. This goes as follows:

1. Get the source code (see the Pro Git Book):

   git clone https://github.com/RUB-EP1/pawian-tools
   cd pawian-tools
   

2. [Recommended] Create a virtual environment (see here or the tip below).

3. Install the project in ‘editable installation’ with additional dependencies for the developer:

   python3 -m pip install -e .[dev]
   

That’s all! Have a look at the Usage page to try out the package, and see Help developing for tips on how to work with this ‘editable’ developer setup!

Tip

It’s easiest to install the project in a Conda environment. In that case, to install in editable mode, just run:

conda env create
conda activate pawian-tools

This way of installing is also safer, because it pins all dependencies. Note you can also pin dependencies with pip, by running:

python3 -m pip install -e .[dev] -c .constraints/py3.x.txt

where you should replace the 3.x with the version of Python you want to use.