Skip to content

docs(pypsa): a single spec covers every pypsa model class and component #620

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

Closed
FabianHofmann wants to merge 48 commits into from
Closed

docs(pypsa): a single spec covers every pypsa model class and component #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
92cbd80
docs(pypsa): a single file covers the standard, stochastic and multi-…
FabianHofmann Sep 22, 2026
f1ea95b
docs(pypsa): the spec covers the process and transformer components
FabianHofmann Sep 22, 2026
4c042cd
docs(pypsa): the spec covers quadratic marginal cost
FabianHofmann Sep 22, 2026
dc0ec06
docs(pypsa): the spec covers transmission losses
FabianHofmann Sep 22, 2026
02c5974
docs(pypsa): the spec covers the secant loss mode
FabianHofmann Sep 22, 2026
0ce8247
docs(pypsa): the secant loss mode carries a solved reference
FabianHofmann Sep 22, 2026
b0fba21
docs(pypsa): the spec covers the optimised transformer phase shift
FabianHofmann Sep 22, 2026
c125c56
docs(pypsa): the carrier growth limit binds every extendable component
FabianHofmann Sep 23, 2026
28926f0
docs(pypsa): the spec covers transformer transmission losses
FabianHofmann Sep 23, 2026
cdcc041
docs(pypsa): a committable unit serving its brought-in down time stay…
FabianHofmann Sep 23, 2026
a4baa2c
docs(pypsa): a committable link carries the generator's unit commitment
FabianHofmann Sep 23, 2026
6da41d9
docs(pypsa): a committable process carries the generator's unit commi…
FabianHofmann Sep 23, 2026
4f67f53
docs(pypsa): a ramp row follows pypsa for a modular committed build a…
FabianHofmann Sep 23, 2026
805d480
docs(pypsa): storage cycles or reopens per investment period, and a r…
FabianHofmann Sep 23, 2026
2a7d5e9
docs(pypsa): a security-constrained run limits every branch flow afte…
FabianHofmann Sep 23, 2026
5109686
docs(pypsa): an mga flag caps the system cost at a budget and minimis…
FabianHofmann Sep 23, 2026
3151519
docs(pypsa): mga leaves the standard spec until it can land as a patc…
FabianHofmann Sep 23, 2026
3f5192a
docs(pypsa): a storage built in a later period opens at its first act…
FabianHofmann Sep 23, 2026
5d0cb9f
Merge remote-tracking branch 'origin/main' into pypsa-complete
FabianHofmann Sep 24, 2026
f0e167b
docs(pypsa): a unit may be scheduled off for maintenance
FabianHofmann Sep 24, 2026
eec71d2
docs(pypsa): the spec states what maintenance and late-opening storag…
FabianHofmann Sep 24, 2026
64b50d0
docs(pypsa): a growth limit counts no transformer, as pypsa does
FabianHofmann Sep 24, 2026
76c5c24
docs(pypsa): a global constraint may count one investment period, wei…
FabianHofmann Sep 24, 2026
510b567
docs(pypsa): a process, a storage unit and a store may carry a quadra…
FabianHofmann Sep 24, 2026
a0777a4
docs(pypsa): a store's power and a storage unit's dispatch and chargi…
FabianHofmann Sep 24, 2026
d964649
docs(pypsa): a link's and a process's delay applies within each inves…
FabianHofmann Sep 24, 2026
c1fec47
docs(pypsa): a negative relative growth adds nothing to a carrier's g…
FabianHofmann Sep 24, 2026
49a8fbd
docs(pypsa): a tech capacity expansion limit on a network with severa…
FabianHofmann Sep 24, 2026
0f578c7
docs(pypsa): the carrier growth rung says a transformer counts in no …
FabianHofmann Sep 24, 2026
6bfa052
docs(pypsa): a global constraint takes its own constant and sense in …
FabianHofmann Sep 24, 2026
0db274a
docs(pypsa): the stochastic rung says which component data spans a sc…
FabianHofmann Sep 24, 2026
e52b90d
docs(pypsa): component data spans a scenario wherever pypsa reads it …
FabianHofmann Sep 24, 2026
15c2f43
docs(pypsa): a component's sign turns its term in the bus balance around
FabianHofmann Sep 25, 2026
49c9e85
docs(pypsa): the linearized commitment file keeps a unit down, ramps …
FabianHofmann Sep 25, 2026
19b1992
docs(pypsa): a ramp limit may change over time and lift at a snapshot
FabianHofmann Sep 25, 2026
d5b4e75
docs(pypsa): a unit that came in running ramps from its p_init into t…
FabianHofmann Sep 25, 2026
9998ede
docs(pypsa): the relaxed commitment file ramps every generator per sn…
FabianHofmann Sep 25, 2026
9270a71
docs(pypsa): a start and a stop cost what they cost, with no snapshot…
FabianHofmann Sep 25, 2026
e2410a5
docs(pypsa): a growth limit binds only under multi_investment_periods
FabianHofmann Sep 25, 2026
98e8297
docs(pypsa): a load that is not active draws nothing from its bus
FabianHofmann Sep 25, 2026
9bfb210
docs(pypsa): a security-constrained run dissipates no transmission loss
FabianHofmann Sep 25, 2026
85217ff
Merge remote-tracking branch 'origin/main' into pypsa-complete
FabianHofmann Sep 25, 2026
5bb1336
docs: the changelog lists the pypsa spec that covers every model clas…
FabianHofmann Sep 25, 2026
348d925
docs(pypsa): a growth limit counts an asset only in the first period …
FabianHofmann Sep 25, 2026
80a378e
docs(pypsa): a transmission cost or volume limit holds in every scenario
FabianHofmann Sep 25, 2026
f3e4211
docs(pypsa): each scenario delays a link's and a process's flow by it…
FabianHofmann Sep 25, 2026
720275c
docs(pypsa): transformer cycles, security-constrained runs, fixed bui…
FabianHofmann Sep 25, 2026
60c279e
docs(pypsa): the first-snapshot ramp refusals link the open PyPSA que…
FabianHofmann Sep 25, 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
4 changes: 0 additions & 4 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,7 @@ docs/examples/dispatch.md
docs/examples/commitment.md
docs/examples/operators.md
docs/examples/pypsa.md
docs/examples/pypsa_quadratic.md
docs/examples/pypsa_linearized_uc.md
docs/examples/pypsa_losses.md
docs/examples/pypsa_stochastic.md
docs/examples/pypsa_multi_period.md

# The PyPSA reference scripts write this file; prettier would reformat what
# they stamp, and the two would fight over it exactly as above.
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ it releases that version ([RELEASING.md](https://github.com/energy-models/mathsp

## Upcoming version

- docs(pypsa): a single spec covers every pypsa model class and component ([#620](https://github.com/energy-models/mathspec/pull/620))

## 0.1.0rc1 (2026-09-25)

The release candidate for 0.1.0, the first release on PyPI:
Expand Down
10,491 changes: 9,073 additions & 1,418 deletions docs/examples/pypsa.md
View file
Open in desktop

Large diffs are not rendered by default.

699 changes: 637 additions & 62 deletions docs/examples/pypsa_linearized_uc.md
View file
Open in desktop

Large diffs are not rendered by default.

426 changes: 0 additions & 426 deletions docs/examples/pypsa_losses.md
View file
Open in desktop

This file was deleted.

372 changes: 0 additions & 372 deletions docs/examples/pypsa_multi_period.md
View file
Open in desktop

This file was deleted.

217 changes: 0 additions & 217 deletions docs/examples/pypsa_quadratic.md
View file
Open in desktop

This file was deleted.

Loading