Skip to content

v1.0.0 Documentation #1250

Merged
lkstrp merged 41 commits intomasterfrom
v1-docs
Oct 14, 2025
Merged

v1.0.0 Documentation #1250
lkstrp merged 41 commits intomasterfrom
v1-docs

Conversation

@lkstrp
Copy link
Copy Markdown
Member

@lkstrp lkstrp commented Jun 11, 2025

Closes #290
Closes #979
Closes #580
Closes #398
Closes #1063
Closes #1055
Closes #317
Closes #231
Closes #1277

Link to docs build

This branch is the base branch for all version 1.0 documentation PRs. We wanna keep track of contributions, so this PR will not be squashed, but rebased on the main when merging.

How to contribute

Direct commit

  • Just checkout new-docs and push on here
  • But this branch will be rebased from time to time, so expect diverged branches if you commit directly and push back

Or via new PR with base new-docs

  1. Checkout v1-docs branch (git checkout v1-docs)
  2. Create a new branch for your changes (git switch -c 'docs-changes')
  3. Run uv sync --all-extras to install the dependencies
  4. Run mkdocs serve to see docs locally at http://127.0.0.1:8000/ with live reload
  5. Commit changes, push to remote and create a PR with v1-docs as base

Todos

  • Resolve all TODO comments
  • API:
    • find good way to put multiple modules on one page
    • optimization expressions
    • groupers
    • network collection
    • make internal what should not be exposed
    • Make sure all is exposed
  • User Guide
  • Jupyter Notebooks
    • Fix maths
    • Find way to raise warnings as errors
  • New Illustrations
  • Add caption to all images
  • Fix Markdown and References in Release Notes
  • Fix and activate tests
    • Resolve all missing references (mkdocs serve --strict and then activate in readthedocs)
    • Activate validation warnings in mkdocs.yaml
    • Let all notebooks run through with execution
    • Resolve and Raise Deprecation Warnings in Notebooks
    • Don't allow to fail notebook runs
    • Add Markdown Doctests
    • Add broken links checker
  • REUSE @euronion v1.0.0 documentation: REUSE compatability #1382
  • Revert 59ce790
  • Revert cee728d
  • create user guide for all api sections with corresponding reference
  • change all .rst references to .md
  • change all .rst callouts to .md (also > **Note**)
  • New URL
    • Check all Links reference to new URL
  • Add askguru (already applied)
  • Close all open documentation issues: see here

Before Final Rebase

  • Fix commit authors after rebase
  • Change canonical on readthedocs
  • Remove (en) subdir

After Rebase

  • Change v1-docs references to master
  • Update docs url on landing page
  • Check if all docs <-> Landing page links resolve
  • Add redirects for support with old schema
  • Make sure all go.pypsa.org links resolve

@lkstrp lkstrp marked this pull request as draft June 11, 2025 11:38
@lkstrp lkstrp added this to the v1.0 milestone Jun 16, 2025
@lkstrp lkstrp added the docs Documentation improvements or features to be showcased in docs/ notebook label Jul 24, 2025
@Irieo Irieo mentioned this pull request Sep 2, 2025
11 tasks
@lkstrp lkstrp force-pushed the v1-docs branch 4 times, most recently from 988d1f8 to c7831eb Compare September 25, 2025 11:41
lkstrp and others added 12 commits October 9, 2025 10:52
* rename `doc` -> `docs`

* merge with old docs

* restructure and convert to `.md`

* fix module errors

* fix imported method docstrings for components

* api: components

* add new logos

* add FAQ section

* rename to `.md`

* move example notebooks to docs

* add config and assets

* updated logos

* setup readthedocs

* add graph view

* fix graph view

* added argref for pr links

* add copyright and clean up `CITATION.cff`

* move release-notes

* better header refs

* more docs, formatting, added hook and handle dynamic docstrings

* remove placeholder

* rename old doc files

* restructure network components attributes and methods

* restructure descriptors and more docs

* wip

* chore: make `n.model`/`n.objective`/`n.objective_constant` read-only attributes

* fix: types

* fix: tests

* docs: finalize draft

* fix: types

* fix: `pf.logger` access

* docs: move file to new `.md` path

* docs: rename files

* fix: docs build warnings

docs: more settings fine tuning

fix: install PyPSA from `new-opt` branch
clean opf doc

add docs for stochastic opt

fix: formatting math form
fix: solve doc warning problems and enable notebook build

docs: make stoch example compatible with 5e892ad

fix: now, compatible

docs: improve theoretical foundation of SP, reference Birge 1982

docs: make docs compatible with 401f641

docs: update scaling properties in stoch opt docs
fix: execute notebooks

fix: typos
* add example notebook showcasing new MGA functionality

* expand the user guide section on MGA

* Don't log optimizer output to console

Reduces visual noise in notebook cell outputs

* fix: conflict

---------

Co-authored-by: lkstrp <[email protected]>
* revise electricity market example

* revise screening curve example

* revise electric vehicle example

* revise carbon management example

* remove capacity constraint per bus example

* revise chained hydro example

* revise transformer example

* revise redispatch example

* revise redispatch example

* revise islanded fuel production example

* revise unit commitment example

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* revise CHP examples

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* revise heat pump / thermal storage example

* remove duplicated lopf-with-heating example

* revise storage_unit vs link/store example

* revise power flow example

* revise AC-DC meshed example

* revise basic MGA example

* revise SCLOPF example

* revise SciGRID example

* revise sector-coupling example

* revise pathway example

* remove accidental file addition

* pre-commit fixes

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* add modular expansion example

* pre-commit fixes
* add demand elasticity example

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Created negative prices due to KVL/congestion example based on Kyri Baker's 3 node grid

* minor adjustments

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixed small typo ($)

---------

Co-authored-by: Fabian Neumann <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@lkstrp lkstrp force-pushed the v1-docs branch 3 times, most recently from 122698e to f0933ad Compare October 13, 2025 08:50
lkstrp and others added 19 commits October 13, 2025 22:17
…ed) (#1376)

* Finalised explore docs.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Restructured plotting sections.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* fix: gc for primary energy in myopic pathway

* Disable allow_errors for mkdocs-jupyter

---------

Co-authored-by: Lukas Trippe <[email protected]>
* YoTwo's licence magic

* add badge

* get the badge

* fix: code of conduct

* add to docs footer

* fix: fatal formatting issue

---------

Co-authored-by: lkstrp <[email protected]>
Added text related to Excel i/o.

Co-authored-by: lkstrp <[email protected]>
@lkstrp lkstrp marked this pull request as ready for review October 13, 2025 20:22
@lkstrp lkstrp merged commit 8b164a2 into master Oct 14, 2025
20 of 22 checks passed
@lkstrp lkstrp deleted the v1-docs branch October 14, 2025 06:57
lkstrp added a commit that referenced this pull request Oct 14, 2025
@FabianHofmann
Copy link
Copy Markdown
Contributor

🚀 !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment