File: PKG-INFO

package info (click to toggle)
sentinelsat 0.14-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 5,288 kB
  • sloc: python: 2,466; makefile: 10
file content (270 lines) | stat: -rw-r--r-- 14,764 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
Metadata-Version: 2.1
Name: sentinelsat
Version: 0.14
Summary: Utility to search and download Copernicus Sentinel satellite images
Home-page: https://github.com/sentinelsat/sentinelsat
Author: Kersten Clauss
Author-email: sentinelsat@krstn.eu
License: GPLv3+
Description: sentinelsat
        ===========
        
        .. image:: https://badge.fury.io/py/sentinelsat.svg
            :target: http://badge.fury.io/py/sentinelsat
            :alt: PyPI package
        
        .. image:: https://travis-ci.com/sentinelsat/sentinelsat.svg?branch=master
            :target: https://travis-ci.com/sentinelsat/sentinelsat
            :alt: Travis-CI
        
        .. image:: https://codecov.io/gh/sentinelsat/sentinelsat/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/sentinelsat/sentinelsat
            :alt: codecov.io code coverage
        
        .. image:: https://readthedocs.org/projects/sentinelsat/badge/?version=stable
            :target: http://sentinelsat.readthedocs.io/en/stable/?badge=stable
            :alt: Documentation
        
        .. image:: https://img.shields.io/badge/gitter-join_chat-1dce73.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cmVjdCB4PSIwIiB5PSI1IiBmaWxsPSIjZmZmIiB3aWR0aD0iMSIgaGVpZ2h0PSI1Ii8%2BPHJlY3QgeD0iMiIgeT0iNiIgZmlsbD0iI2ZmZiIgd2lkdGg9IjEiIGhlaWdodD0iNyIvPjxyZWN0IHg9IjQiIHk9IjYiIGZpbGw9IiNmZmYiIHdpZHRoPSIxIiBoZWlnaHQ9IjciLz48cmVjdCB4PSI2IiB5PSI2IiBmaWxsPSIjZmZmIiB3aWR0aD0iMSIgaGVpZ2h0PSI0Ii8%2BPC9zdmc%2B&logoWidth=8
            :target: https://gitter.im/sentinelsat/
            :alt: gitter.im chat
        
        .. 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 <user> -p <password> -g <search_polygon.geojson> --sentinel 2 --cloud 30
        
        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')
          api.download_all(products)
        
        
        
        Documentation is published at http://sentinelsat.readthedocs.io/.
        
        Installation
        ============
        
        Install ``sentinelsat`` through pip:
        
        .. code-block:: bash
        
            pip install sentinelsat
        
        Usage
        =====
        
        Sentinelsat provides a Python API and a command line interface to search,
        download and retrieve the metadata for Sentinel products.
        
        Python Library
        --------------
        
        .. code-block:: python
        
          from sentinelsat.sentinel import SentinelAPI, read_geojson, geojson_to_wkt
          from datetime import date
        
          # connect to the API
          api = SentinelAPI('user', 'password', 'https://scihub.copernicus.eu/dhus')
        
          # download single scene by known product id
          api.download(<product_id>)
        
          # search by polygon, time, and Hub query keywords
          footprint = geojson_to_wkt(read_geojson('map.geojson'))
          products = api.query(footprint,
                               date = ('20151219', date(2015, 12, 29)),
                               platformname = 'Sentinel-2',
                               cloudcoverpercentage = (0, 30))
        
          # download all results from the search
          api.download_all(products)
        
          # GeoJSON FeatureCollection containing footprints and metadata of the scenes
          api.to_geojson(products)
        
          # GeoPandas GeoDataFrame with the metadata of the scenes and the footprints as geometries
          api.to_geodataframe(products)
        
          # Get basic information about the product: its title, file size, MD5 sum, date, footprint and
          # its download url
          api.get_product_odata(<product_id>)
        
          # Get the product's full metadata available on the server
          api.get_product_odata(<product_id>, full=True)
        
        Valid search query keywords can be found at the `Copernicus Open Access Hub documentation
        <https://scihub.copernicus.eu/userguide/3FullTextSearch>`_.
        
        Command Line Interface
        ----------------------
        
        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 <user> -p <password> -g <geojson>
        
        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 <user> -p <password> -g <search_polygon.geojson> -s 20150101 -e 20151231 -d \
          --producttype SLC -q "orbitdirection=Descending" \
          --url "https://scihub.copernicus.eu/dhus"
        
        Username, password and DHuS URL can also be set via environment variables for convenience.
        
        .. code-block:: bash
         
          # same result as query above
          export DHUS_USER="<user>"
          export DHUS_PASSWORD="<password>"
          export DHUS_URL="https://scihub.copernicus.eu/dhus"
        
          sentinelsat -g <search_polygon.geojson> -s 20150101 -e 20151231 -d \
          --producttype SLC -q "orbitdirection=Descending"
        
        Options
        ^^^^^^^
        
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -u | -\-user       | TEXT | Username [required] (or environment variable DHUS_USER)                                    |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -p | -\-password   | TEXT | Password [required] (or environment variable DHUS_PASSWORD)                                |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        |    | -\-url        | TEXT | Define another API URL. Default URL is 'https://scihub.copernicus.eu/apihub/'.             |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -s | -\-start      | TEXT | Start date of the query in the format YYYYMMDD.                                            |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -e | -\-end        | TEXT | End date of the query in the format YYYYMMDD.                                              |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -g | -\-geometry   | PATH | Search area geometry as GeoJSON file.                                                      |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        |    | -\-uuid       | TEXT | Select a specific product UUID instead of a query. Multiple UUIDs can separated by commas. |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        |    | -\-name       | TEXT | Select specific product(s) by filename. Supports wildcards.                                |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        |    | -\-sentinel   | INT  | Limit search to a Sentinel satellite (constellation).                                      |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        |    | -\-instrument | TEXT | Limit search to a specific instrument on a Sentinel satellite.                             |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        |    | -\-producttype| TEXT | Limit search to a Sentinel product type.                                                   |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -c | -\-cloud      | INT  | Maximum cloud cover in percent. (requires --sentinel to be 2 or 3)                         |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -o | -\-order-by   | TEXT | Comma-separated list of keywords to order the result by. Prefix '-' for descending order.  |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -l | -\-limit      | INT  |  Maximum number of results to return. Defaults to no limit.                                |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -d | -\-download   |      | Download all results of the query.                                                         |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        |    | -\-path       | PATH | Set the path where the files will be saved.                                                |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -q | -\-query      | TEXT | Extra search keywords you want to use in the query. Separate keywords with comma.          |
        |    |               |      | Example: 'producttype=GRD,polarisationmode=HH'.                                            |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -f | -\-footprints |      | Create geojson file search_footprints.geojson with footprints of the query result.         |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        |    | -\-version    |      | Show version number and exit.                                                              |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        | -h | -\-help       |      | Show help message and exit.                                                                |
        +----+---------------+------+--------------------------------------------------------------------------------------------+
        
        Tests
        =====
        
        To run the tests on ``sentinelsat``:
        
        .. code-block:: bash
        
            git clone https://github.com/sentinelsat/sentinelsat.git
            cd sentinelsat
            pip install -e .[dev]
            pytest -v
        
        By 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.
        
        
        Documentation
        =============
        
        To build the documentation:
        
        .. code-block:: bash
        
            git clone https://github.com/sentinelsat/sentinelsat.git
            cd sentinelsat
            pip install -e .[dev]
            cd docs
            make html
        
        The full documentation is also published at http://sentinelsat.readthedocs.io/.
        
        
        Changelog
        =========
        
        See `CHANGELOG <CHANGELOG.rst>`_. You can also use GitHub's compare view to see the `changes in the master branch since last release <https://github.com/sentinelsat/sentinelsat/compare/v0.14...master>`_.
        
        Contributors
        ============
        
        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>`_.
        
        License
        =======
        
        GPLv3+
        
Keywords: copernicus,sentinel,esa,satellite,download,GIS
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Utilities
Provides-Extra: dev