From 1d1c51d17b48f0a7be951b849ce992342c452002 Mon Sep 17 00:00:00 2001 From: gonzaloparradohernando Date: Fri, 26 Jul 2024 11:37:07 +0200 Subject: [PATCH] paper development. The Tristan's part (translation) in section -Notes about the architecture- is still pending. --- paper.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/paper.md b/paper.md index b03cca0..c2cbfca 100644 --- a/paper.md +++ b/paper.md @@ -71,10 +71,19 @@ The user can generate a specific environment to install (via pip) all the requir 3. Execute the file *Convert_Wiliam_result_IAMC-format.py* to translate the results under IAMC format criteria. The script converts all the existing CSV files in the folder (`python Convert_Wiliam_result_IAMC-format.py`). 4. Finally, run the *merge_csv* to merge all files present in the folder *File_Converted* (`python Merge_csv.py`) -There are several notebooks available in the folder *Visualization* to facilitate the learning process, including a general report with principal variables of the model, as well as specific examples of customizable plots. +All the instructions to work with the IAMC format are available + ## Notes about the architecture +The `wiliamcformat` package is built upon a suit of tools and functions provided by the `pyam` project. This project uses well-known libraries such as `pandas` and `plotly` to manage and visualize the data. So, results in WILIAM may be enriched with new updates in the aforementioned packages. `wiliamcformat` is structured in two blocks: +- Translation of WILIAM variables into IAMC standards. +- Notebooks to facilitate the reporting and visualization of data. + +The user can download WILIAM in two languages, Python (https://github.com/LOCOMOTION-h2020/pywiliam) and Vensim (https://github.com/LOCOMOTION-h2020/WILIAM_model_VENSIM), and generate the CSV file of a simulation. Both tools were developed during the European H2020 Locomotion project (Grant Agreement number 821105). + +Finally, several notebooks are available in the folder *Visualization* to facilitate the learning process, including a general report with principal variables of the model, as well as specific examples of customizable plots. + # Acknowledgements G.P. and J.P. acknowledge financial support from the European Union's Horizon research program under grant agreement 101056306 (IAM COMPACT project).