Skip to content

Generate Reports And Figures

Reports and figures should be generated by project workflows or package entrypoints, not by ad hoc notebook state.

Demo Project Outputs

Run:

uv run gridalyn project run projects/minimal_grid_project

Then inspect:

projects/minimal_grid_project/outputs/reports/
projects/minimal_grid_project/outputs/figures/
projects/minimal_grid_project/outputs/manifests/

The run manifest records which stages executed and which artifacts were written.

Shared Digital Twin Reports

Some reports are shared across applications and are written under instances/default/digital_twin/reports/. Use the reporting entrypoint when refreshing those contracts:

uv run python -m gridalyn.interfaces.reporting.digital_twin

Rules

  • Figures belong to the project that generated them.
  • JSON reports are the stable contract for dashboards and reproducibility.
  • External presentation or publication material should reference project outputs rather than own separate runtime logic.
  • Large regenerated artifacts should not be committed unless the artifact policy explicitly allows them.

See Reports and Artifact Policy.