GenXProject / GenX.jl

GenX: a configurable power system capacity expansion model for studying low-carbon energy futures. More details at : https://genx.mit.edu
https://genxproject.github.io/GenX.jl/
GNU General Public License v2.0
270 stars 114 forks source link

Update case folder structure and examples #640

Closed lbonaldo closed 7 months ago

lbonaldo commented 7 months ago

Description

This PR updates the folder structure of a GenX case, and selects the examples for v0.4. The proposed version is the following:

example_case
│ 
├── settings
│   ├── genx_settings.yml
│   ├── [other solver settings]
│   └── highs_settings.yml
│ 
├── system
│   ├── Demand_data.csv
│   ├── Fuel_data.csv
│   ├── Generators_variability.csv
│   ├── Operational_reserves.csv
│   └── Network.csv
│ 
├── policies
│   ├── CO2_cap.csv
│   ├── Minimum_capacity_requirement.csv
│   └── Energy_share_requirement.csv
│ 
├── resources
│   ├── Thermal.csv
│   ├── Storage.csv
│   ├── Vre.csv
│   ├── Hydro.csv
│   └── policy_assignments
|       ├── Resource_minimum_capacity_requirement.csv
│       └── Resource_energy_share_requirement.csv
│ 
├── TDR_results
├── results
├── README.md
└── Run.jl

Tests and examples have been updated to match the new folder structure, and the naming convention for folders is snake_case, to match the rest the of the source code.

All the current examples can be moved to a separate repository together with the new tutorials: https://github.com/GenXProject/GenX-Tutorials

Please feel free to add any comments or suggestions you may have on this PR.

What type of PR is this? (check all applicable)

Checklist

How this can be tested

I ran all the example cases and the tests that are available.

Post-approval checklist for GenX core developers

After the PR is approved