LOCALISED Datasharing API Client

Step-by-step instructions to access data, published on LOCALISED datasharing platform, via our API client. The official API documentation can be found under http://data.localised-project.eu/api/v1/docs/)

0. Before you begin, please make sure you have mamba installed in your base environment:

   conda install mamba -c conda-forge

1. Clone the repository:

   git clone https://github.com/FZJ-IEK3-VSA/LOCALISED-Datasharing-API-Client.git

2. Installing dependencies in a clean conda environment:

   cd LOCALISED-Datasharing-API-Client
   mamba env create -n dsp_client -f requirements.yml 
   conda activate dsp_client

3. Installing the repository:

   pip install -e.

4. Run the example Jupyter notebooks - examples/all_regions_data_.ipynb and examples/single_region_data.ipynb

   Depending on type of query, the list of required parameters change. Please refer to the doc strings of each funtion to get the entire list of relevant parameters. They would be a subset of the ones below:

   • api_key --> The secret API key. Note: Please use the key shared with you in confidence

   • spatial_resolution --> Options - NUTS0, NUTS1, NUTS2, NUTS3, LAU

   • country_code --> If you wish to filter on a particular region, provide its country code here

   • region_code --> If you wish to filter on a particular region, provide a region code here

   • variable_name --> If you wish to get data for a particular variable, provide the name here

Project based on the cookiecutter data science project template. #cookiecutterdatascience

About Us

We are the Institute of Energy and Climate Research - Techno-economic Systems Analysis (IEK-3) belonging to the Forschungszentrum Jülich. Our interdisciplinary department's research is focusing on energy-related process and systems analyses. Data searches and system simulations are used to determine energy and mass balances, as well as to evaluate performance, emissions and costs of energy systems. The results are used for performing comparative assessment studies between the various systems. Our current priorities include the development of energy strategies, in accordance with the German Federal Government’s greenhouse gas reduction targets, by designing new infrastructures for sustainable and secure energy supply chains and by conducting cost analysis studies for integrating new technologies into future energy market frameworks.