README.rst 2.44 KB
Newer Older
Daniel Scheffler's avatar
Daniel Scheffler committed
1
2
3
4
=====
pyrsr
=====

Daniel Scheffler's avatar
Daniel Scheffler committed
5
6
7
8
9
10
A package providing relative spectral response functions for remote sensing instruments.

* Free software: GNU General Public License v3
* Documentation: http://geomultisens.gitext.gfz-potsdam.de/pyrsr/doc/
* Submit feedback by filing an issue `here <https://gitext.gfz-potsdam.de/geomultisens/pyrsr/issues>`__.

Daniel Scheffler's avatar
Daniel Scheffler committed
11

Daniel Scheffler's avatar
Daniel Scheffler committed
12
13
14
Status
------

15
.. image:: https://gitext.gfz-potsdam.de/geomultisens/pyrsr/badges/master/pipeline.svg
Daniel Scheffler's avatar
Daniel Scheffler committed
16
17
18
        :target: https://gitext.gfz-potsdam.de/geomultisens/pyrsr/commits/master
.. image:: https://gitext.gfz-potsdam.de/geomultisens/pyrsr/badges/master/coverage.svg
        :target: http://geomultisens.gitext.gfz-potsdam.de/pyrsr/coverage/
Daniel Scheffler's avatar
Daniel Scheffler committed
19
20
.. image:: https://img.shields.io/pypi/v/pyrsr.svg
        :target: https://pypi.python.org/pypi/pyrsr
Daniel Scheffler's avatar
Daniel Scheffler committed
21
22
23
24
.. image:: https://img.shields.io/pypi/l/pyrsr.svg
        :target: https://gitext.gfz-potsdam.de/geomultisens/pyrsr/blob/master/LICENSE
.. image:: https://img.shields.io/pypi/pyversions/pyrsr.svg
        :target: https://img.shields.io/pypi/pyversions/pyrsr.svg
Daniel Scheffler's avatar
Daniel Scheffler committed
25
26
.. image:: https://img.shields.io/pypi/dm/pyrsr.svg
        :target: https://pypi.python.org/pypi/pyrsr
Daniel Scheffler's avatar
Daniel Scheffler committed
27
.. .. image:: https://img.shields.io/travis/danschef/pyrsr.svg
Daniel Scheffler's avatar
Daniel Scheffler committed
28
        :target: https://travis-ci.org/danschef/pyrsr
Daniel Scheffler's avatar
Daniel Scheffler committed
29
.. .. image:: https://readthedocs.org/projects/pyrsr/badge/?version=latest
Daniel Scheffler's avatar
Daniel Scheffler committed
30
31
        :target: https://pyrsr.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status
Daniel Scheffler's avatar
Daniel Scheffler committed
32
33
34
.. .. image:: https://pyup.io/repos/github/danschef/pyrsr/shield.svg
     :target: https://pyup.io/repos/github/danschef/pyrsr/
     :alt: Updates
Daniel Scheffler's avatar
Daniel Scheffler committed
35

Daniel Scheffler's avatar
Daniel Scheffler committed
36
See also the latest coverage_ report and the nosetests_ HTML report.
Daniel Scheffler's avatar
Daniel Scheffler committed
37
38
39
40
41


Features
--------

42
43
44
45
46
47
48
49
50
51
52
53
List of supported sensors:

* ASTER
* Landsat-4 TM
* Landsat-5 TM
* Landsat-7 ETM+
* Landsat-8 OLI/TIRS
* RapidEye-5
* Sentinel-2A
* Sentinel-2B
* SPOT-1
* SPOT-2
Daniel Scheffler's avatar
Fix.    
Daniel Scheffler committed
54
* SPOT-3
55
56
57
* SPOT-4
* SPOT-5

Daniel Scheffler's avatar
Daniel Scheffler committed
58
59
60
61

Credits
-------

Daniel Scheffler's avatar
Daniel Scheffler committed
62
63
64
The pyrsr package was developed within the context of the GeoMultiSens project funded
by the German Federal Ministry of Education and Research (project grant code: 01 IS 14 010 A-C).

Daniel Scheffler's avatar
Daniel Scheffler committed
65
66
67
68
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
Daniel Scheffler's avatar
Daniel Scheffler committed
69
70
.. _coverage: http://geomultisens.gitext.gfz-potsdam.de/pyrsr/coverage/
.. _nosetests: http://geomultisens.gitext.gfz-potsdam.de/pyrsr/nosetests_reports/nosetests.html