Skip to content

Make provenance in seasonal snapshots consistent with forecast and real-time #261

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
aidan-short-gevernova wants to merge 4 commits into
base: 1.0
Choose a base branch
from
Open

Make provenance in seasonal snapshots consistent with forecast and real-time #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
69b7c46
Move seasonal snapshot provenance to separate array
aidan-short-gevernova Feb 28, 2026
78821ab
Add custom seasonal snapshot header types
aidan-short-gevernova Feb 28, 2026
7344c03
Update seasonal snapshot examples
aidan-short-gevernova Feb 28, 2026
1170ccf
Remove old seasonal snapshot schemas
aidan-short-gevernova Feb 28, 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
30 changes: 16 additions & 14 deletions docs/_spec/components/schemas/array-max-monitored-elements.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,36 +508,38 @@ seasonal-ratings-proposal-status:
seasonal-ratings-snapshot: &seasonal-rating-snapshot
type: object
description: A snapshot of the seasonal ratings for a monitoring set.
properties:
properties: &seasonal-rating-snapshot-props
snapshot-header:
$ref: ./headers.yaml#/common-header
$ref: ./headers.yaml#/seasonal-snapshot-header
ratings:
<<: *max
description: Set of seasonal ratings
items:
$ref: ./array-max-seasons.yaml#/seasonal-rating-snapshot-item
required:
- snapshot-header
- ratings

seasonal-ratings-snapshot-detailed:
seasonal-ratings-snapshot-detailed: &seasonal-rating-snapshot-detailed
<<: *seasonal-rating-snapshot
description: A snapshot of the seasonal ratings for a monitoring set.
properties:
snapshot-header:
$ref: ./headers.yaml#/common-header
ratings:
properties: &seasonal-rating-snapshot-detailed-props
<<: *seasonal-rating-snapshot-props
provenance:
<<: *max
description: Set of seasonal ratings provenance information
items:
$ref: ./array-max-seasons.yaml#/seasonal-rating-snapshot-item-detailed
$ref: './array-max-seasons.yaml#/seasonal-rating-snapshot-provenance-item'
required:
- snapshot-header
- ratings
- provenance

seasonal-ratings-snapshot-detailed-elide-psr:
<<: *seasonal-rating-snapshot
description: A snapshot of the seasonal ratings for a monitoring set.
<<: *seasonal-rating-snapshot-detailed
properties:
<<: *seasonal-rating-snapshot-detailed-props
snapshot-header:
$ref: ./headers.yaml#/base-header
ratings:
$ref: "#/seasonal-ratings-snapshot-detailed/properties/ratings"
$ref: ./headers.yaml#/seasonal-snapshot-header-elide-psr

temporary-aar-exception-set:
type: array
Expand Down
11 changes: 6 additions & 5 deletions docs/_spec/components/schemas/array-max-seasons.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,13 @@ seasonal-rating-snapshot-item:
items:
$ref: './period-limit.yaml#/seasonal-snapshot'

seasonal-rating-snapshot-item-detailed:
seasonal-rating-snapshot-provenance-item:
type: object
additionalProperties: false
properties:
resource-id: *id
periods:
<<: *schedule
items:
$ref: './period-limit.yaml#/seasonal-snapshot-detailed'
proposals-considered:
$ref: './period-limit.yaml#/seasonal-proposals-considered'
required:
- resource-id
- proposals-considered
10 changes: 10 additions & 0 deletions docs/_spec/components/schemas/headers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,13 @@ seasonal-proposal-header-slim:
- default-emergency-durations
- power-system-resources
- default-seasonal-schedule

seasonal-snapshot-header:
<<: *common-header
description: Details about the snapshot provided by the Clearinghouse provider.

seasonal-snapshot-header-elide-psr:
<<: *base-header
description: |
Details about the snapshot provided by the Clearinghouse provider. The
`power-system-resources` property is omitted from this header.
34 changes: 11 additions & 23 deletions docs/_spec/components/schemas/period-limit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ seasonal-proposal-slim:
`[normal_MVA, emergency_MVA]`, we would have `[normal_MW, normal_pf,
emergency_MW, emergency_pf]`, e.g., `[300, 1.0, 350, 1.0]`.

seasonal-snapshot: &seasonal-snapshot
seasonal-snapshot:
<<: *forecast-snapshot
description: Proposes the continuous and emergency ratings for the specified Season.
title: Seasonal Rating Proposal
Expand All @@ -212,29 +212,17 @@ seasonal-proposal-considered:
required:
- source
- resource-id

