installation.rst 1.47 KB
Newer Older
1
.. _installation:
Daniel Scheffler's avatar
Daniel Scheffler committed
2
3
4
5
6
7

============
Installation
============


8
9
Using Anaconda or Miniconda (recommended)
-----------------------------------------
Daniel Scheffler's avatar
Daniel Scheffler committed
10

11
Using conda_ (latest version recommended), pyrsr is installed as follows:
Daniel Scheffler's avatar
Daniel Scheffler committed
12
13


14
1. Create virtual environment for pyrsr (optional but recommended):
Daniel Scheffler's avatar
Daniel Scheffler committed
15

16
   .. code-block:: bash
Daniel Scheffler's avatar
Daniel Scheffler committed
17

18
19
    $ conda create -c conda-forge --name pyrsr python=3
    $ conda activate pyrsr
Daniel Scheffler's avatar
Daniel Scheffler committed
20

21
22
23
24
25
26

2. Then install pyrsr itself:

   .. code-block:: bash

    $ conda install -c conda-forge pyrsr
Daniel Scheffler's avatar
Daniel Scheffler committed
27
28


29
30
This is the preferred method to install pyrsr, as it always installs the most recent stable release and
automatically resolves all the dependencies.
Daniel Scheffler's avatar
Daniel Scheffler committed
31
32


33
34
Using pip (not recommended)
---------------------------
Daniel Scheffler's avatar
Daniel Scheffler committed
35

36
37
38
There is also a `pip`_ installer for pyrsr. However, please note that pyrsr depends on some
open source packages that may cause problems when installed with pip. Therefore, we strongly recommend
to resolve the following dependencies before the pip installer is run:
Daniel Scheffler's avatar
Daniel Scheffler committed
39

40
41
42
    * matplotlib
    * numpy
    * pandas
Daniel Scheffler's avatar
Daniel Scheffler committed
43
44


45
Then, the pip installer can be run by:
Daniel Scheffler's avatar
Daniel Scheffler committed
46

47
   .. code-block:: bash
Daniel Scheffler's avatar
Daniel Scheffler committed
48

49
50
51
52
    $ pip install pyrsr

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
Daniel Scheffler's avatar
Daniel Scheffler committed
53
54
55



56
.. note::
Daniel Scheffler's avatar
Daniel Scheffler committed
57

58
59
60
61
62
63
    pyrsr has been tested with Python 3.6+., i.e., should be fully compatible to all Python versions from 3.6 onwards.


.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
.. _conda: https://conda.io/docs