README.rst 2.06 KB
Newer Older
Daniel Scheffler's avatar
Daniel Scheffler committed
1
.. figure:: docs/figs/arosics_logo_v1.png
2

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


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

9

10
11
12
13
Status
------

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

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

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


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

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


Features
--------

* TODO

40
41
42
43

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

44
Use the pip installer:
45

46
    pip install arosics
47
48


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

    cd /your/installation/folder

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

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


62
63
64
65
66
67
68
Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

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