-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation of the industry module
- Loading branch information
Meijun Chen
committed
Apr 11, 2024
1 parent
5c60a7f
commit 1f892bf
Showing
1 changed file
with
15 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,17 @@ | ||
# About | ||
|
||
Placeholder text for the industry module documentation. | ||
This module is dedicated to getting and processing energy demand for industry. | ||
|
||
Basic info of this module: | ||
- Main data sources: JRC IDEES and eurostat | ||
- Spacial resolution: national (because of JRC IDEES) | ||
- Temporal resolution: annual aggregated | ||
|
||
Some industries are specified as 'sub-module' in this module, such as iron and steel industry. This allows flexibly configure the decarbonisation level of each industry separately. All other industries are grouped into 'other industies'. | ||
|
||
For non-developer users, `config.yaml` is the main file to look into. Here, one can specify parameters such as the years to be included in the data processing, assumptions such as the share of recycled steel, and what specific industry sector to be included (such as iron and steel industry). The structure of the `config.yaml` file is: | ||
|
||
- inputs - the needed data sources from other modules in euro-calliope (for now, we assume this module depends on other modules and is not yet a stand-alone module) | ||
- outputs - the output of the whole industry module, usually files, possibly passed on to other modules in euro-calliope. | ||
- params - the parameters that affect the calculation process and result in this module. By changing the value of the parameters, each user can tailor the workflow to their own needs. | ||
- setup - anything that concerns the general data pipeline of the module. |