Installation

PynPoint is compatible with Python 3.6 and 3.7. Earlier versions (up to v0.7.0) are also compatible with Python 2.7. We highly recommend using Python 3 since several key Python projects have already stopped supporting Python 2.

Virtual Environment

PynPoint is available in the PyPI repository and on Github. We recommend using a Python virtual environment to install and run PynPoint such that the correct versions of the dependencies can be installed without affecting other installed Python packages. First install virtualenv, for example with the pip package manager:

$ pip install virtualenv

Then create a virtual environment for Python 3:

$ virtualenv -p python3 folder_name

And activate the environment with:

$ source folder_name/bin/activate

A virtual environment can be deactivated with:

$ deactivate

Important

Make sure to adjust the path where the virtual environment is installed and activated.

Installation from PyPI

PynPoint can now be installed with pip:

$ pip install pynpoint

If you do not use a virtual environment then you may have to add the --user argument:

$ pip install --user pynpoint

PynPoint is actively being developed. To update the installation to the latest version:

$ pip install --upgrade PynPoint

Installation from Github

The repository can also be cloned from Github, which contains the most recent implementations:

$ git clone git@github.com:PynPoint/PynPoint.git

In that case, the dependencies can be installed from the PynPoint folder:

$ pip install -r requirements.txt

By adding the path of the repository to the PYTHONPATH environment variable enables PynPoint to be imported from any location:

$ echo "export PYTHONPATH='$PYTHONPATH:/path/to/pynpoint'" >> folder_name/bin/activate

Important

Make sure to adjust local path in which PynPoint will be cloned from the Github repository.

Do you want to makes changes to the code? Then please fork the PynPoint repository on the Github page and clone your own fork instead of the main repository. We very much welcome active contributions and pull requests (see Contributing section).

Testing Pynpoint

The installation can be tested by starting Python in interactive mode and printing the PynPoint version:

>>> import pynpoint
>>> pynpoint.__version__

Tip

If the PynPoint package is not find by Python then possibly the path was not set correctly. The list of folders that are searched by Python for modules can be printed in interactive mode as:

>>> import sys
>>> sys.path

The result should contain the folder in which the Github repository was cloned or the folder in which Python modules are installed with pip.