The Copernicus Open Access Hub (aka SciHub) <https://scihub.copernicus.eu/>_, that Sentinelsat was primarily built for, is permanently closed.
.. image:: readme-note-scihub-closed.png
The official successor data distribution system, the Copernicus Data Space Ecosystem (CDSE) <https://dataspace.copernicus.eu/>_,
uses different API logic that Sentinelsat does not (yet?) support. Contributions are welcome to change that, please check issues and discussions
for ongoing efforts or alternatives.
Sentinelsat can still be used against other data hubs <https://github.com/kr-stn/awesome-sentinel#data-hubs-and-national-mirrors> powered by the DHuS software <https://github.com/SentinelDataHub/>.
Please note that examples referencing the old Copernicus Open Access Hub are not working anymore.
.. image:: https://readthedocs.org/projects/sentinelsat/badge/?version=stable :target: http://sentinelsat.readthedocs.io/en/stable/?badge=stable :alt: Documentation
.. image:: https://badge.fury.io/py/sentinelsat.svg :target: http://badge.fury.io/py/sentinelsat :alt: PyPI package
.. image:: https://github.com/sentinelsat/sentinelsat/actions/workflows/ci.yaml/badge.svg :target: https://github.com/sentinelsat/sentinelsat/actions :alt: GitHub Actions
.. image:: https://codecov.io/gh/sentinelsat/sentinelsat/branch/main/graph/badge.svg :target: https://codecov.io/gh/sentinelsat/sentinelsat :alt: codecov.io code coverage
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.595961.svg :target: https://doi.org/10.5281/zenodo.595961 :alt: Zenodo DOI
Sentinelsat makes searching, downloading and retrieving the metadata of Sentinel <http://www.esa.int/Our_Activities/Observing_the_Earth/Copernicus/Overview4>
satellite images from the
Copernicus Open Access Hub <https://scihub.copernicus.eu/> easy.
It offers an easy-to-use command line interface
.. code-block:: bash
sentinelsat -u
and a powerful Python API.
.. code-block:: python
from sentinelsat import SentinelAPI, read_geojson, geojson_to_wkt
api = SentinelAPI('user', 'password') footprint = geojson_to_wkt(read_geojson('search_polygon.geojson')) products = api.query(footprint, producttype='SLC', orbitdirection='ASCENDING', limit=10) api.download_all(products)
Documentation is published at http://sentinelsat.readthedocs.io/.
Install sentinelsat through pip:
.. code-block:: bash
pip install sentinelsatSentinelsat provides a Python API and a command line interface to search, download and retrieve the metadata for Sentinel products.
.. code-block:: python
from sentinelsat import SentinelAPI, read_geojson, geojson_to_wkt from datetime import date
api = SentinelAPI('user', 'password', 'dhus-hub-url')
api.download(
footprint = geojson_to_wkt(read_geojson('map.geojson')) products = api.query(footprint, date = ('20151219', date(2015, 12, 29)), platformname = 'Sentinel-2', cloudcoverpercentage = (0, 30))
api.download_all(products)
api.to_geojson(products)
api.to_geodataframe(products)
api.get_product_odata(
api.get_product_odata(
Valid search query keywords can be found at the Copernicus Open Access Hub documentation <https://scihub.copernicus.eu/userguide/3FullTextSearch>_.
A basic search query consists of a search area geometry as well as the username and password to access the Copernicus Open Access Hub.
.. code-block:: bash
sentinelsat -u
Search areas are provided as GeoJSON files, which can be created with
QGIS <http://qgis.org/en/site/> or geojson.io <http://geojson.io>.
If you do not specify a start and end date only products published in the last
24 hours will be queried.
Example ^^^^^^^
Search and download all Sentinel-1 scenes of type SLC, in descending orbit, for the year 2015.
.. code-block:: bash
sentinelsat -u
Username, password and DHuS URL can also be set via environment variables for convenience.
.. code-block:: bash
export DHUS_USER="
sentinelsat -g
Options ^^^^^^^
.. list-table::
To run the tests on sentinelsat:
.. code-block:: bash
git clone https://github.com/sentinelsat/sentinelsat.git
cd sentinelsat
pip install -e .[dev]
pytest -vBy default, prerecorded responses to Copernicus Open Access Hub queries are used to not be affected by its downtime. To allow the tests to run actual queries against the Copernicus Open Access Hub set the environment variables
.. code-block:: bash
export DHUS_USER=<username>
export DHUS_PASSWORD=<password>and add --disable-vcr to pytest arguments.
To update the recordings use --vcr-record with once, new_episodes or all. See vcrpy docs <https://vcrpy.readthedocs.io/en/latest/usage.html#record-modes>_ for details.
To build the documentation:
.. code-block:: bash
git clone https://github.com/sentinelsat/sentinelsat.git
cd sentinelsat
pip install -e .[dev]
cd docs
make htmlThe full documentation is also published at http://sentinelsat.readthedocs.io/.
See CHANGELOG <CHANGELOG.rst>. You can also use GitHub's compare view to see the changes in the main branch since last release <https://github.com/sentinelsat/sentinelsat/compare/v1.2.1...main>.
We invite anyone to participate by contributing code, reporting bugs, fixing bugs, writing documentation and tutorials and discussing the future of this project. Please check CONTRIBUTE.rst <CONTRIBUTE.rst>_.
For a list of maintainers and contributors please see AUTHORS.rst <AUTHORS.rst> and the contributor graph <https://github.com/sentinelsat/sentinelsat/graphs/contributors>.
GPLv3+