Skip to content

Commit

Permalink
Fix documentation typos and formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
darrylmelander committed Aug 7, 2023
1 parent 99843cd commit 311cab7
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
4 changes: 2 additions & 2 deletions doc/OnlineDocs/source/reference/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -285,15 +285,15 @@ will be overwritten after this callback returns.

.. _plugin-before_operations_solve:

The plugin-before_operations_solve Callback
The before_operations_solve Callback
...........................................

This callback is called after a fully populated SCED Egret model has been generated,
before the model has been solved. The callback may modify the Egret model.

.. _plugin-after_operations:

The plugin-after_operations Callback
The after_operations Callback
....................................

This callback is called after an Egret SCED model has been solved. The callback can
Expand Down
2 changes: 0 additions & 2 deletions doc/OnlineDocs/source/reference/sced_details.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ and line limits. SCEDs always honor unit commitment decisions made by the active
RUC. The number of hours of forecast data to include in the SCED model is
determined by the :ref:`SCED horizon<config_sced-horizon>`.

Something about calculating costs.

If :ref:`market settlement<config_compute-market-settlements>` is enabled,
additional market-related statistics are calculated with each SCED. These
statistics report performance against day-ahead commitments and reserve
Expand Down
13 changes: 9 additions & 4 deletions doc/OnlineDocs/source/tasks/configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,14 +190,16 @@ The table below describes all available configuration options.
* - \-\-ruc-network-type
- ruc_network_type
- String. Default=ptdf.
- Specifies how the network is represented in RUC models. Choices are:
- Specifies how the network is represented in RUC models. Choices are:

* ptdf -- power transfer distribution factor representation
* btheta -- b-theta representation
* - \-\-ruc-slack-type
- ruc_slack_type
- String. Default=every-bus.
- Specifies the type of slack variables to use in the RUC model formulation.
Choices are:

* every-bus -- slack variables at every system bus
* ref-bus-and-branches -- slack variables at only reference bus and each system branch
* - \-\-deterministic-ruc-solver
Expand Down Expand Up @@ -271,13 +273,15 @@ The table below describes all available configuration options.
* - \-\-sced-network-type
- sced_network_type
- String. Default=ptdf.
- Specifies how the network is represented in SCED models. Choices are:
- Specifies how the network is represented in SCED models. Choices are:

* ptdf -- power transfer distribution factor representation
* btheta -- b-theta representation
* - \-\-sced-slack-type
- sced_slack_type
- String. Default=every-bus.
- Specifies the type of slack variables to use in SCED models. Choices are:
- Specifies the type of slack variables to use in SCED models. Choices are:

* every-bus -- slack variables at every system bus
* ref-bus-and-branches -- slack variables at only reference bus and each system branch
* - \-\-sced-solver
Expand Down Expand Up @@ -361,7 +365,8 @@ The table below describes all available configuration options.
* - \-\-day-ahead-pricing
- day_ahead_pricing
- String. Default=aCHP.
- The pricing mechanism to use for the day-ahead market. Choices are:
- The pricing mechanism to use for the day-ahead market. Choices are:

* LMP -- locational marginal price
* ELMP -- enhanced locational marginal price
* aCHP -- approximated convex hull price.
Expand Down

0 comments on commit 311cab7

Please sign in to comment.