======================
|s2logo| S2Downloader
======================
.. |s2logo| image:: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/images/s2downloader_logo.svg
:target: https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader
:width: 50px
* Free software: EUPL 1.2
* **Documentation:** https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/
* Information on how to **cite the S2Downloader Python package** can be found in the
`CITATION <https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/-/blob/main/CITATION>`__ file.
* Submit feedback by filing an issue `here <https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/issues>`__
===============================
Downloader for Sentinel-2 data.
===============================
.. image:: https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/badges/main/pipeline.svg
:target: https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/pipelines
:alt: Pipelines
.. image:: https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/badges/main/coverage.svg
:target: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/coverage/
:alt: Coverage
.. image:: https://img.shields.io/static/v1?label=Documentation&message=GitLab%20Pages&color=orange
:target: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/
:alt: Documentation
.. image:: https://zenodo.org/badge/832612594.svg
:target: https://zenodo.org/doi/10.5281/zenodo.13123060
:alt: DOI
Feature overview
----------------
The **S2Downloader** allows to download Sentinel-2 L2A data from the cost-free `element84 AWS <https://registry.opendata.aws/sentinel-2-l2a-cogs/>`_ Amazon Cloud server. It specifically serves the purpose to download data for user-defined area of interests (AOI), defined by a bounding box or whole tiles which are the original data product provided by ESA.
Features
########
**Features on Sentinel-2 tile level**
* download atmospheric corrected L2A Sentinel-2 thumbnail, overview, and data from AWS
* provide single date or time range for finding data at the server
* select which individual bands to download, all bands are supported: ``"coastal"``, ``"blue"``, ``"green"``, ``"red"``, ``"rededge1"``, ``"rededge2"``, ``"rededge3"``, ``"nir"``, ``"nir08"``, ``"nir09"``, ``"cirrus"``, ``"swir16"``, ``"swir22"``
* provide UTM zone, latitude band and grid square to download whole tiles
**Features on AOI level**
* input data: configuration json file
* customizable filtering for noData
* optional: customizable mask SCL classes (default masked classes: clouds shadow, clouds, cirrus -> 3, 7, 8, 9, 10), all available classes:
* 0 - No data
* 1 - Saturated / Defective
* 2 - Dark Area Pixels
* 3 - Cloud Shadows
* 4 - Vegetation
* 5 - Bare Soils
* 6 - Water
* 7 - Clouds low probability / Unclassified
* 8 - Clouds medium probability
* 9 - Clouds high probability
* 10 - Cirrus
* 11 - Snow / Ice
* mosaic data from different tiles (same utm zone) into one tif file
* resample bands to user-defined target resolution
* select resampling method
**Features for saving the results**
* define output location
* save thumbnails for the available scenes
* save overviews for the available scenes
Installation
------------
`Install <https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/installation.html>`_ S2Downloader
Usage
-----
Run with relative or absolute path to config json file:
::
S2Downloader --filepath "path/to/config.json"
Relative paths in the config file are supposed to be relative to the location of the repository.
See `usage <https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/usage.html>`_ for more details about the config file.
Expected Output
---------------
The downloaded raster files and overviews are saved in .tif format, the thumbnails are saved as .jpg. Additional information is saved in a.json and a logging file.
See `usage <https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/usage.html>`_ for more details about the output files.
History / Changelog
-------------------
You can find the protocol of recent changes in the S2Downloader package
`here <https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/-/blob/main/HISTORY.rst>`__.
Contribution
------------
Contributions are always welcome. Please contact us, if you wish to contribute to the S2Downloader.
Developed by
------------
.. image:: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/images/fernlab_logo.svg
:target: https://fernlab.gfz-potsdam.de/
:width: 10 %
S2Downloader has been developed by `FERN.Lab <https://fernlab.gfz-potsdam.de/>`_, the Helmholtz Innovation Lab "Remote sensing for sustainable use of resources", located at the `Helmholtz Centre Potsdam, GFZ German Research Centre for Geosciences <https://www.gfz-potsdam.de/en/>`_. FERN.Lab is funded by the `Initiative and Networking Fund of the Helmholtz Association <https://www.helmholtz.de/en/about-us/structure-and-governance/initiating-and-networking/>`_.
Credits
------------
This package was created with Cookiecutter_ and the `fernlab/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`fernlab/cookiecutter-pypackage`: https://github.com/fernlab/cookiecutter-pypackage
.. _coverage: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/sentinel2_portal/coverage/
.. _pytest: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/sentinel2_portal/test_reports/report.html
.. _default_config.json: https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/-/blob/main/data/default_config.json
Raw data
{
"_id": null,
"home_page": "https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader",
"name": "s2downloader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "s2downloader, remote sensing, sentinel-2, copernicus, multispectral, satellite imagery, geospatial, mosaic",
"author": "FernLab",
"author_email": "fernlab@gfz-potsdam.de",
"download_url": "https://files.pythonhosted.org/packages/24/25/098ee33d76fd88a8df103fd68560e2d933b004a1237561863a634041dc53/s2downloader-1.3.0.tar.gz",
"platform": null,
"description": "======================\n|s2logo| S2Downloader\n======================\n\n.. |s2logo| image:: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/images/s2downloader_logo.svg\n :target: https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader\n :width: 50px\n\n* Free software: EUPL 1.2\n* **Documentation:** https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/\n* Information on how to **cite the S2Downloader Python package** can be found in the\n `CITATION <https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/-/blob/main/CITATION>`__ file.\n* Submit feedback by filing an issue `here <https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/issues>`__\n\n===============================\nDownloader for Sentinel-2 data.\n===============================\n\n.. image:: https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/badges/main/pipeline.svg\n :target: https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/pipelines\n :alt: Pipelines\n.. image:: https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/badges/main/coverage.svg\n :target: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/coverage/\n :alt: Coverage\n.. image:: https://img.shields.io/static/v1?label=Documentation&message=GitLab%20Pages&color=orange\n :target: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/\n :alt: Documentation\n.. image:: https://zenodo.org/badge/832612594.svg\n :target: https://zenodo.org/doi/10.5281/zenodo.13123060\n :alt: DOI\n\n\nFeature overview\n----------------\n\nThe **S2Downloader** allows to download Sentinel-2 L2A data from the cost-free `element84 AWS <https://registry.opendata.aws/sentinel-2-l2a-cogs/>`_ Amazon Cloud server. It specifically serves the purpose to download data for user-defined area of interests (AOI), defined by a bounding box or whole tiles which are the original data product provided by ESA.\n\nFeatures\n########\n\n**Features on Sentinel-2 tile level**\n\n* download atmospheric corrected L2A Sentinel-2 thumbnail, overview, and data from AWS\n* provide single date or time range for finding data at the server\n* select which individual bands to download, all bands are supported: ``\"coastal\"``, ``\"blue\"``, ``\"green\"``, ``\"red\"``, ``\"rededge1\"``, ``\"rededge2\"``, ``\"rededge3\"``, ``\"nir\"``, ``\"nir08\"``, ``\"nir09\"``, ``\"cirrus\"``, ``\"swir16\"``, ``\"swir22\"``\n* provide UTM zone, latitude band and grid square to download whole tiles\n\n\n**Features on AOI level**\n\n* input data: configuration json file\n* customizable filtering for noData\n* optional: customizable mask SCL classes (default masked classes: clouds shadow, clouds, cirrus -> 3, 7, 8, 9, 10), all available classes:\n\n * 0 - No data\n * 1 - Saturated / Defective\n * 2 - Dark Area Pixels\n * 3 - Cloud Shadows\n * 4 - Vegetation\n * 5 - Bare Soils\n * 6 - Water\n * 7 - Clouds low probability / Unclassified\n * 8 - Clouds medium probability\n * 9 - Clouds high probability\n * 10 - Cirrus\n * 11 - Snow / Ice\n\n\n* mosaic data from different tiles (same utm zone) into one tif file\n* resample bands to user-defined target resolution\n* select resampling method\n\n**Features for saving the results**\n\n* define output location\n* save thumbnails for the available scenes\n* save overviews for the available scenes\n\n\nInstallation\n------------\n\n`Install <https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/installation.html>`_ S2Downloader\n\n\nUsage\n-----\n\nRun with relative or absolute path to config json file:\n::\n\n S2Downloader --filepath \"path/to/config.json\"\n\nRelative paths in the config file are supposed to be relative to the location of the repository.\n\nSee `usage <https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/usage.html>`_ for more details about the config file.\n\nExpected Output\n---------------\n\nThe downloaded raster files and overviews are saved in .tif format, the thumbnails are saved as .jpg. Additional information is saved in a.json and a logging file.\n\nSee `usage <https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/usage.html>`_ for more details about the output files.\n\nHistory / Changelog\n-------------------\n\nYou can find the protocol of recent changes in the S2Downloader package\n`here <https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/-/blob/main/HISTORY.rst>`__.\n\n\nContribution\n------------\n\nContributions are always welcome. Please contact us, if you wish to contribute to the S2Downloader.\n\n\nDeveloped by\n------------\n\n.. image:: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/images/fernlab_logo.svg\n :target: https://fernlab.gfz-potsdam.de/\n :width: 10 %\n\nS2Downloader has been developed by `FERN.Lab <https://fernlab.gfz-potsdam.de/>`_, the Helmholtz Innovation Lab \"Remote sensing for sustainable use of resources\", located at the `Helmholtz Centre Potsdam, GFZ German Research Centre for Geosciences <https://www.gfz-potsdam.de/en/>`_. FERN.Lab is funded by the `Initiative and Networking Fund of the Helmholtz Association <https://www.helmholtz.de/en/about-us/structure-and-governance/initiating-and-networking/>`_.\n\n\nCredits\n------------\n\nThis package was created with Cookiecutter_ and the `fernlab/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`fernlab/cookiecutter-pypackage`: https://github.com/fernlab/cookiecutter-pypackage\n.. _coverage: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/sentinel2_portal/coverage/\n.. _pytest: https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/sentinel2_portal/test_reports/report.html\n.. _default_config.json: https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/-/blob/main/data/default_config.json\n\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Downloader for Sentinel-2 from aws.",
"version": "1.3.0",
"project_urls": {
"Change log": "https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/-/blob/main/HISTORY.rst",
"Documentation": "https://fernlab.git-pages.gfz-potsdam.de/products/data-portal/s2downloader/doc/",
"Homepage": "https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader",
"Issue Tracker": "https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader/-/issues",
"Source code": "https://git.gfz-potsdam.de/fernlab/products/data-portal/s2downloader",
"Zenodo": "https://zenodo.org/record/13123061"
},
"split_keywords": [
"s2downloader",
" remote sensing",
" sentinel-2",
" copernicus",
" multispectral",
" satellite imagery",
" geospatial",
" mosaic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2425098ee33d76fd88a8df103fd68560e2d933b004a1237561863a634041dc53",
"md5": "969ebde21ab93cd7ce37ac86b212571e",
"sha256": "df646606f3d32a8cafa26510b9d55e5db2ccbaa084342d0e2f8177ab70e1e1a8"
},
"downloads": -1,
"filename": "s2downloader-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "969ebde21ab93cd7ce37ac86b212571e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10073511,
"upload_time": "2024-08-02T13:52:17",
"upload_time_iso_8601": "2024-08-02T13:52:17.521173Z",
"url": "https://files.pythonhosted.org/packages/24/25/098ee33d76fd88a8df103fd68560e2d933b004a1237561863a634041dc53/s2downloader-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 13:52:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "s2downloader"
}
JSON