installation.rst 2.36 KB
Newer Older
1
2
3
4
5
6
.. highlight:: shell

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

7
8
9
10
11
12
13
14
15
16
AROSICS depends on some open source packages which are usually installed without problems by the automatic install
routine. However, for some projects, we strongly recommend resolving the dependency before the automatic installer
is run. This approach avoids problems with conflicting versions of the same software.
Using conda_, the recommended approach is:

 .. code-block:: console

    # create virtual environment for arosics, this is optional
    conda create -y -q --name arosics python=3
    source activate arosics
17
    conda install -y -q -c conda-forge numpy gdal scikit-image matplotlib pyproj rasterio shapely
18
    conda install -y -q -c conda-forge pyfftw basemap pykrige  # these libraries are optional
19

20
21
22
23

Stable release
--------------

24
To install AROSICS, use the pip installer:
25

26
27
28
29
30
31
32
33
34
35
36
37
38
39
 .. code-block:: console

    pip install arosics


Or clone the repository via GIT and update the PATH environment variable:

 .. code-block:: console

    cd /your/installation/folder
    git clone https://gitext.gfz-potsdam.de/danschef/arosics.git
    git clone https://gitext.gfz-potsdam.de/danschef/geoarray.git
    git clone https://gitext.gfz-potsdam.de/danschef/py_tools_ds.git
    PATH=$PATH:/path/to/your/installation/folder/arosics:/path/to/your/installation/folder/geoarray:/path/to/your/installation/folder/py_tools_ds
40
41


42
This is the preferred method to install arosics, as it will always install the most recent stable release.
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

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

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


From sources
------------

The sources for arosics can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/danschef/arosics

Or download the `tarball`_:

.. code-block:: console

66
    $ curl  -OL https://gitext.gfz-potsdam.de/danschef/arosics/repository/archive.tar.gz?ref=master
67
68
69
70
71
72
73
74

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install


75
76
.. _Github repo: https://gitext.gfz-potsdam.de/danschef/arosics
.. _tarball: https://gitext.gfz-potsdam.de/danschef/arosics/repository/archive.tar.gz?ref=master
77
.. _conda: https://conda.io/docs/