Update to version 2.0.0

Author: Nino Rasic

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Meteomatics AG
+
+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.

README.md

@@ -1,4 +1,14 @@
-[![logo](http://www.meteomatics.com/s/de_DE/5639/a252d7f5e75d7a8bf7047b4b2c92f71a56a8f048.29/2.6.1/_/download/resources/com.meteomatics.confluence.website-plugin:meteomatics-website-theme/images/meteomatics-logo.png)](http://www.meteomatics.com "Meteomatics - Your Experts in Weather Data Processing")
+[![PyPI](https://img.shields.io/pypi/v/meteomatics.svg)](https://pypi.python.org/pypi/meteomatics)
 
-Python connector to the [Meteomatics API](http://api.meteomatics.com/Overview.html "Documentation Overwiev")
-===================================================================================
+[![logo](https://www.meteomatics.com/wp-content/uploads/2019/01/meteomatics-logo_trans_sm-1.png)](http://www.meteomatics.com "Meteomatics - Your Experts in Weather Data Processing")
+
+Python connector to the [Meteomatics Weather API](https://www.meteomatics.com/en/api/overview/ "Documentation Overview")
+===================================================================================
+
+
+Meteomatics provides a REST-style API to retrieve historic, current, and forecast data globally. This includes model data and observational data in time series and areal formats. Areal formats are also offered through a WMS/WFS-compatible interface. Geographic and time series data can be combined in certain file formats, such as NetCDF.
+
+
+Install by typing `pip install meteomatics` in your favourite shell.
+
+For a start we recommend to run the example script.

__init__.py

@@ -3,10 +3,11 @@
 # coding:=utf-8
 
 import argparse
-import python_query_api as api
 import datetime as dt
 import sys
 
+import meteomatics.api as api
+
 '''
     For further information on available parameters, models etc. please visit
     api.meteomatics.com
@@ -20,6 +21,7 @@
 username = 'python-community'
 password = 'Umivipawe179'
 
+
 def example():
     ###Input timeseries:
     now = dt.datetime.utcnow().replace(hour=0, minute=0, second=0, microsecond=0)
@@ -30,6 +32,7 @@ def example():
     parameters_ts = ['t_2m:C', 'rr_1h:mm']
     model = 'mix'
     ens_select = None  # e.g. 'median'
+    cluster_select = None  # e.g. "cluster:1", see http://api.meteomatics.com/API-Request.html#cluster-selection
     interp_select = 'gradient_interpolation'
 
     ###Input grid / grid unpivoted:
@@ -43,7 +46,7 @@ def example():
     parameter_grid = 'evapotranspiration_1h:mm'  # 't_2m:C'
 
     parameters_grid_unpiv = ['t_2m:C', 'rr_1h:mm']
-    valid_dates_unpiv = [dt.datetime.utcnow(), dt.datetime.utcnow()+dt.timedelta(days=1)]
+    valid_dates_unpiv = [dt.datetime.utcnow(), dt.datetime.utcnow() + dt.timedelta(days=1)]
 
     ###input grid png
     filename_png = "grid_target.png"
@@ -65,47 +68,49 @@ def example():
     model_grads = 'ecmwf-ifs'
     area_grads = 'europe'
 
-
     ###input netcdf
     filename_nc = "path_netcdf/netcdf_target.nc"
     startdate_nc = now
-    enddate_nc = startdate_nc+dt.timedelta(days=1)
+    enddate_nc = startdate_nc + dt.timedelta(days=1)
     interval_nc = dt.timedelta(days=1)
     parameter_nc = 't_2m:C'
 
     ###input png timeseries
     # prefixpath_png_ts = 'path/to/directory' #TODO
     prefixpath_png_ts = ''  # TODO
     startdate_png_ts = now
-    enddate_png_ts = startdate_png_ts+dt.timedelta(days=2)
+    enddate_png_ts = startdate_png_ts + dt.timedelta(days=2)
     interval_png_ts = dt.timedelta(hours=12)
     parameter_png_ts = 't_2m:C'
 
     ###input grads timeseries
     # prefixpath_grads_ts = 'path/to/directory' #TODO
-    prefixpath_grads_ts = '' #TODO
+    prefixpath_grads_ts = ''  # TODO
     startdate_grads_ts = now
-    enddate_grads_ts= startdate_grads_ts + dt.timedelta(days=2)
-    interval_grads_ts= dt.timedelta(hours=24)
-    parameters_grads_ts = ['t_500hPa:C','gh_500hPa:m']
+    enddate_grads_ts = startdate_grads_ts + dt.timedelta(days=2)
+    interval_grads_ts = dt.timedelta(hours=24)
+    parameters_grads_ts = ['t_500hPa:C', 'gh_500hPa:m']
     model_grads_ts = 'ecmwf-ifs'
-    area_grads_ts = 'australia' #For Lat/Lon setting: None
+    area_grads_ts = 'australia'  # For Lat/Lon setting: None
 
     ###input station data timeseries
     startdate_station_ts = startdate_grads_ts - dt.timedelta(days=2)
-    enddate_station_ts= startdate_grads_ts - dt.timedelta(hours=3)
-    interval_station_ts= dt.timedelta(hours=1)
-    parameters_station_ts = ['t_2m:C','wind_speed_10m:ms','precip_1h:mm']
+    enddate_station_ts = startdate_grads_ts - dt.timedelta(hours=3)
+    interval_station_ts = dt.timedelta(hours=1)
+    parameters_station_ts = ['t_2m:C', 'wind_speed_10m:ms', 'precip_1h:mm']
     model_station_ts = 'mix-obs'
-    coordinates_station_ts = [(47.43,9.4), (50.03,8.52)] #St. Gallen / Frankfurt/Main
-    wmo_stations = ['066810'] #St. Gallen
-    metar_stations = ['EDDF'] #Frankfurt/Main
+    coordinates_station_ts = [(47.43, 9.4), (50.03, 8.52)]  # St. Gallen / Frankfurt/Main
+    wmo_stations = ['066810']  # St. Gallen
+    metar_stations = ['EDDF']  # Frankfurt/Main
+    mch_stations = ['STG']  # MeteoSchweiz Station St. Gallen
 
     limits = api.query_user_features(username, password)
 
     print("\ntime series:")
     try:
-        df_ts = api.query_time_series(coordinates_ts, startdate_ts, enddate_ts, interval_ts, parameters_ts, username, password, model, ens_select, interp_select)
+        df_ts = api.query_time_series(coordinates_ts, startdate_ts, enddate_ts, interval_ts, parameters_ts,
+                                      username, password, model, ens_select, interp_select,
+                                      cluster_select=cluster_select)
         print (df_ts.head())
     except Exception as e:
         print("Failed, the exception is {}".format(e))
@@ -120,28 +125,32 @@ def example():
     if limits['area request option']:
         print("\ngrid:")
         try:
-            df_grid = api.query_grid(startdate_grid, parameter_grid, lat_N, lon_W, lat_S, lon_E, res_lat, res_lon, username, password)
+            df_grid = api.query_grid(startdate_grid, parameter_grid, lat_N, lon_W, lat_S, lon_E, res_lat, res_lon,
+                                     username, password)
             print (df_grid.head())
         except Exception as e:
             print("Failed, the exception is {}".format(e))
 
         print("\nunpivoted grid:")
         try:
-            df_grid_unpivoted = api.query_grid_unpivoted(valid_dates_unpiv, parameters_grid_unpiv, lat_N, lon_W, lat_S, lon_E, res_lat, res_lon, username, password)
+            df_grid_unpivoted = api.query_grid_unpivoted(valid_dates_unpiv, parameters_grid_unpiv, lat_N, lon_W, lat_S,
+                                                         lon_E, res_lat, res_lon, username, password)
             print (df_grid_unpivoted.head())
         except Exception as e:
             print("Failed, the exception is {}".format(e))
 
         print("\ngrid timeseries:")
         try:
-            df_grid_timeseries = api.query_grid_timeseries(startdate_ts, enddate_ts, interval_ts, parameters_ts, lat_N, lon_W, lat_S, lon_E, res_lat, res_lon, username, password)
+            df_grid_timeseries = api.query_grid_timeseries(startdate_ts, enddate_ts, interval_ts, parameters_ts, lat_N,
+                                                           lon_W, lat_S, lon_E, res_lat, res_lon, username, password)
             print (df_grid_timeseries.head())
         except Exception as e:
             print("Failed, the exception is {}".format(e))
 
         print("\ngrid as a png:")
         try:
-            api.query_grid_png(filename_png, startdate_png, parameter_png, lat_N, lon_W, lat_S, lon_E, res_lat, res_lon, username, password)
+            api.query_grid_png(filename_png, startdate_png, parameter_png, lat_N, lon_W, lat_S, lon_E, res_lat, res_lon,
+                               username, password)
             print("filename = {}".format(filename_png))
         except Exception as e:
             print("Failed, the exception is {}".format(e))
@@ -172,15 +181,17 @@ def example():
     if limits['model select option']:
         print("\nnetCDF file:")
         try:
-            api.query_netcdf(filename_nc, startdate_nc, enddate_nc, interval_nc, parameter_nc, lat_N, lon_W, lat_S, lon_E,
+            api.query_netcdf(filename_nc, startdate_nc, enddate_nc, interval_nc, parameter_nc, lat_N, lon_W, lat_S,
+                             lon_E,
                              res_lat, res_lon, username, password)
             print("filename = {}".format(filename_nc))
         except Exception as e:
             print("Failed, the exception is {}".format(e))
 
         print("\nGrads plot:")
         try:
-            api.query_grads(filename_grads, startdate_grads, parameters_grads, lat_N, lon_W, lat_S, lon_E, res_lat, res_lon,
+            api.query_grads(filename_grads, startdate_grads, parameters_grads, lat_N, lon_W, lat_S, lon_E, res_lat,
+                            res_lon,
                             username, password, model_grads, area=area_grads)
             print("filename = {}".format(filename_grads))
         except Exception as e:
@@ -197,15 +208,17 @@ def example():
 
         print("\nfind stations:")
         try:
-            met = api.query_station_list(username, password, startdate=startdate_station_ts, enddate=enddate_station_ts, parameters=parameters_station_ts)
+            met = api.query_station_list(username, password, startdate=startdate_station_ts, enddate=enddate_station_ts,
+                                         parameters=parameters_station_ts)
             print(met.head())
         except Exception as e:
             print("Failed, the exception is {}".format(e))
 
         print("\nstation coordinates timeseries:")
         try:
             df_sd_coord = api.query_station_timeseries(startdate_station_ts, enddate_station_ts, interval_station_ts,
-                                                       parameters_station_ts, username, password, model=model_station_ts,
+                                                       parameters_station_ts, username, password,
+                                                       model=model_station_ts,
                                                        latlon_tuple_list=coordinates_station_ts,
                                                        on_invalid='fill_with_invalid', request_type="POST",
                                                        temporal_interpolation='none')
@@ -218,29 +231,39 @@ def example():
             df_sd_ids = api.query_station_timeseries(startdate_station_ts, enddate_station_ts, interval_station_ts,
                                                      parameters_station_ts, username, password, model=model_station_ts,
                                                      wmo_ids=wmo_stations, metar_ids=metar_stations,
-                                                     on_invalid='fill_with_invalid', request_type="POST",
-                                                     temporal_interpolation='none')
+                                                     mch_ids=mch_stations, on_invalid='fill_with_invalid',
+                                                     request_type="POST", temporal_interpolation='none')
             print(df_sd_ids.head())
         except Exception as e:
             print("Failed, the exception is {}".format(e))
 
         print("\nget init dates:")
         try:
-            df_init_dates = api.query_init_date(now, now + dt.timedelta(days=2), dt.timedelta(hours=3), 't_2m:C', username,
+            df_init_dates = api.query_init_date(now, now + dt.timedelta(days=2), dt.timedelta(hours=3), 't_2m:C',
+                                                username,
                                                 password, 'ecmwf-ens')
             print(df_init_dates.head())
         except Exception as e:
             print("Failed, the exception is {}".format(e))
+
+        print("\nget available time ranges:")
+        try:
+            df_time_ranges = api.query_available_time_ranges(['t_2m:C', 'precip_6h:mm'], username, password,
+                                                             'ukmo-euro4')
+            print(df_time_ranges.head())
+        except Exception as e:
+            print("Failed, the exception is {}".format(e))
+
     else:
         print("""
 Your account '{}' does not include model selection.
 With the corresponding upgrade you could query data from stations and request your data in netcdf or grads format.
-Please check http://shop.meteomatics.com or contact us at shop@meteomatics.com for an individual offer.
+Please check http://shop.meteomatics.com or contact us at shop@meteomatics.com for an individual offer. 
 """.format(username)
               )
 
 
-if __name__=="__main__":
+if __name__ == "__main__":
     parser = argparse.ArgumentParser()
     parser.add_argument('--username', default=username)
     parser.add_argument('--password', default=password)
@@ -250,7 +273,8 @@ def example():
     password = arguments.password
 
     if username is None or password is None:
-        print("You need to provide a username and a password, either on the command line or by inserting them in the script")
+        print(
+        "You need to provide a username and a password, either on the command line or by inserting them in the script")
         sys.exit()
 
     example()

example.py examples/example.pyexample.py renamed to examples/example.py

@@ -0,0 +1 @@
+from __version__ import __version__

meteomatics/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+__version__ = "2.0.0"