1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
.. _installation:
Installation
============
.. _virtual_environment:
Virtual Environment
-------------------
PynPoint is available on `PyPI <https://pypi.org/project/pynpoint/>`_ and `Github <https://github.com/PynPoint/PynPoint>`_. We recommend using a Python virtual environment to install and run PynPoint such that the correct dependency versions are installed without affecting other Python installations. First install ``virtualenv``, for example with the `pip package manager <https://packaging.python.org/tutorials/installing-packages/>`_:
.. code-block:: console
$ pip install virtualenv
Then create a virtual environment:
.. code-block:: console
$ virtualenv -p python3 folder_name
And activate the environment with:
.. code-block:: console
$ source folder_name/bin/activate
A virtual environment can be deactivated with:
.. code-block:: console
$ deactivate
.. important::
Make sure to adjust the path where the virtual environment is installed and activated.
.. _installation_pypi:
Installation from PyPI
----------------------
PynPoint can now be installed with pip:
.. code-block:: console
$ pip install pynpoint
If you do not use a virtual environment then you may have to add the ``--user`` argument:
.. code-block:: console
$ pip install --user pynpoint
To update the installation to the most recent version:
.. code-block:: console
$ pip install --upgrade PynPoint
.. _installation_github:
Installation from Github
------------------------
Using pip
^^^^^^^^^
The Github repository contains the latest commits. Installation from Github is also possible with ``pip``:
.. code-block:: console
$ pip install git+https://github.com/PynPoint/PynPoint.git
Cloning the repository
^^^^^^^^^^^^^^^^^^^^^^
Alternatively, the Github repository can be cloned, which is in particular useful if you want to look into the code:
.. code-block:: console
$ git clone https://github.com/PynPoint/PynPoint.git
The package is installed by running ``pip`` in the local repository folder:
.. code-block:: console
$ pip install -e .
Instead of running ``setup.py``, the path of the repository can also be added to the ``PYTHONPATH`` environment variable such that PynPoint can be imported from any working folder. When using a ``virtualenv``, the ``PYTHONPATH`` can be added to the activation script:
Once a local copy of the repository exists, new commits can be pulled from Github with:
.. code-block:: console
$ git pull origin main
Do you want to makes changes to the code? Please fork the PynPoint repository on the Github page and clone your own fork instead of the main repository. We very much welcome contributions and pull requests (see :ref:`contributing` section).
Dependencies
^^^^^^^^^^^^
If needed, the dependencies can be manually installed from the PynPoint folder:
.. code-block:: console
$ pip install -r requirements.txt
Or updated to the latest versions with which PynPoint is compatible:
.. code-block:: console
$ pip install --upgrade -r requirements.txt
.. _testing_pynpoint:
Testing Pynpoint
----------------
The installation can be tested by starting Python in interactive mode and creating an instance of the ``Pypeline``:
.. code-block:: python
>>> import pynpoint
>>> pipeline = pynpoint.Pypeline()
|
