From cabaa3b787cbe6c10c939291b4b351aa445e49dc Mon Sep 17 00:00:00 2001 From: koraidon Date: Tue, 10 Jun 2025 21:17:03 -0500 Subject: [PATCH] add tep desc --- docs/src/guides/format.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/src/guides/format.md b/docs/src/guides/format.md index 2543ff6..e34b4b0 100644 --- a/docs/src/guides/format.md +++ b/docs/src/guides/format.md @@ -24,7 +24,10 @@ This section describes system-wide parameters, such as power balance penalty, an | `Time step (min)` | Length of each time step (in minutes). Must be a divisor of 60 (e.g. 60, 30, 20, 15, etc). | `60` | No | No | | `Power balance penalty ($/MW)` | Penalty for system-wide shortage or surplus in production (in $/MW). This is charged per time step. For example, if there is a shortage of 1 MW for three time steps, three times this amount will be charged. | `1000.0` | No | Yes | | `Scenario name` | Name of the scenario. | `"s1"` | No | --- | -| `Scenario weight` | Weight of the scenario. The scenario weight can be any positive real number, that is, it does not have to be between zero and one. The package normalizes the weights to ensure that the probability of all scenarios sum up to one. | 1.0 | No | --- | +| `Scenario weight` | Weight of the scenario. The scenario weight can be any positive real number, that is, it does not have to be between zero and one. The package normalizes the weights to ensure that the probability of all scenarios sum up to one. | `1.0` | No | --- | +| `Operation cost weight` | Weighting factor to make operation costs comparable to investment costs. Required for transmission expansion planning problem. | `1.0` | No | --- | +| `Planning horizon (year)` | Length of transmission planning horizon in years. | Optional | No | --- | +| `Discount rate` | Annual discount rate. | Optional | No | --- | #### Example @@ -35,7 +38,8 @@ This section describes system-wide parameters, such as power balance penalty, an "Time horizon (h)": 4, "Power balance penalty ($/MW)": 1000.0, "Scenario name": "s1", - "Scenario weight": 0.5 + "Scenario weight": 0.5, + "Operation cost weight": 1.0 } } ``` @@ -89,6 +93,8 @@ This section describes all generators in the system. Two types of units can be s | `Must run?` | If `true`, the generator should be committed, even if that is not economical (Boolean). | `false` | Yes | Yes | | `Reserve eligibility` | List of reserve products this generator is eligibe to provide. By default, the generator is not eligible to provide any reserves. | `[]` | No | Yes | | `Commitment status` | List of commitment status over the time horizon. At time `t`, if `true`, the generator must be commited at that time period; if `false`, the generator must not be commited at that time period. If `null` at time `t`, the generator's commitment status is then decided by the model. By default, the status is a list of `null` values. | `null` | Yes | Yes | +| `Investment cost ($)` | Cost to build a candidate generation unit. $0.0 for existing units. | `0.0` | No | No | + #### Profiled Units @@ -99,6 +105,8 @@ This section describes all generators in the system. Two types of units can be s | `Cost ($/MW)` | Cost incurred for serving each MW of power by this generator. | Required | Yes | Yes | | `Minimum power (MW)` | Minimum amount of power this generator may supply. | `0.0` | Yes | Yes | | `Maximum power (MW)` | Maximum amount of power this generator may supply. | Required | Yes | Yes | +| `Investment cost ($)` | Cost to build a candidate generation unit. $0.0 for existing units. | `0.0` | No | No | + #### Production costs and limits @@ -158,7 +166,8 @@ Note that this curve also specifies the production limits. Specifically, the fir "Type": "Profiled", "Minimum power (MW)": 10.0, "Maximum power (MW)": 120.0, - "Cost ($/MW)": 100.0 + "Cost ($/MW)": 100.0, + "Investment cost ($)": 3000000.0 } } } @@ -266,7 +275,7 @@ This section describes components in the system which may increase or reduce the ### Transmission lines -This section describes the characteristics of transmission system, such as its topology and the susceptance of each transmission line. +This section describes the characteristics of transmission system, such as its topology and the susceptance of each transmission line. If a line can be built multiple times, then that many copies of the struct should be included in the data file. | Key | Description | Default | Time series? | Uncertain? | | :-------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | :----------: | :--------: | @@ -276,6 +285,7 @@ This section describes the characteristics of transmission system, such as its t | `Normal flow limit (MW)` | Maximum amount of power (in MW) allowed to flow through the line when the system is in its regular, fully-operational state. | `+inf` | Yes | Yes | | `Emergency flow limit (MW)` | Maximum amount of power (in MW) allowed to flow through the line when the system is in degraded state (for example, after the failure of another transmission line). | `+inf` | Y | Yes | | `Flow limit penalty ($/MW)` | Penalty for violating the flow limits of the transmission line (in $/MW). This is charged per time step. For example, if there is a thermal violation of 1 MW for three time steps, then three times this amount will be charged. | `5000.0` | Yes | Yes | +| `Investment cost ($)` | Cost to build a candidate transmission line. $0 for existing lines. | `0.0` | No | No | #### Example @@ -288,7 +298,8 @@ This section describes the characteristics of transmission system, such as its t "Susceptance (S)": 29.49686, "Normal flow limit (MW)": 15000.0, "Emergency flow limit (MW)": 20000.0, - "Flow limit penalty ($/MW)": 5000.0 + "Flow limit penalty ($/MW)": 5000.0, + "Investment cost ($)": 3000000.0 } } }