installation.rst 1.67 KB
Newer Older
1
2
3
4
============
Installation
============

5
6
7
Using Anaconda or Miniconda (recommended)
-----------------------------------------

8
Using conda_ (latest version recommended), AROSICS is installed as follows:
9
10


Daniel Scheffler's avatar
Daniel Scheffler committed
11
12
13
14
1. Create virtual environment for arosics (optional but recommended):

   .. code-block:: bash

15
    $ conda create -c conda-forge --name arosics python=3
16
    $ conda activate arosics
17

18

19
2. Then install AROSICS itself:
20

Daniel Scheffler's avatar
Daniel Scheffler committed
21
   .. code-block:: bash
22

23
    $ conda install -c conda-forge arosics
24

25

26
This is the preferred method to install AROSICS, as it always installs the most recent stable release and
27
28
29
automatically resolves all the dependencies.


30
31
32
33
34
35
Using pip (not recommended)
---------------------------

There is also a `pip`_ installer for AROSICS. However, please note that AROSICS 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:
36

37
38
39
40
41
42
43
44
45
46
47
    * cartopy
    * gdal
    * geopandas
    * matplotlib
    * numpy
    * pandas
    * pyfftw
    * pykrige
    * pyproj >2.2.0
    * scikit-image
    * shapely
48

49
Then, the pip installer can be run by:
Daniel Scheffler's avatar
Daniel Scheffler committed
50
51
52

   .. code-block:: bash

Daniel Scheffler's avatar
Daniel Scheffler committed
53
    $ pip install arosics
54

55
56
57
58
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.


59

Daniel Scheffler's avatar
Daniel Scheffler committed
60
61
62
.. note::

    AROSICS has been tested with Python 3.4+ and Python 2.7. It should be fully compatible to all Python versions
Daniel Scheffler's avatar
Daniel Scheffler committed
63
    from 2.7 onwards. However, we will continously drop the support for Python 2.7 in future.
Daniel Scheffler's avatar
Daniel Scheffler committed
64
65


66
67
.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
Daniel Scheffler's avatar
Daniel Scheffler committed
68
.. _conda: https://conda.io/docs