Package: climadjust
climadjust.clientauthenticate|authenticate()API authentication. Needed to connect to the APIDatasetsObservation datasetsget_observation_datasets|get_observation_datasets(name=None,page=None,size=None,sort_field=None,sort_direction=None)Get a paginated list of observation datasetsArguments:name: (optional) str dataset namepage: (optional) int page numbersize: (optional) int number of results per pagesort_field: (optional) str field to sort results by (either "type" or "name")sort_direction: (optional) str sort direction (either "ASC" or "DESC")Returns:list of observation datasetsget_observation_dataset_by_id|get_observation_dataset_by_id(ds_id:int)Get an observation dataset. In case the dataset is being uploaded the uploaded state will also
appear.Arguments:ds_id: int id of the observation datasetReturns:the selected dataset informationpost_observation_dataset|post_observation_dataset(file,name,ds_format,variables)Uploads an observation datasetArguments:file: str path to the dataset to be uploadedname: str dataset nameds_format: str dataset format (either "NETCDF" or "VALUE_TEXT")variables: list[dict] list of variables. Variable format should be:
{"standardName": "tas", "customName": "tas", "standardUnit": "Celsius", "customUnit": "Celsius"}Returns:id of the uploaded datasetget_validation|get_validation(ds_id)Gets validation warning/errors and GEOJSON info from an uploaded datasetArguments:ds_id: int id of the uploaded datasetReturns:dict of validation warning/errors and a GEOJSON with info from the datasetdelete_observation_dataset|delete_observation_dataset(id:int)Delete existing observation datasetArguments:id: int id of the datasetReturns:Projection datasetsget_projection_datasets|get_projection_datasets(type=None,name=None,page=None,size=None,sort_field=None,sort_direction=None)Get a paginated list of projection datasetsArguments:name: (optional) str dataset namepage: (optional) int page numbersize: (optional) int number of results per pagesort_field: (optional) str field to sort results by (either "type" or "name")sort_direction: (optional) str sort direction (either "ASC" or "DESC")Returns:list of projection datasetsget_projection_datasets_by_id|get_projection_datasets_by_id(id:int)Get a projection dataset infoArguments:id: int id of the projection datasetReturns:dict with dataset infoclimadjust.clientMethods.experiment_mixinget_experiments|get_experiments(page=None,size=None,sort_field=None,sort_direction=None)Get a paginated list of experimentsArguments:page: (optional) int page numbersize: (optional) int number of results per pagesort_field: (optional) str field to sort results by (either "id" or "name")sort_direction: (optional) str sort direction (either "ASC" or "DESC")Returns:list of experimentsget_experiments_by_id|get_experiments_by_id(exp_id)Get a specific experiment. In case the experiment is being uploaded the uploaded state will also
appear.Arguments:exp_id: int id of the experimentReturns:the selected experiment informationpost_experiment|post_experiment(name,temporalResolution,variables,scenarios,models,baconfiguration,spatialResolution,datasetProjection,datasetReference,spatialCoverage,outputFormat,validation,mask)Arguments:name: str experiment nametemporalResolution: str temporal resolution for the experiment (only "DAILY")variables: list list of variables to perform the bias adjustment onscenarios: list list of dictionaries, each dictionary contains the scenario name as well as the startDate
and the endDatemodels: list list of models / members to usebaconfiguration: list list of bias adjustment configurations for each variable
(variable, method, and parameters)spatialResolution: str spatial resolution for the experiment ("NATIVE")datasetProjection: dict dictionary with the IDs of the projections datasets that will be used for the
experimentdatasetReference: dict dictionary with the IDs of the reference datasets that will be used for the
experimentspatialCoverage: shapely.geometry.Polygon() Polygon with the spatial coverage over which to execute the
experimentoutputFormat: str output format (for example "NETCDF", "GRIB", ...)validation: str validation activity to perform (for example "NONE")mask: str a string explaining if land-mask needs to be used (for example "none")Returns:id of the uploaded experimentdelete_experiment|delete_experiment(exp_id)Delete existing experimentArguments:id: int id of the expoeriment to be deletedReturns: