docs(pypsa): the pypsa spec names its repeated row conditions as masks, and its topic files read them under given: masks:

[FBumann]

Prompt: Lets add this as a feature, and leverage it in the pypsa examples etc! … Push it

Note

The following content was generated by AI.

examples/pypsa.yaml names 16 row conditions it wrote out at every row as masks. They replace parts of 165 where strings, and no row changes. The topic files read them under given: masks:. Stacked on #821.

# before: one of six ramp rows per committable class
where: >-
  Generator_committable AND Generator_p_nom_extendable AND NOT (Generator_p_nom_mod > 0)
  AND (Generator_ramp_limit_up OR Generator_ramp_limit_start_up)
  AND (position(snapshot, by=snapshot_period, within=period) > 0 OR (position(snapshot) == 0 AND (Generator_status_initial == 0 OR Generator_p_init)))
  AND Generator_active
# after
where: >-
  Generator_com_ext
  AND (Generator_ramp_limit_up OR Generator_ramp_limit_start_up)
  AND Generator_ramps_from_previous

The masks, the equivalence check, gate output, what is not done

The masks

Each one is named after the PyPSA row class it selects. "Uses" counts the sites that read it.

Mask	Body	Uses
C_committed (C = Generator, Link, Process)	C_committable AND C_active	26 each
C_com_ext	committable, extendable, not modular, active (PyPSA's com-ext rows)	8 each
C_maint_ext	maintainable, extendable, not committable and modular, active	5 each
C_ramps_from_previous	a snapshot whose ramp reads a previous output	6 each
StorageUnit_fix, StorageUnit_ext	fixed or extendable build, active	6 each
Line_lossy, Transformer_lossy	transmission_losses AND C_active	4 each

The symbol table spells them in the file's style: \mathrm{on}^{qualifier} with the class letter, and \mathrm{prev} for the ramp masks.

Equivalence

I loaded the file before and after. I expanded each mask into its predicate and compared the flattened conjunct sets of every where. All 352 declarations and every cased expression's regions match.

The split

• tools/pypsa_split.py puts each mask in the topic its name names. Model.frames() reads mask frames, so a topic that reads another topic's mask states it under given: masks: with that frame. For example, generator_ramping reads Generator_com_ext from generator_commitment.
• tools/gallery.py includes masks and given masks in each page's symbol cut. The gallery is regenerated.

Gates

• pixi run lint: clean.
• pixi run test: 2662 passed.
• pixi run python -m tools.pypsa_split check examples/pypsa: "24/24 fragments load alone", "the merged fragments and the one file have one canonical form".
• Not run: compile-tex, because the tectonic bundle does not download here, and this PR touches examples/. docs-build, because the proxy blocks an inventory fetch. CI runs both.

Not done

• Generator_active and its siblings stay bool data parameters. docs(pypsa): the generator spec declares PyPSA's generator attributes and derives its period, cost and commitment data from them #802 derives them from build year and lifetime, and that changes what the data supplies.
• A condition used only once or twice stays written out.
• The library and Calliope examples are unchanged.

🤖 Generated with Claude Code

https://claude.ai/code/session_01PBmqeqBrqpQC6MVoSrguHK

[read-the-docs-community]

Documentation build overview

📚 mathspec | 🛠️ Build #34881291 | 📁 Comparing 48bd4dc against latest (34c68fd)

  🔍 Preview build  

27 files changed · ± 27 modified

± Modified

• changelog/index.html
• howto/compose/index.html
• reference/api/index.html
• reference/language/index.html
• reference/notation/index.html
• reference/program/index.html
• reference/reading/index.html
• reference/typeset/index.html
• examples/pypsa/generator/index.html
• examples/pypsa/generator_commitment/index.html
• and 17 more...