Skip to content

Dataex

Dataex API

An API client library developed using python to provide programmatic acess to DataEx modules. The following are some usecases it provides:

  • Download and insert station specific observation data.
  • Download summary of available observation data for every member country.
  • Download raw netcdf data of ECMWF HRES/ENS/SEAS forecasts for specific region and parameter.
  • List reducer names and user assets available for forecast analysis.
  • Download region specific forecast timeseries of ECMWF ENS/HRES/SEAS model forecasts.
  • Download forecast graph and animation.

Installation

Dataex API client can be installed using the following command, 

pip install https://github.com/nzahasan/dataex-client/zipball/master

Commands

Below are some python scripts included in the library. Please explore the documentation for further info.

  • dataex_init.py - Create .dataex_auth.json file for dataex user authentication
  • dataex_netcdf_subset.py - Download raw netcdf subset of ECMWF HRES/ENS/SEAS model forecasts.
  • dataex_list_country_info.py - List information of countries.
  • dataex_obs_station_list.py - List station(s) information of a specific country.
  • dataex_get_obs_data.py - Download observation data.
  • dataex_insert_obs_data.py - Upload observation data.
  • dataex_obs_data_summary.py - Download summary of observation data.
  • dataex_obs_parameter_list.py - Retrieve a list of parameter information of a specific station.
  • dataex_list_user_assets.py - List user assets available to use in forecast analysis.
  • dataex_list_reducers.py - List reducer names available for use in forecast analysis.
  • dataex_region_data_analysis.py - Download region specific forecast time series of ECMWF HRES/ENS/SEAS model forecasts.
  • dataex_forecast_graph_params.py - Check the available parameters for forecast Graphics.
  • dataex_forecast_graph.py - Download graph of forecasts of ECMWF HRES/ENS/SEAS model forecasts.
  • dataex_forecast_animation.py - Download animation of forecasts of ECMWF HRES/ENS/SEAS model forecasts.
  • dataex_climatology_graph.py - Download climatology of a station for the available duration of observations.

Example

Let's take a quick look at an example of one of the commands above. It's as easy as typing the command into your favourite terminal. Suppose, we want to download a netCDF file holding a subset of forecast values from model ecmwf-hres for parameters u10, swvl1, t2m. We can use the following command, 

dataex_netcdf_subset.py --model_type ecmwf_hres --ecmwf_hres_params u10,swvl1,t2m --latbounds 40.3 60.0 --lonbounds 90.0 120.0 --output $HOME/ecmwf_hres_subset.nc
Alternatively, you can use short forms of the option names used in the above command.

Support

For any technical support please send an email to support@rimes.int. Please make sure to include the specific problem in the subject of the mail.

Security

If you believe you've found something in the dataex client API which has security implications, please send a description of the issue via email to support@rimes.int.

License

MIT License

Copyright © RIMES

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.