diff --git a/paper.md b/paper.md index 347a29b..3fca519 100644 --- a/paper.md +++ b/paper.md @@ -32,9 +32,9 @@ bibliography: paper.bib --- # Summary -The international scientific community assessing on climate change and mitigation scenarios requests standardization and harmonization of results in integrated assessment models to: ensure full transparency about the origin and structure of data; facilitate the comparison across models in both the historical period and future scenarios; and discuss on conceptual ideas about the internal structure of models, so to what extent different models representing the same system present similar results and conclusions. +The international scientific community assessing on climate change and mitigation scenarios requests standardization and harmonization of results in integrated assessment models to ensure full transparency about the origin and structure of data; facilitate the comparison across models in both the historical period and future scenarios; and discuss on conceptual ideas about the internal structure of models, so to what extent different models representing the same system present similar results and conclusions. -Results from different measurement procedures for the same measure should be equivalent (harmonized) within stated specifications to measure uncertainty. A task that is already mandatory to contribute on high-level international reports such as those elaborated by the Intergovernmental Pannel of Climate Change (IPCC) while necessary in the daily work of collaborative projects where different tools are applied to solve the same research question. The present `wiliamcformat` library aims to adapt and extend the potential of existing material for users of a novel integrated assessment model, WILIAM. A pending task that has not been documented before although the urgency for improving transparency and responsability of this model to meet open-science principles (FAIR [@Wilkinson2016] and TRUST [@Lin2020]), as well as usability. Furthermore, we hope that these materials will inspire students to engage move deeply with the science of climate change and social transitions. +Results from different measurement procedures for the same measure should be equivalent (harmonized) within stated specifications to measure uncertainty. A task that is already mandatory to contribute on high-level international reports such as those elaborated by the Intergovernmental Pannel of Climate Change (IPCC) while necessary in the daily work of collaborative projects where different tools are applied to solve the same research question. The present `wiliamcformat` library (what we developed is not a library as it is just a piece of code, Python libraries are collections of pre-written code and functions that extend the capabilities of the Python programming language. So, if we want to transform to library, we need to change the structure. We can present it as helpers to handle the translation to IAMC format.) aims to adapt and extend the potential of existing material for users of a novel integrated assessment model, WILIAM. A pending task that has not been documented before although the urgency for improving transparency and responsability of this model to meet open-science principles (FAIR [@Wilkinson2016] and TRUST [@Lin2020]), as well as usability. Furthermore, we hope that these materials will inspire students to engage move deeply with the science of climate change and social transitions (A extended documentation need to be written to help the student to use it. Like that, I think every one agree that it will not be useful for students) . # Statement of need @@ -44,14 +44,14 @@ The demand from model inter-comparison projects (MIPs) is a fruitful enterprise Additionally, despite the topic of climate change is being introduced in educational curriculum, [@Filho2023] identified *less attention given to systematically assessing the attitude, perceptions, and practices of students and the integration of the climate topic in the higher education institutions’ curricula and co-curricular activities in a way that may guide changes in the curriculum and teaching practices*. Consequently, we also aim to contribute here, inspiring students to engage with climate change problems when they are learning Python lessons. -WILIAM is a nascent system dynamics policy-simulation model, descendent from the MEDEAS model [@capellan2020], which purpose is to capture the socioeconomic implications of the energy transition(s) accounting for biophysical constraints. Although there are some articles published, standardization and harmonization is yet missing so a potential improvement to better present results and increase the transparency of the overall research activity with it. To do it properly, we have developed `wiliamcformat`, a python package that translates WILIAM outputs to IAMC format timeseries for linking results with the existing aPython library called pyam, supported by IIASA. Standarization, harmonization and visualization in a unique code for WILIAM users. +WILIAM is a nascent system dynamics policy-simulation model, descendent from the MEDEAS model [@capellan2020], which purpose is to capture the socioeconomic implications of the energy transition(s) accounting for biophysical constraints. Although there are some articles published, standardization and harmonization is yet missing so a potential improvement to better present results and increase the transparency of the overall research activity with it. To do it properly, we have developed `wiliamcformat`, a python package that translates WILIAM outputs to IAMC format timeseries for linking results with the existing Python library called pyam, supported by IIASA. Standarization, harmonization and visualization in a unique code for WILIAM users. # Functionality This section describes the code with a short example to easily follow the whole workflow. ## A brief description -The `wiliamcformat` package is public, available at the domain https://github.com/Tristan22400/IAMC_format. Following the next steps (more detailed in the *README.md* file), the user can obtain the results of WILIAM under the IAMC format criteria and plot results in a general report or customized graphs. +The `wiliamcformat` package (it is not a package currently) is public, available at the domain https://github.com/Tristan22400/IAMC_format. Following the next steps (more detailed in the *README.md* file), the user can obtain the results of WILIAM under the IAMC format criteria and plot results in a general automatic report or customized graphs. The user can follow the next steps to install a stable version of the code and play with examples: @@ -67,7 +67,7 @@ The `wiliamcformat` package is built upon a suit of tools and functions provided 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). -Regarding the translation, the notebook named *translation.ipynb* explains every step easily to learn the code. The translation is supported by dictionaries (folder *Create_Variable_Dict*) to solve the equivalence between the dimensions of WILIAM variables (subscripts in Vensim software) and the specific IAMC format. In the same folder, the file *Variable_name_IAMC.xlsx* facilitates the translation of WILIAM variable names. The code automatically builds the correspoinding name list called *variable_name_dict.txt*. Missing variables during the translation process are tracked in file *list_missing_variable.txt* to correct them in a second translation round. +Regarding the translation, the notebook named *translation.ipynb* explains the automatic translation step by step to easily to learn the code. The translation is supported by dictionaries (folder *Create_Variable_Dict*) to solve the equivalence between the dimensions of WILIAM variables (subscripts in Vensim software) and the specific IAMC format. In the same folder, the file *Variable_name_IAMC.xlsx* facilitates the translation of WILIAM variable names. The code automatically builds the corresponding name list in the IAMC format then a manual correction needs to be performed to correct the last errors not handled by the automatic translation and create the final dictionary currently called *variable_name_dict.txt*. A important number of variables of Wiliam are already presented in the file *variable_name_dict.txt*, the dictionary of all the variables translated. If some variables are missing during the translation process, the automatic translation are applied to them. Then, the user can correct them manually in the file *list_missing_variable.txt* and add them to the dictionnary of translated variables. During the addition to the dictionnary, a check on the respect of the IAMC format is done in order to avoid the pollution of the dictionnary by incorrect variables. They will be included in the next process of translation. 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. @@ -75,4 +75,4 @@ Finally, several notebooks are available in the folder *Visualization* to facili G.P. and J.P. acknowledge financial support from the European Union's Horizon research program under grant agreement 101056306 (IAM COMPACT project). -# References \ No newline at end of file +# References