Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SabineHaas committed Dec 18, 2024
1 parent 3cdc66f commit 8701923
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
# Data Adapter
General data adapter that provides functionalities for other data adapters.

This package provides scripts to download and preprocess data from OEDatamoel_parameter for further use in various ESM frameworks.
## Installation

To install data_adapter, follow these steps:

## Energysystem Structure
* git-clone data_adapter into local folder:
`git clone https://github.com/rl-institut/data_adapter.git
* enter folder `cd data_adapter`
* create virtual environment using conda: `conda env create -f environment.yml`
* activate environment: `conda activate data_adapter`
* install data_adapter_oemof package using poetry, via: `poetry install`

Structure (processes and its parameters linked to busses/commodities) of an ES is stored as SQlite database using the following ERM:
## Functionalities

![Process ERM](/home/local/RL-INSTITUT/hendrik.huyskens/Dokumente/RLI/data_adapter/assets/process_erm.png "Process ERM")
* Download of the latest data and metadata
* Verification checks on the downloaded data and metadata
* Preprocessing of the process data such as:
* Merging, filtering and transforming
* Unit conversion

0 comments on commit 8701923

Please sign in to comment.