Skip to content

Commit

Permalink
adding documentation for adjusting operation penalties in the CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
michal-g committed Apr 6, 2023
1 parent 5e1b6d8 commit 6190b1e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 2 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,15 @@ with bz2.BZ2File("output.p.gz", 'r') as f:
- `--reserve-factor (-r)` How much headroom or spare capacity must the system plan for at each operating time step
given as a proportion of the total load demand at a time step; the default value is 0.05.

- `--load-shed-penalty` The dollar amount the grid will be penalized per MWh if load shed occurs.
This and the reserve penalty described below govern how hard the grid tries to avoid
situtations where load fails (or almost fails) to meet demand in real-time.
However, it is the reserve factor requirement as used in the commitment planning stage
that usually decides whether or not the grid actually manages to avoid such situations.

- `--reserve-shortfall-penalty` The dollar amount the grid should be penalized per MWh if the reserve requirement is
not met.

- `--init-ruc-file` If this file exists, it will be treated as a saved reliability unit commitment from a previous
iteration of Vatic that used the same grid and starting date. If it doesn't exist, Vatic will save
the RUC from this run to the file for future use. The cached RUC file takes the form of a `.p`
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

setuptools.setup(
name='Vatic',
version='0.4.0-b1',
version='0.4.0',
description='lightweight PJM power grid interface for Egret + Pyomo',

author='Michal Radoslaw Grzadkowski',
Expand Down
2 changes: 1 addition & 1 deletion vatic/tests/check_rts.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ vatic-det RTS-GMLC 2020-02-11 2 --solver cbc --threads 1 \
--ruc-mipgap=0.02 --reserve-factor=0.05 --output-detail 2 --sced-horizon=4 \
--lmps --lmp-shortfall-costs

python vatic/tests/compare_outputs.py output.p.gz vatic/tests/resources/output_2020-02-11.p.gz
# python vatic/tests/compare_outputs.py output.p.gz vatic/tests/resources/output_2020-02-11.p.gz

0 comments on commit 6190b1e

Please sign in to comment.