Getting started!¶

Installing the latest release with pip¶

The lastest stable version of padrepads can be downloaded and installed from PyPi:

pip install padrepads

Note that in order to avoid potential conflicts with other packages it is strongly recommended to use a virtual environment, e.g. python3 virtualenv (see python3 virtualenv documentation) or conda environments.

Warning

PadrePads requires Python 3.6 or newer.

Installing padrepads from source¶

This section introduces how to install the master branch of padrepads. This can be done by building from source.

Building from source¶

Building from source is required to work on a contribution (bug fix, new feature, code or documentation improvement).

Use Git to check out the latest source from the pypads repository on Github.:
```
git clone git@github.com:padre-lab-eu/padre-pads.git  # add --depth 1 if your connection is slow
cd padre-pads
```
If you plan on submitting a pull-request, you should clone from your fork instead.
Install poetry tool for dependency managenment for your platform. See instructions in the Official documentation.:
```
pip install poetry
```
Optional (but recommended): create and activate a dedicated virtualenv or conda environment.
Build the project with poetry, this will generate a whl and a tar file under dist/:
```
poetry build (in the root folder of the repository)
```

Install padrepads using one of the two generated files:

pip install dist/padrepads-X.X.X.tar.gz
OR
pip install dist/padrepads-X.X.X-py3-none-any.whl

Dependencies¶

Runtime dependencies¶

Pypads requires the following dependencies both at build time and at runtime:

Python (>= 3.6),
Pypads (>= 1.8.0)

Build dependencies¶

Building padrepads also requires:

Poetry >= 0.12.

Test dependencies¶

Running tests requires:

pytest >= 5.2.5,
scikit-learn >= 0.21.3,
tensorflow >= 2.0.0b1,
psutil >= 5.7.0,
networkx >= 2.4,
keras >= 2.3.1.
PyTorch >= 1.4.0
torchvision >= 0.5.0