Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
cfe316 committed Oct 31, 2023
1 parent d6c972b commit 0f4ce45
Showing 1 changed file with 3 additions and 13 deletions.
16 changes: 3 additions & 13 deletions Example_Systems/ProprietarySolver/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
# Small New England: One Zone
# Proprietary solver example

**SmallNewEngland** is set of a simplified versions of the more detailed example system RealSystemExample. It is condensed for easy comprehension and quick testing of different components of the GenX. **SmallNewEngland/OneZone** is our most basic model, a one-year example with hourly resolution containing only one zone representing New England. The model includes only natural gas, solar PV, wind, and lithium-ion battery storage with no initial capacity.
This demonstrates how to use a proprietary solver such as Gurobi or CPLEX, instead of the default solver HiGHS.

To run the model, first navigate to the example directory at `GenX/Example_Systems/SmallNewEngland/OneZone`:

`cd("Example_Systems/SmallNewEngland/OneZone")`

Next, ensure that your settings in `GenX_settings.yml` are correct. The default settings use the solver Gurobi (`Solver: Gurobi`), time domain reduced input data (`TimeDomainReduction: 1`). Other optional policies include minimum capacity requirements, a capacity reserve margin, and more. A rate-based carbon cap of 50 gCO<sub>2</sub> per kWh is specified in the `CO2_cap.csv` input file.

Once the settings are confirmed, run the model with the `Run.jl` script in the example directory:

`include("Run.jl")`

Once the model has completed, results will write to the `Results` directory.
See `Run.jl` and the `Solver` setting in `Settings/genx_settings.yml`.

0 comments on commit 0f4ce45

Please sign in to comment.