Metadata-Version: 2.1
Name: sentinel5dl
Version: 1.2
Summary: Sentinel-5p Downloader
Home-page: https://github.com/emissions-api/sentinel5dl
Author: Emissions API Developers
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: GIS
Description-Content-Type: text/x-rst
License-File: LICENSE

Sentinel-5P Downloader
======================

.. image:: https://travis-ci.com/emissions-api/sentinel5dl.svg?branch=master
    :target: https://travis-ci.com/emissions-api/sentinel5dl
    :alt: CI Builds
.. image:: https://coveralls.io/repos/github/emissions-api/sentinel5dl/badge.svg?branch=master
    :target: https://coveralls.io/github/emissions-api/sentinel5dl?branch=master
    :alt: Test Coverage
.. image:: https://img.shields.io/github/issues-raw/emissions-api/sentinel5dl?color=blue
    :target: https://github.com/emissions-api/sentinel5dl/issues
    :alt: GitHub issues
.. image:: https://img.shields.io/github/license/emissions-api/sentinel5dl
    :target: https://github.com/emissions-api/sentinel5dl/blob/master/LICENSE
    :alt: MIT license
.. image:: https://bestpractices.coreinfrastructure.org/projects/3631/badge
    :target: https://bestpractices.coreinfrastructure.org/projects/3631
    :alt: CII Best Practices

The sentinel5dl project consists of a library and a command line tool which provide easy access to
`emission data products <https://sentinel.esa.int/web/sentinel/missions/sentinel-5p/data-products>`_
originating from the European Space Agency's Sentinel-5P satellite.

- `sentinel5dl on PyPI <https://pypi.org/project/sentinel5dl/>`_
- `Documentation <https://sentinel5dl.emissions-api.org>`_
- `Issue tracker <https://github.com/emissions-api/sentinel5dl/issues>`_


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

Install this library using::

    %> pip install sentinel5dl


Quick Example (Library)
-----------------------

.. code-block:: python


    from sentinel5dl import search, download

    # Search for Sentinel-5 products
    result = search(
            polygon='POLYGON((7.8 49.3,13.4 49.3,13.4 52.8,7.8 52.8,7.8 49.3))',
            begin_ts='2019-09-01T00:00:00.000Z',
            end_ts='2019-09-17T23:59:59.999Z',
            product='L2__CO____',
            processing_level='L2',
            processing_mode='Offline')

    # Download found products to the local folder
    download(result.get('products'))


Quick Example (Binary)
-----------------------

Download carbon monoxide sensor data taken between 2019-01-08 and 2019-01-20 to
the directory ``/data`` using eight workers (eight parallel downloads):

.. code-block:: bash

    sentinel5dl --worker 8 \
                --begin-ts 2019-01-08 \
                --end-ts 2019-01-20 \
                /data

To show all available options, run:

.. code-block:: bash

    sentinel5dl -h


