Skip to content

feat: address mixed issues #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mcllerena wants to merge 19 commits into
base: main
Choose a base branch
from
Open

feat: address mixed issues #128

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
3ec9ff3
chore: rename queries/ folder to sql/
mcllerena Apr 29, 2026
cfa3c74
feat: enable dynamic property behavior by default for components
mcllerena Apr 29, 2026
4c68314
refactor: move checkers logic out of db class
mcllerena Apr 29, 2026
d6dab3f
refactor: update related files with moved checking logic
mcllerena Apr 29, 2026
3d8ee21
tests: resolve tests with checks module
mcllerena Apr 29, 2026
220d35b
test: resolve tests with checks module
mcllerena Apr 29, 2026
957ccdf
Merge branch 'ml/fix-issues' of https://github.com/NatLabRockies/plex…
mcllerena Apr 29, 2026
bfb2401
docs: update docs for simulation configurations on models
mcllerena Apr 29, 2026
325a0be
feat: add capability to filter object properties by scenario and scen…
mcllerena Apr 29, 2026
f02b1a2
feat: enable create_schema method to load classes in the backend to s…
mcllerena Apr 29, 2026
7c6ae2d
docs: update db tutorial creating and docstrings
mcllerena Apr 29, 2026
67a45ca
docs: add create scbema specifications for db initialization
mcllerena Apr 29, 2026
cb9c83c
fix: resolve version parameter issue to avoid duplicated on t config …
mcllerena Apr 29, 2026
8cb0e8b
docs: resolve docs with recent simulation configurations
mcllerena Apr 29, 2026
7070431
docs: add additional link to original plexos source documentation
mcllerena Apr 29, 2026
856c72a
Merge branch 'main' into ml/fix-issues
mcllerena Apr 30, 2026
7543586
fix: remove hard-coded scenario/collection IDs from sql file
mcllerena Apr 30, 2026
6bd0725
fix: build ? placeholders and pass values as bound parameters
mcllerena Apr 30, 2026
0b0a03c
fix: run formatter
mcllerena Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions docs/source/api/diagnostic_attributes.md
View file
Open in desktop

Large diffs are not rendered by default.

36 changes: 36 additions & 0 deletions docs/source/api/horizon_attributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Horizon Attributes Reference

This page documents the PLEXOS Horizon class attributes and their default
values, validation rules, and descriptions.

