Merge pull request #5 from johntruckenbrodt/master

restructuring into Python package

Author: jonas-eberle

LICENSE.txt

@@ -0,0 +1,13 @@
+# Copyright (c) 2017, Jonas Eberle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MANIFEST.in

@@ -0,0 +1 @@
+include sentinel_api/examples/*

README.md

@@ -29,38 +29,42 @@ https://scihub.copernicus.eu/twiki/do/view/SciHubUserGuide/3FullTextSearch#Searc
 
 Example:
 
-    import sentinel_api as api
-    
-    # use username and password for ESA DATA Hub authentication
-    username = '****YOUR_ESA_DATA_HUB_USERNAME****'
-    password = '****YOUR_ESA_DATA_HUB_PASSWORD****'
-    
-    # please also specify the Hub URL:
-    # All Sentinel-1 and -2 scenes beginning from 15th Nov. 2015: https://scihub.copernicus.eu/apihub/
-    # All historic Sentinel-1 scenes: https://scihub.copernicus.eu/dhus/
-    s1 = api.SentinelDownloader(username, password, api_url='https://scihub.copernicus.eu/apihub/')
-    
-    # set directory for
-    # - filter scenes list with existing files
-    # - set directory path for data download
-    s1.set_download_dir('./')
-    
-    # load geometries from shapefile
-    s1.load_sites('wetlands_v8.shp')
-    
-    # search for scenes with some restrictions (e.g., minimum overlap 1%)
-    s1.search('S1A*', min_overlap=0.01, start_date="2015-12-01", date_type="beginPosition", productType='GRD', sensoroperationalmode='IW')
-
-    # add another search query (e.g., for Sentinel-1B); both search results will be merged
-    s1.search('S1B*', min_overlap=0.01, start_date="2015-12-01", date_type="beginPosition", productType='GRD', sensoroperationalmode='IW')
-    
-    # you can either write results to a bash file for wget or download files directly in this script
-    # s1.write_results('wget', 'sentinel_api_s1_download.sh')
-    s1.download_all()
+```Python
+import sentinel_api as api
+
+# use username and password for ESA DATA Hub authentication
+username = '****YOUR_ESA_DATA_HUB_USERNAME****'
+password = '****YOUR_ESA_DATA_HUB_PASSWORD****'
+
+# please also specify the Hub URL:
+# All Sentinel-1 and -2 scenes beginning from 15th Nov. 2015: https://scihub.copernicus.eu/apihub/
+# All historic Sentinel-1 scenes: https://scihub.copernicus.eu/dhus/
+s1 = api.SentinelDownloader(username, password, api_url='https://scihub.copernicus.eu/apihub/')
+
+# set directory for
+# - filter scenes list with existing files
+# - set directory path for data download
+s1.set_download_dir('./')
+
+# load geometries from shapefile
+s1.load_sites('wetlands_v8.shp')
+
+# search for scenes with some restrictions (e.g., minimum overlap 1%)
+s1.search('S1A*', min_overlap=0.01, start_date='2015-12-01', date_type='beginPosition', productType='GRD', sensoroperationalmode='IW')
+
+# add another search query (e.g., for Sentinel-1B); both search results will be merged
+s1.search('S1B*', min_overlap=0.01, start_date='2015-12-01', date_type='beginPosition', productType='GRD', sensoroperationalmode='IW')
+
+# you can either write results to a bash file for wget or download files directly in this script
+# s1.write_results('wget', 'sentinel_api_s1_download.sh')
+s1.download_all()
+```
 
 Help
 -----------
 For now, please see the docstrings for each method within the code or within python
- 
-    import sentinel_api as api
-    help(api)
+
+```Python
+import sentinel_api as api
+help(api)
+```

requirements.txt

@@ -0,0 +1 @@
+from .sentinel_api import SentinelDownloader

sentinel_api/__init__.py

@@ -147,6 +147,9 @@ def search(self, platform, min_overlap=0, download_dir=None, start_date=None, en
                 'ingestionDate') (Default: beginPosition)
             **keywords: Further OpenSearch arguments can be passed to the query according to the ESA Data Hub Handbook
                 (please see https://scihub.copernicus.eu/twiki/do/view/SciHubUserGuide/3FullTextSearch#Search_Keywords)
+                missing under this link:
+                - slicenumber: the graticule along an orbit; particularly important for interferometric applications
+                    to identify overlapping scene pairs
 
         Mandatory args:
             platform
@@ -200,15 +203,15 @@ def search(self, platform, min_overlap=0, download_dir=None, start_date=None, en
                 if len(subscenes) < 100:
                     break
 
-            print '%s scenes after initial search' % len(scenes)
+            print('%s scenes after initial search' % len(scenes))
             if len(scenes) > 0:
                 scenes = self._filter_existing(scenes)
                 scenes = self._filter_overlap(scenes, geom, min_overlap)
-                print '%s scenes after filtering before merging' % len(scenes)
+                print('%s scenes after filtering before merging' % len(scenes))
                 self.__scenes = self._merge_scenes(self.__scenes, scenes)
 
         print('===========================================================')
-        print '%s total scenes after merging' % len(self.__scenes)
+        print('%s total scenes after merging' % len(self.__scenes))
         print('===========================================================')
 
     def get_scenes(self):
@@ -221,7 +224,7 @@ def print_scenes(self):
         def sorter(x): return re.findall('[0-9T]{15}', x)[0]
 
         titles = sorted([x['title'] for x in self.__scenes], key=sorter)
-        print '\n'.join(titles)
+        print('\n'.join(titles))
 
     def write_results(self, file_type, filename, output=False):
         """Write results to disk in different kind of formats
@@ -271,16 +274,16 @@ def download_all(self, download_dir=None):
             try:
                 response = requests.get(url, auth=(self.__esa_username, self.__esa_password), stream=True)
             except requests.exceptions.ConnectionError:
-                print 'Connection Error'
+                print('Connection Error')
                 continue
             if 'Content-Length' not in response.headers:
-                print 'Content-Length not found'
-                print url
+                print('Content-Length not found')
+                print(url)
                 continue
             size = int(response.headers['Content-Length'].strip())
             if size < 1000000:
-                print 'The found scene is to small: %s (%s)' % (scene['title'], size)
-                print url
+                print('The found scene is to small: %s (%s)' % (scene['title'], size))
+                print(url)
                 continue
 
             print('Size of the scene: %s MB' % (size / 1024 / 1024))  # show in MegaBytes
@@ -305,7 +308,7 @@ def download_all(self, download_dir=None):
                 sys.exit(0)
 
             # Check if file is valid
-            print "Check if file is valid: "
+            print("Check if file is valid: ")
             valid = self._is_valid(path)
 
             if not valid:
@@ -330,18 +333,20 @@ def _is_valid(self, zipfile, minsize=1000000):
         if not os.path.getsize(zipfile) > minsize:
             print('The downloaded scene is too small: {}'.format(os.path.basename(zipfile)))
             return False
-        archive = zf.ZipFile(zipfile, 'r')
         try:
-            corrupt = archive.testzip()
-        except zlib.error:
-            corrupt = zipfile
-        archive.close()
+            archive = zf.ZipFile(zipfile, 'r')
+            try:
+                corrupt = True if archive.testzip() else False
+            except zlib.error:
+                corrupt = True
+            archive.close()
+        except zf.BadZipfile:
+            corrupt = True
         if corrupt:
             print('The downloaded scene is corrupt: {}'.format(os.path.basename(zipfile)))
-            return False
         else:
             print('file seems to be valid.')
-            return True
+        return not corrupt
 
     def _format_url(self, startindex, wkt_geometry, platform, date_filtering, **keywords):
         """Format the search URL based on the arguments

example_s1.py renamed to sentinel_api/examples/example_s1.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+setup(name='sentinel_api',
+      packages=find_packages(),
+      include_package_data=True,
+      version='0.5.2',
+      description='ESA Sentinel Search & Download API',
+      classifiers=[
+          'Programming Language :: Python :: 2.7',
+      ],
+      install_requires=['GDAL>=1.11.3',
+                        'Shapely>=1.5.13',
+                        'progressbar==2.3',
+                        'requests>=2.8.1'],
+      url='https://github.com/jonas-eberle/esa_sentinel.git',
+      author='Jonas Eberle, John Truckenbrodt, Felix Cremer',
+      author_email='[email protected], [email protected], [email protected]',
+      license='MIT',
+      zip_safe=False)