CROSS model comparison plots

This is the library to plot the results for the CROSS model comparison

Files and folders

• distributions/plots.py contains all the functions to upload the data and plot
• cross_comparison.py is the python code that interacts with distributions/plots.py and creates the plots
• results/ is the folder where the results are uploaded
• plots/ is the folder where the plots are saved
• CROSS-comparison-plots-instructions.pdf describes in the detailed the use of the code and the required data format

Dependencies

• See requirements.txt.
  

Usage with python virtual environment without Conda

• Create a python virtual environment doing the following:
  • python -m venv /path_to/cross-comparison (This command creates a virtual environment called "cross-comparison")
  • Mac-Os X and Unix based operating systems: source /path_to/cross-comparison/bin/activate (This command activates the "cross-comparison" environment.)
  • Windows operating system: /path_to/cross-comparison/Scripts/activate.bat (This command activates the "cross-comparison" environment.)
  • cd to the folder where you cloned the code
  • pip install -r requirements.txt (This command installs all the required python packages.)
• Run/edit cross_comparison.py.

Usage with python virtual environment with Conda

• Create a python virtual environment for this project. For example, if you use conda for python package management, do the following:
  • conda create -n cross-comparison (This command creates a virtual environment called "cross-comparison")
  • conda activate cross-comparison (This command activates the "cross-comparison" environment.)
  • cd to the folder where you cloned the code
  • pip install -r requirements.txt (This command installs all the required python packages.)
• Run/edit cross_comparison.py.

Copyright and license

© 2024, ETH Zurich, Energy Science Center, Adriana Marcucci

This code was developed by the SWEET CoSI consortium, which is sponsored by the Swiss Federal Office of Energy’s SWEET programme.

Licensed under the Apache License, Version 2.0 (the "LICENSE"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Acknowledging authorship

In the academic spirit of collaboration, the source code should be appropriately acknowledged in the resulting scientific disseminations. You may cite it as follows:

Marcucci, A. (2024). Code for production of CROSS model comparison plots. DOI: 10.5905/ethz-1007-780