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
|
.. -*- coding: utf-8 -*-
==============
Installation
==============
PROPKA 3 requires Python 3.8 or higher. Additional requirements are
specified in the :file:`requirements.txt` file and automatically satisfied
when installing with pip_.
``pip``-based installation
==========================
The easiest way to install a release of PROPKA 3 is from the `PyPI archive`_ with the command
.. code-block:: bash
pip install --upgrade propka
This installation will install the :mod:`propka` Python module and the
:program:`propka3` executable script. As always, a virtual environment (e.g., via
`virtualenv`_) is recommended when installing packages.
Source-based installation
=========================
The source code can be installed by cloning the `repository`_ or
unpacking from a source code archive and running
.. code-block:: bash
pip install .
in the source directory.
For the purposes of testing or development, you may prefer to install
PROPKA as an editable module via pip_ by running
.. code-block:: bash
pip install -e .
in the source directory.
.. _pip: https://pip.pypa.io/
.. _PyPI archive: https://pypi.org/project/PROPKA/
.. _virtualenv: https://pypi.org/project/virtualenv/
.. _repository: https://github.com/jensengroup/propka
|
