data api client design

Discussion of the data-api client requirements and implementation

Motivation

The data-api client, climada.util.api_client.Client is meant for

• providing a generic python interface to the public CLIMADA data api
• creating climada Python objects, such as Exposures, Hazard or ImpactFunc, from dataset files of the CLIMADA data api in a comfortable, easy to use way.\

The implemented methods are supposed to be as natural as possible and hiding away boilerplate code that downloads files, reads and converts content into CLIMADA objects. Additionally they should take care of caching files on the local filesystem in order to save resources of the api server.

Methods

list_data_type_infos

returns:

arguments:

purpose:

considerations:

get_data_type_info

returns:

arguments:

purpose:

considerations:

list_dataset_infos

returns:

arguments:

purpose:

considerations:

get_dataset_info

returns:

arguments:

purpose:

considerations:

get_hazard

returns:

arguments:

purpose:

considerations:

get_exposures

returns:

arguments:

purpose:

considerations: