README.rst 2.22 KB
Newer Older
1
.. figure:: http://danschef.gitext.gfz-potsdam.de/arosics/images/arosics_logo.png
Daniel Scheffler's avatar
Daniel Scheffler committed
2
        :target: https://gitext.gfz-potsdam.de/danschef/arosics
3

4
5
6
An Automated and Robust Open-Source Image Co-Registration Software for Multi-Sensor Satellite Data


Daniel Scheffler's avatar
Daniel Scheffler committed
7
* Free software: GNU General Public License v3
8
9
* Documentation: http://danschef.gitext.gfz-potsdam.de/arosics/doc/

10

11
12
13
14
Status
------

.. .. image:: https://img.shields.io/travis/danschef/arosics.svg
15
16
        :target: https://travis-ci.org/danschef/arosics

17
.. .. image:: https://readthedocs.org/projects/arosics/badge/?version=latest
18
19
20
        :target: https://arosics.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

21
.. .. image:: https://pyup.io/repos/github/danschef/arosics/shield.svg
22
23
24
25
     :target: https://pyup.io/repos/github/danschef/arosics/
     :alt: Updates


26
.. image:: https://gitext.gfz-potsdam.de/danschef/arosics/badges/master/build.svg
Daniel Scheffler's avatar
Daniel Scheffler committed
27
        :target: https://gitext.gfz-potsdam.de/danschef/arosics/commits/master
28
.. image:: https://gitext.gfz-potsdam.de/danschef/arosics/badges/master/coverage.svg
Daniel Scheffler's avatar
Daniel Scheffler committed
29
        :target: http://danschef.gitext.gfz-potsdam.de/arosics/coverage/
Daniel Scheffler's avatar
Daniel Scheffler committed
30
31
.. image:: https://img.shields.io/pypi/v/arosics.svg
        :target: https://pypi.python.org/pypi/arosics
32

33
See also the latest coverage_ report.
34
35
36
37
38
39
40


Features
--------

* TODO

41
42
43
44

Installation
------------

45
Use the pip installer:
46

47
    pip install arosics
48
49


Daniel Scheffler's avatar
Daniel Scheffler committed
50
Or clone the repository via GIT and update the PATH environment variable:
51
52
53
54
55

    cd /your/installation/folder

    git clone https://gitext.gfz-potsdam.de/danschef/arosics.git

Daniel Scheffler's avatar
Daniel Scheffler committed
56
57
58
59
60
    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
61
62


63
64
65
66
Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
67
The test data represent modified Copernicus Sentinel data (2016).
68
69
70

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
71
.. _coverage: http://danschef.gitext.gfz-potsdam.de/arosics/coverage/
72