enpt

EnMAP Processing Tool - A Python package for pre-processing of EnMAP Level-1B data

https://github.com/gfz/enpt

Repository

EnMAP Processing Tool - A Python package for pre-processing of EnMAP Level-1B data

README.rst

.. image:: https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/EnPT/img/EnPT_logo_final.svg
   :width: 300px
   :alt: EnPT Logo

============================
EnPT - EnMAP Processing Tool
============================

The EnPT Python package is an automated pre-processing pipeline for the new EnMAP hyperspectral satellite data.
It provides free and open-source features to transform EnMAP Level-1B data to Level-2A. The package has been developed
at the German Research Centre for Geosciences Potsdam (GFZ) as an alternative to the processing chain of the EnMAP
Ground Segment.

* Please check the documentation_ for installation and usage instructions and in depth information.
* Information on how to **cite the EnPT Python package** can be found in the
  `CITATION `__ file.


License
-------
Free software: GNU General Public License v3 or later (GPLv3+)

All images contained in any (sub-)directory of this repository are licensed under the CC0 license which can be found
`here `__.

Feature overview
----------------

* read EnMAP Level-1B input data
* radiometric conversion to top-of-atmosphere radiance
* dead pixel correction
* atmospheric correction (based on SICOR_ for land and `ACwater Polymer`_ via Polymer_ for water surfaces)
* optional export of additional results from atmospheric parameter retrieval
* detection and correction of geometric misregistrations compared to user provided spatial reference (based on AROSICS_)
* orthorectification
* write EnMAP Level-2A output data

Status
------

|badge1| |badge2| |badge3| |badge4| |badge5| |badge6| |badge7| |badge8| |badge9|

.. |badge1| image:: https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/EnPT/badges/main/pipeline.svg
    :target: https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/EnPT/pipelines

.. |badge2| image:: https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/EnPT/badges/main/coverage.svg
    :target: https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/EnPT/coverage/

.. |badge3| image:: https://img.shields.io/static/v1?label=Documentation&message=GitLab%20Pages&color=orange
    :target: https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/EnPT/doc/

.. |badge4| image:: https://img.shields.io/pypi/v/enpt.svg
    :target: https://pypi.python.org/pypi/enpt

.. |badge5| image:: https://img.shields.io/conda/vn/conda-forge/enpt.svg
        :target: https://anaconda.org/conda-forge/enpt

.. |badge6| image:: https://img.shields.io/pypi/l/enpt.svg
    :target: https://git.gfz-potsdam.de/EnMAP/GFZ_Tools_EnMAP_BOX/EnPT/-/blob/main/LICENSE

.. |badge7| image:: https://img.shields.io/pypi/pyversions/enpt.svg
    :target: https://img.shields.io/pypi/pyversions/enpt.svg

.. |badge8| image:: https://img.shields.io/pypi/dm/enpt.svg
    :target: https://pypi.python.org/pypi/enpt

.. |badge9| image:: https://zenodo.org/badge/253474970.svg
   :target: https://zenodo.org/badge/latestdoi/253474970

See also the latest coverage_ report and the pytest_ HTML report.

History / Changelog
-------------------

You can find the protocol of recent changes in the EnPT package
`here `__.

Credits
-------

This software was developed within the context of the EnMAP project supported by the DLR Space Administration with
funds of the German Federal Ministry of Economic Affairs and Energy (on the basis of a decision by the German
Bundestag: 50 EE 1529) and contributions from DLR, GFZ and OHB System AG.

Sentinel-2 spatial reference test data have been provided by ESA.

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
.. _documentation: https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/EnPT/doc
.. _coverage: https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/EnPT/coverage/
.. _pytest: https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/EnPT/test_reports/report.html
.. _SICOR: https://git.gfz-potsdam.de/EnMAP/sicor
.. _AROSICS: https://git.gfz-potsdam.de/danschef/arosics
.. _`ACwater Polymer`: https://gitlab.awi.de/phytooptics/acwater
.. _Polymer: https://forum.hygeos.com

Owner

Citation (CITATION)

You are welcome to use and modify the `enpt` project.
See the README.rst and LICENSE files for details.

If you use this software for research we would appreciate appropriate citation.
This may be prepared using the bibliographic metadata contained in our DOI, accessible through the DOI system and at
https://doi.org/10.5281/zenodo.3742344

To cite the `enpt` Python package in your publication, please use (modify the version number if needed):

  Scheffler, Daniel, Bohn, Niklas, Guillaso, Stéphane, & Segl, Karl. (2020, April 7). EnPT - EnMAP Processing Tool (Version v0.11.6b1). Zenodo. https://doi.org/10.5281/zenodo.3742344

This may need modification for the citation style of your publication.
You are encouraged to include the version number of the software.

A BibTeX entry for LaTeX users should look like this
(find the one for the latest version here: https://zenodo.org/record/3742883/export/hx):

@software{scheffler_daniel_2020_3742883,
  author       = {Scheffler, Daniel and
                  Bohn, Niklas and
                  Guillaso, Stéphane and
                  Segl, Karl},
  title        = {EnPT - EnMAP Processing Tool},
  month        = apr,
  year         = 2020,
  publisher    = {Zenodo},
  version      = {v0.11.6b1},
  doi          = {10.5281/zenodo.3742883},
  url          = {https://doi.org/10.5281/zenodo.3742883}
}

For information on citing software products generally, see the
FORCE11 document [*].


[*] FORCE11 Software Citation Working Group (2016), "Software Citation Principles", (Editors: Arfon M. Smith, Daniel S. Katz, Kyle E. Niemeyer).
    Accessed 2017-08-08 at https://www.force11.org/sites/default/files/shared-documents/software-citation-principles.pdf

GitHub Events