IHEWAcollect package

Subpackages

Submodules

IHEWAcollect.download module

Download

Before use this module, create accounts.yml file. And edit account information in the file.

class IHEWAcollect.download.Download(workspace='', product='', version='', parameter='', resolution='', variable='', acct_path='/home/docs/checkouts/readthedocs.org/user_builds/ihewacollect/checkouts/latest/docs/../src/IHEWAcollect', bbox={}, period={}, nodata=- 9999, is_status=True, is_save_temp=False, is_save_remote=False, is_save_list=False, **kwargs)[source]

Bases: User

Download class

After initialise the class, data downloading will automatically start.

Parameters:
  • workspace (str) – Directory to accounts.yml.

  • product (str) – Product name.

  • version (str) – Version name.

  • parameter (str) – Parameter name.

  • resolution (str) – Resolution name.

  • variable (str) – Variable name.

  • bbox (dict) – Spatial range, {‘w’:, ‘s’:, ‘e’:, ‘n’:}.

  • period (dict) – Time range, {‘s’:, ‘e’:}.

  • nodata (int) – -9999.

  • is_status (bool) – Is to print status message.

  • kwargs (dict) – Other arguments.

get_products() dict[source]

Get details of all products

Returns:

Products data.

Return type:

dict

status = 'Global status.'

Module contents

IHEWAcollect: IHE Water Accounting Collect Tools

class IHEWAcollect.Download(workspace='', product='', version='', parameter='', resolution='', variable='', acct_path='/home/docs/checkouts/readthedocs.org/user_builds/ihewacollect/checkouts/latest/docs/../src/IHEWAcollect', bbox={}, period={}, nodata=- 9999, is_status=True, is_save_temp=False, is_save_remote=False, is_save_list=False, **kwargs)[source]

Bases: User

Download class

After initialise the class, data downloading will automatically start.

Parameters:
  • workspace (str) – Directory to accounts.yml.

  • product (str) – Product name.

  • version (str) – Version name.

  • parameter (str) – Parameter name.

  • resolution (str) – Resolution name.

  • variable (str) – Variable name.

  • bbox (dict) – Spatial range, {‘w’:, ‘s’:, ‘e’:, ‘n’:}.

  • period (dict) – Time range, {‘s’:, ‘e’:}.

  • nodata (int) – -9999.

  • is_status (bool) – Is to print status message.

  • kwargs (dict) – Other arguments.

get_products() dict[source]

Get details of all products

Returns:

Products data.

Return type:

dict

status = 'Global status.'