To look at the open access PLEXOS documentation, go to
[PLEXOS Horizon Index](https://portal.energyexemplar.com/unified-help/plexos-desktop/index.htm#t=Index.Horizon.html&rhsearch=HORIZON).

Use this reference when setting configuration values through PlexosDB
attributes, for example with `add_attribute`, `get_attribute`, and
`list_attributes`.

## Horizon Attributes

| Name | Units | Default Value | Validation Rule | Description |
| -------------------------- | ------ | ------------- | ------------------- | ----------------------------------------------------------------------- |
| Chrono At a Time | - | 1 | >= 1 | Number of steps in the chronological model |
| Chrono Date From | - | 43831 | >= 0 | Start date for the chronological model |
| Chrono Period From | - | 1 | >= 1 | Start interval for the chronological model |
| Chrono Period To | - | 24 | >= 1 | End interval for the chronological model |
| Chrono Step Count | - | 1 | >= 1 | Number of step types in each step of the chronological model |
| Chrono Step Type | - | 2 | In (-1,0,1,2,3) | Chronological model step type |
| Chronology | - | 0 | In (0,1) | Type of chronology used |
| Compression Factor | - | 1 | >= 1 | Number of intervals to output per interval simulated |
| Date From | - | 43831 | >= 0 | Start date of the planning horizon |
| Day Beginning | - | 0 | Between 0 And 23 | Start hour of the trading day |
| Look-ahead At a Time | - | 1 | >= 1 | Number of step types in each step of the chronological model look-ahead |
| Look-ahead Count | - | 0 | >= 0 | Number of additional look-ahead steps in the planning horizon |
| Look-ahead Indicator | Yes/No | 0 | In (0,-1) | Flag if chronological model used a look-ahead |
| Look-ahead Periods per Day | - | 24 | Between 1 And 86400 | Number of intervals in each trading day of the look-ahead |
| Look-ahead Type | - | 1 | In (0,1,2,6) | Step type for look-ahead in chronological model |
| Periods per Day | - | 24 | Between 1 And 86400 | Number of intervals in each trading day |
| Step Count | - | 1 | >= 1 | Number of steps in the planning horizon |
| Step Type | - | 1 | In (1,2,3,4) | Planning horizon step type |
| Week Beginning | - | 0 | Between -1 And 7 | Start day for weekly constraints |
| Year Ending | - | 0 | Between 0 And 12 | Last month of the fiscal year |
10 changes: 10 additions & 0 deletions docs/source/api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ behavior.
:maxdepth: 2

plexosdb
model_attributes
production_attributes
performance_attributes
transmission_attributes
pasa_attributes
diagnostic_attributes
horizon_attributes
mt_schedule_attributes
st_schedule_attributes
lt_plan_attributes
enums
exceptions
utils
Expand Down
68 changes: 68 additions & 0 deletions docs/source/api/lt_plan_attributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# LT Plan Attributes Reference

This page documents the PLEXOS LT Plan attributes and their default values,
validation rules, and descriptions.

To look at the open access PLEXOS documentation, go to
[PLEXOS LT Plan Index](https://portal.energyexemplar.com/unified-help/plexos-desktop/index.htm#t=Index.LTPlan.html&rhsearch=lt%20plan).

Use this reference when setting configuration values through PlexosDB
attributes, for example with `add_attribute`, `get_attribute`, and
`list_attributes`.

## LT Plan Attributes

| Name | Units | Default Value | Validation Rule | Description |
| ---------------------------------------------- | ------ | ------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| Allow Capacity Sharing | Yes/No | 0 | In (0,-1) | If regions/zones can share capacity reserves to meet requirements. |
| Always Annualize Build Cost | - | 0 | In (0,-1) | If Build Cost is always annualized even when an option retires inside the horizon. |
| At a Time | - | 0 | >= 0 | Number of years solved in each step of LT Plan. |
| Block Count | - | 12 | >= 1 | Number of load duration curve blocks in each day/week/month. |
| Bridge Constraints | Yes/No | -1 | In (0,-1) | If LT Plan should bridge (decompose) constraints for subsequent simulation phases. |
| Bridge Storage | Yes/No | -1 | In (0,-1) | If LT Plan should bridge (decompose) storage for subsequent simulation phases. |
| Capacity Payments Enabled | Yes/No | 0 | In (0,-1) | If payments are made for generation capacity. |
| Chronology | - | 2 | In (2,3,4) | Type of chronology used. |
| Co-optimize Unit Commitment | Yes/No | 0 | In (0,-1) | If unit commitment is co-optimized rather than sequentially optimized with expansion. |
| Compute Multi-area Reliability Indices | Yes/No | 0 | In (0,-1) | Master switch for computation of reliability indices LOLP, LOLE, etc across multiple areas. |
| Compute Reliability Indices | Yes/No | 0 | In (0,-1) | Master switch for computation of reliability indices LOLP, LOLE, etc. |
| Decomposition | - | 1 | >= 1 | Reduce the number of simulated periods by this factor in the first pass of a two-pass decomposition. |
| Depreciation Method | - | 0 | In (0,1,2) | Depreciation method for computing annuities. |
| Discount Period Type | - | 4 | In (1,2,3,4,6,7) | A unique discount factor and expansion decisions will be computed for each of these periods. |
| Discount Rate | % | 0 | >= 0 | Discount rate. |
| End Effects Method | - | 1 | In (0,1) | Method used to account for end of horizon effects. |
| Inflation Rate | % | 0 | | Inflation rate used in depreciation calculations. |
| Integerization Horizon | yr | -1 | >= -1 | Number of years over which the expansion decisions are integerized. |
| Last Block Count | - | 0 | >= 0 | Number of load duration curve blocks in the last load duration curve of the horizon, or zero if same as Block Count. |
| LDC Pin Bottom | - | -1 | >= -1 | Number of points at the bottom of the LDC that are pinned and cannot be aggregated into blocks. |
| LDC Pin Top | - | -1 | >= -1 | Number of points at the top of the LDC that are pinned and cannot be aggregated into blocks. |
| LDC Slicing Method | - | 0 | In (0,1) | Method used to slice the LDC into blocks. |
| LDC Type | - | 3 | In (1,2,3,4,7) | One LDC is created for each period of this type in horizon. |
| LDC Weight a | - | 0 | | LDC weighting polynomial function 'a' parameter. |
| LDC Weight b | - | 1 | | LDC weighting polynomial function 'b' parameter. |
| LDC Weight c | - | 0 | | LDC weighting polynomial function 'c' parameter. |
| LDC Weight d | - | 0 | | LDC weighting polynomial function 'd' parameter. |
| Limit Capital Cost Perpetuity by Economic Life | - | -1 | In (0,-1) | With perpetuity end effect, if annuity calculation should extend beyond the end of the horizon up to the Economic Life. |
| Maintenance Rate Output Basis | - | 0 | In (0,1) | Basis for Maintenance Rate (%) Output due to Maintenance Sculpting. |
| Maintenance Sculpting | Yes/No | 0 | In (0,-1) | If LT Plan should sculpt maintenance derating according to the inverse of load. |
| Optimality | - | 2 | In (0,1,2) | LT Plan integerization scheme. |
| Optimize Expansion | Yes/No | -1 | In (0,-1) | If expansion is optimized by this simulation phase. |
| Outage Increment | MW | 10 | >= 1 | Generator outage bin size in convolution. |
| Overlap | - | 0 | >= -1 | Number of years overlap between steps where -1 invokes Rolling Horizon. |
| Pricing Method | - | 0 | In (0,1) | Type of generator pricing used in LT Plan. |
| Reduced Sample Count | - | 4 | >= 1 | Statistically reduce the Sample Type periods to at most this number of samples each year. |
| Reduction Relative Accuracy | - | 1 | Between 0 And 1 | Stop sample reduction when the accuracy of the reduced sample set reaches this level. |
| Sample Type | - | 2 | In (1,2,3,4) | For Chronology = Sampled, take this type of sample. |
| Sample Year Count | - | 0 | >= 0 | For Chronology = Sampled, first select this many years then sample within only those years. |
| Sampled Block Count | - | 0 | >= 0 | Number of blocks modeled in each sample period (day/week) where zero means the original number of intervals. |
| Sampled Shallow Storage Cutoff | h | 0 | >= 0 | For Chronology = Sampled and Sampled Shallow Storage Treatment = Custom, maximum storage duration in hours for shallow storage formulation. |
| Sampled Shallow Storage Treatment | - | 1 | In (1,2,3) | For Chronology = Sampled, method used for formulating low duration storages and batteries. |
| Sampling Interval | - | 4 | In (-1,2,3,4,7) | For Chronology = Sampled, take Sample Type samples in each of these intervals of time. |
| Solution Count | - | 1 | >= 1 | Maximum number of solutions produced in the solution hierarchy. |
| Solution Quality | % | 0 | Between 0 And 100 | Continue producing solutions up to Solution Count or when Solution Quality falls to this level. |
| Start Cost Amortization Period | h | 0 | >= 0 | Number of hours over which generator start costs are amortized. |
| Stochastic Method | - | 0 | In (0,1,2,3) | Stochastic optimization method for LT Plan. |
| Storage Formulate Head Effects | Yes/No | -1 | In (0,-1) | If storage head effects should be formulated in LT Plan. |
| Storage Restart | Yes/No | 0 | In (0,-1) | If recycled storage should restart from their initial volume at the start of each capacity optimization period. |
| Tax Rate | % | 0 | | Tax rate used to compute tax credits. |
| Use Effective Load Approach | Yes/No | 0 | In (0,-1) | If LT Plan uses the effective load approach. |
| Write Expansion Plan Text Files | Yes/No | 0 | In (0,-1) | If expansion plans should be written to text files. |
Loading
Loading