seasonal-snapshot-detailed:
<<: *seasonal-snapshot
description: Proposes the continuous and emergency ratings for the specified Season.
title: Seasonal Rating Proposal
properties:
<<: *seasonal-snapshot-props
proposals-considered:
description: |

The seasonal ratings proposals considered when determining the
seasonal ratings of a power system resource, e.g., a line or
transformer.

type: array
minItems: 1
maxItems: 10
items:
$ref: '#/seasonal-proposal-considered'
required:
- proposals-considered
- period-start
- period-end
- continuous-operating-limit
- emergency-operating-limits
additionalProperties: false

seasonal-proposals-considered:
description: |
The proposals considered when determining the
seasonal ratings of a power system resource, e.g., a line or
transformer.
type: array
maxItems: 48 # 12 periods * 4 proposals per period
items:
$ref: '#/seasonal-proposal-considered'
73 changes: 39 additions & 34 deletions docs/example-narratives/examples/seasonal-ratings-snapshot-detailed-elide-psr.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,41 +50,46 @@
"mva": 180
}
}
],
"proposals-considered": [
]
}
]
}
],
"provenance":[
{
"resource-id": "8badf00d",
"proposals-considered": [
{
"resource-id": "8badf00d-UTILITY-A-SEG-id",
"period-start": "2024-04-01T01:00:00Z",
"period-end": "2024-07-01T01:00:00Z",
"source": {
"provider": "UTILITY-A",
"last-updated": "2023-07-12T16:00:00-07:00",
"origin-id": "8badf00d-UTILITY-A-correlation-id"
},
"season-name": "spring",
"continuous-operating-limit": {
"mva": 160
},
"emergency-operating-limits": [
{
"duration-name": "LTE",
"limit": {
"mva": 165
}
},
{
"resource-id": "8badf00d",
"period-start": "2024-04-01T01:00:00Z",
"period-end": "2024-07-01T01:00:00Z",
"source": {
"provider": "X-AMPL",
"last-updated": "2023-07-12T16:00:00-07:00",
"origin-id": "//trolie.example.com/snapshots/2024-08-05T11%3a00%3a00-07%3a00"
},
"season-name": "spring",
"continuous-operating-limit": {
"mva": 160
},
"emergency-operating-limits": [
{
"duration-name": "LTE",
"limit": {
"mva": 165
}
},
{
"duration-name": "STE",
"limit": {
"mva": 170
}
},
{
"duration-name": "DAL",
"limit": {
"mva": 180
}
}
]
"duration-name": "STE",
"limit": {
"mva": 170
}
},
{
"duration-name": "DAL",
"limit": {
"mva": 180
}
}
]
}
Expand Down
73 changes: 39 additions & 34 deletions docs/example-narratives/examples/seasonal-ratings-snapshot-detailed.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,41 +66,46 @@
"mva": 180
}
}
],
"proposals-considered": [
]
}
]
}
],
"provenance":[
{
"resource-id": "8badf00d",
"proposals-considered": [
{
"resource-id": "8badf00d-UTILITY-A-SEG-id",
"period-start": "2024-04-01T01:00:00Z",
"period-end": "2024-07-01T01:00:00Z",
"source": {
"provider": "UTILITY-A",
"last-updated": "2023-07-12T16:00:00-07:00",
"origin-id": "8badf00d-UTILITY-A-correlation-id"
},
"season-name": "spring",
"continuous-operating-limit": {
"mva": 160
},
"emergency-operating-limits": [
{
"duration-name": "LTE",
"limit": {
"mva": 165
}
},
{
"resource-id": "8badf00d",
"period-start": "2024-04-01T01:00:00Z",
"period-end": "2024-07-01T01:00:00Z",
"source": {
"provider": "X-AMPL",
"last-updated": "2023-07-12T16:00:00-07:00",
"origin-id": "//trolie.example.com/snapshots/2024-08-05T11%3a00%3a00-07%3a00"
},
"season-name": "spring",
"continuous-operating-limit": {
"mva": 160
},
"emergency-operating-limits": [
{
"duration-name": "LTE",
"limit": {
"mva": 165
}
},
{
"duration-name": "STE",
"limit": {
"mva": 170
}
},
{
"duration-name": "DAL",
"limit": {
"mva": 180
}
}
]
"duration-name": "STE",
"limit": {
"mva": 170
}
},
{
"duration-name": "DAL",
"limit": {
"mva": 180
}
}
]
}
Expand Down
Loading