Conversation
3 tasks
39 tasks
988d1f8 to
c7831eb
Compare
* 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: 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>
122698e to
f0933ad
Compare
…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]>
Contributor
|
🚀 !! |
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
new-docsand push on hereOr via new PR with base
new-docsv1-docsbranch (git checkout v1-docs)git switch -c 'docs-changes')uv sync --all-extrasto install the dependenciesmkdocs serveto see docs locally athttp://127.0.0.1:8000/with live reloadv1-docsas baseTodos
TODOcommentsmkdocs serve --strictand then activate in readthedocs)Add broken links checker.rstreferences to.md.rstcallouts to.md(also> **Note**)Before Final Rebase
canonicalon readthedocsen) subdirAfter Rebase
v1-docsreferences to mastergo.pypsa.orglinks resolve