Skip to content

Prepare template documents for furo style docs #1131

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.

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

Merged
merged 268 commits into from
Jun 3, 2025
Merged
Show file tree
Hide file tree
Changes from 103 commits
Commits
Show all changes
268 commits
Select commit Hold shift + click to select a range
4f7ef57
Add basic conecpt of flows file.
jfreissmann Nov 22, 2024
04b78a6
Add basic conecpt of components file.
jfreissmann Nov 22, 2024
d312cca
Add overview of basic concepts.
jfreissmann Nov 22, 2024
6c544c2
Clean up some old files and update names
fwitte Nov 22, 2024
0025923
Make figure paths absolute
fwitte Nov 22, 2024
52aab71
Add showcase.rst
maltefritz Nov 22, 2024
0a4fd2b
Merge remote-tracking branch 'jfreissmann/docs/make-style-modern' int…
fwitte Nov 22, 2024
a1f180a
Check in missing single file toc elements for new structure
fwitte Nov 22, 2024
381f006
Add darkmode image of extraction turbine.
maltefritz Nov 22, 2024
e5afeef
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
maltefritz Nov 22, 2024
f2d5c87
Add pages for introductory tutorials
paulapreuss Nov 22, 2024
021f9fb
Add introductory tutorials overview page
paulapreuss Nov 22, 2024
1f1dfa5
Add a support template
fwitte Nov 22, 2024
c11193a
Merge remote-tracking branch 'paula/docs/make-style-modern' into docs…
fwitte Nov 22, 2024
477ad5e
Fix internal reference to building blocks
fwitte Nov 22, 2024
e17605a
Merge remote-tracking branch 'mfritz/docs/make-style-modern' into doc…
fwitte Nov 22, 2024
1ddd75d
Fix typo
fwitte Nov 22, 2024
f3218f0
Add structure for advanced tutorials in docs
pranaykasturi Nov 22, 2024
e2f31ee
Merge remote-tracking branch 'pranay/docs/make-style-modern' into doc…
fwitte Nov 22, 2024
bb03ce3
Add oemof_solph_example_darkmode.svg to docs
srhbrnds Nov 22, 2024
f14e583
Make installation page look nice
fwitte Nov 24, 2024
51cd2d6
Fix typos
fwitte Nov 24, 2024
8fa7a62
Refactor the landing page to make it more compact for faster orientation
fwitte Nov 24, 2024
e470517
Add a boilerplate concept for one of the tutorials
fwitte Nov 25, 2024
0b0f8f9
Remove unused toxenv
fwitte Nov 27, 2024
e961bbe
Make tox pull requirements from extra dependency [dev]
fwitte Nov 27, 2024
bb96a45
Add draft table of contents for district heating example
fwitte Dec 9, 2024
5a4aca4
Finalize drafting structure
fwitte Dec 9, 2024
6fc9764
Add a note, that heat storage capacity will be dimensioned ad-hoc
fwitte Dec 9, 2024
5511b16
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
maltefritz Dec 9, 2024
6adce92
Add district heating supply tutorial step 1.
maltefritz Dec 9, 2024
165b0ea
Ad stub for the EV charging tutorial.
p-snft Jan 7, 2025
714aa71
Add a couple of example lines to the tutoriakl
fwitte Jan 9, 2025
f09f679
Rename file
fwitte Jan 9, 2025
9a0fc31
Fix links
fwitte Jan 9, 2025
578efeb
Update label
fwitte Jan 9, 2025
a9e0b3c
add unidirectional loading
AntonellaGia Jan 11, 2025
22e83e1
unidirectional loading
AntonellaGia Jan 11, 2025
45dacd2
add example unidirectional loading at home
AntonellaGia Jan 12, 2025
6b76d50
Merge dev into docs/make-style-modern
fwitte Jan 14, 2025
f5c2e3f
Merge branch 'dev' into docs/make-style-modern
p-snft Jan 14, 2025
2c1bbb2
Merge branch 'docs/make-style-modern' into feature/EV_Tutorial
p-snft Jan 14, 2025
f6f7e91
Adhere to Black
p-snft Jan 14, 2025
17c1854
Move ev tutorial to tutorial directory
p-snft Jan 14, 2025
db6b401
Include tutorials in pyproject.toml
p-snft Jan 14, 2025
f7e5105
Clearify docstring of GenericStorage
p-snft Jan 14, 2025
ed35604
Start restructuring EV tutorial
p-snft Jan 14, 2025
69a8b7a
Fix typo in pyproject.toml
p-snft Jan 15, 2025
ca3b7f9
Rename directory tutorial to tutorials
p-snft Jan 15, 2025
d9ccfc5
Add tutorials to pyproject.toml
p-snft Jan 15, 2025
2222118
Apply Black code to doc config
p-snft Jan 15, 2025
9506ed1
Apply Black style to tutorial stubs
p-snft Jan 15, 2025
7fa12cc
Re-add deps for [testenv] in tox.ini
p-snft Jan 15, 2025
fd48a96
Merge branch 'docs/make-style-modern' into feature/EV_Tutorial
p-snft Jan 15, 2025
c49e3a0
Proceed with ev charging example
p-snft Jan 15, 2025
d34ac97
Draft information for the support page
fwitte Jan 15, 2025
060b719
Add two lines of text to the API landing page
fwitte Jan 15, 2025
64bbd17
Continue EV charging tutorial
p-snft Jan 15, 2025
ead6dd7
Introduced balanced battery in EV tutorial
p-snft Jan 15, 2025
715e4c7
Make naming convention for branches consistent
fwitte Jan 16, 2025
95cf0ae
Change the order of locations to get user support
fwitte Jan 16, 2025
3613ec5
Fix inconsistency in evcharging tutorial
p-snft Jan 16, 2025
18c58e2
Fix typo
p-snft Jan 16, 2025
0eb2fbc
add dynamic prices
AntonellaGia Jan 18, 2025
7168172
change comments
AntonellaGia Jan 18, 2025
5836e4d
change docu
AntonellaGia Jan 18, 2025
92ec0ff
black
AntonellaGia Jan 18, 2025
135257e
fixing
AntonellaGia Jan 18, 2025
b7a28cc
fixing flake8
AntonellaGia Jan 18, 2025
66d3576
Refactor variable price example
p-snft Jan 20, 2025
7b4ff42
Adhere to Black
p-snft Jan 20, 2025
4e38bcb
Merge pull request #1153 from oemof/ev_tutorial_variable_costs
p-snft Jan 20, 2025
9cbeaef
Merge branch 'dev' into feature/EV_Tutorial
p-snft Jan 22, 2025
a1fb0ed
Merge branch 'dev' into docs/make-style-modern
p-snft Jan 22, 2025
d7ddfa5
Add postproccesing structure.
maltefritz Feb 24, 2025
b3b2c21
Resolve merge conflicts.
jfreissmann Feb 25, 2025
af743af
Remove unwanted whitespace.
jfreissmann Feb 25, 2025
389ee70
Formulate introduction to dhs tutorial.
jfreissmann Feb 25, 2025
150fc7f
Motivate first step guide best practices.
jfreissmann Feb 25, 2025
bf14a14
Elaborate on existing bullet points.
jfreissmann Feb 25, 2025
2db096d
Move examples index file to top level
fwitte Feb 27, 2025
4e2b1f7
Include the examples overview page in the toc
fwitte Feb 27, 2025
65daced
Only include the version number in the sidebar title below logo
fwitte Feb 27, 2025
84000be
Make a draft showcase example
fwitte Feb 27, 2025
24ca2a6
Move Energy system section to basic examples
Bachibouzouk Feb 27, 2025
73a6985
Move Flows section to basic examples
Bachibouzouk Feb 27, 2025
2bbb09a
Change structure of docs by adding "optimization" section
srhbrnds Feb 27, 2025
bda44ae
Move Buses to basic examples
Bachibouzouk Feb 27, 2025
ece1345
Move Compents to basic examples
Bachibouzouk Feb 27, 2025
cf37033
Move Model to basic examples
Bachibouzouk Feb 27, 2025
81d831d
Move Results to basic examples
Bachibouzouk Feb 27, 2025
9024159
Reorganize the Basic Example menu
Bachibouzouk Feb 27, 2025
8fdeb02
Fix reference to component section in whatsnew
Bachibouzouk Feb 27, 2025
12b2fe9
Add "optimization" section to docs
srhbrnds Feb 27, 2025
e114bba
Replace labels
srhbrnds Feb 27, 2025
50dc974
Adhere to naming convention in dhs tutorial.
jfreissmann Feb 27, 2025
590fb92
Move additional constraints section
fwitte Feb 27, 2025
cbad572
Merge branch 'docs/improve-optimization-section' into docs/make-style…
fwitte Feb 27, 2025
7ef7609
add the section best pratices to the docs and add the first entry (ep…
leroum Feb 27, 2025
0462edb
Merge remote-tracking branch 'origin/docs/oemof-classes' into docs/ma…
fwitte Feb 27, 2025
46b208d
Merge remote-tracking branch 'jfreissmann/docs/make-style-modern' int…
fwitte Feb 27, 2025
53979e5
now really add the section best pratices to the docs and add the firs…
leroum Feb 27, 2025
f810780
Fiy typos and buggy references
srhbrnds Feb 27, 2025
fedf25f
Merge pull request #1165 from oemof/docs/further-improve-optimization…
srhbrnds Feb 27, 2025
0528749
Change Energy System subsection
Bachibouzouk Feb 27, 2025
03da37f
Change Bus subsection
Bachibouzouk Feb 27, 2025
e7714f9
Change Flow subsection
Bachibouzouk Feb 27, 2025
e8fbb25
Change component section description
Bachibouzouk Feb 27, 2025
0f80ea9
Change model optimization description
Bachibouzouk Feb 27, 2025
3caa7f7
Move the easy access subsection to the top of results section
Bachibouzouk Feb 27, 2025
9c0a1f6
separate code
AntonellaGia Feb 27, 2025
f07e2f4
Merge pull request #1166 from oemof/docs/improve-basic-concepts-section
Bachibouzouk Feb 27, 2025
eeb610b
Fix reference name for rst interlinks
Bachibouzouk Feb 27, 2025
46ee900
Fix underline title
Bachibouzouk Feb 27, 2025
652f4e5
Merge pull request #1164 from leroum/docs/best_practice
fwitte Feb 28, 2025
7a97239
adding figures and description of tutorial
AntonellaGia Feb 28, 2025
fb16de4
black
AntonellaGia Feb 28, 2025
f1fe88d
isort and black
AntonellaGia Feb 28, 2025
e23539a
adding figures and add docu of tutorial
AntonellaGia Feb 28, 2025
0a87cc4
tipo
AntonellaGia Feb 28, 2025
55b5f32
add second step of ev
AntonellaGia Feb 28, 2025
000425e
added grid icons for several sections
leroum Feb 28, 2025
a436d53
fix figures and adding description
AntonellaGia Feb 28, 2025
cc283c7
add tutorial
AntonellaGia Feb 28, 2025
9e3163d
update figures adding legends
AntonellaGia Feb 28, 2025
d6fbf52
cleaned up the code to generate the icons
leroum Mar 3, 2025
be553bd
heatpump, power grid and heat demand icon exchanded for invertable an…
leroum Mar 3, 2025
75dcacb
deleted two svgs which were not needed
leroum Mar 3, 2025
5368491
Save corrent status
maltefritz Mar 6, 2025
e293f57
Add explanation for results extraction.
jfreissmann Mar 6, 2025
764916a
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
jfreissmann Mar 25, 2025
ded4097
Resolve merge conflict.
maltefritz Mar 25, 2025
7c57510
Add input data for dhs tutorial.
maltefritz Mar 25, 2025
c5cf3ae
Update input data.
maltefritz Mar 25, 2025
0e7a0b1
Save current status of dhs tutorial.
maltefritz Mar 25, 2025
86f4288
Switch order of result exploration.
jfreissmann Mar 25, 2025
122f483
Add result plot and explanation.
jfreissmann Mar 25, 2025
1a56fb3
Add LCOH description and calculation.
jfreissmann Mar 25, 2025
64a98d5
Improve dispatch plot and add darkmode option.
jfreissmann Apr 4, 2025
7533ffe
Add svg files of dispatch plots.
jfreissmann Apr 4, 2025
8a5d4f5
Incorporate svg plots in dhs tutorial.
jfreissmann Apr 4, 2025
5d35b44
Fix typos in Learning of 1st step of dhs tutorial.
jfreissmann Apr 4, 2025
288bc56
Finish first step of dhs tutorial.
jfreissmann Apr 4, 2025
0854f3b
Merge branch 'dev' into docs/make-style-modern
p-snft Apr 4, 2025
2e841ef
Merge branch 'docs/make-style-modern' into feature/EV_Tutorial
p-snft Apr 29, 2025
8179827
Adhere to Black
p-snft Apr 29, 2025
410ba4f
Merge pull request #1150 from oemof/feature/EV_Tutorial
p-snft Apr 29, 2025
faea17f
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
p-snft Apr 30, 2025
624b0e4
Move all tutorials to tutorials/ dir
p-snft Apr 30, 2025
92a6292
Fix outdated doc statements
p-snft Apr 30, 2025
e52ef0e
Add time series for PV tutorial
p-snft Apr 30, 2025
21142db
Fix storage costs for non-invest storage
p-snft Apr 30, 2025
f6aa234
Add plt.show() to EV examples
p-snft May 6, 2025
f4a25c1
Remove outdated EV demand stub
p-snft May 6, 2025
b7f4a48
Explicitly choose solver in EV tutorial
p-snft May 6, 2025
dbe5bef
Remove EV charging tutorial using functions
p-snft May 6, 2025
797106c
Add proper index to home pv beginers tutorial
p-snft May 7, 2025
cd3635f
Merge pull request #1167 from oemof/docs/fix-reference-warnings
fwitte May 8, 2025
4864064
Fix some smaller bugs.
jfreissmann May 12, 2025
873be9e
Resolve merge conflict.
maltefritz May 12, 2025
1638bb3
Fix bugs of tutorial part 2.
maltefritz May 12, 2025
99ab1e0
Create helpers.py containing functions.
maltefritz May 12, 2025
3605ec9
Merge dev into docs/make-style-modern.
maltefritz May 12, 2025
9d31619
Merge remote-tracking branch 'leroum/docs/grid_icons' into docs/make-…
fwitte May 13, 2025
0250dcb
Remove advanced tutorials from toc
fwitte May 13, 2025
c52f8e5
Fix a couple of warnings
fwitte May 13, 2025
b412d77
Rename best practices to recipe book
fwitte May 13, 2025
b919aa8
Rename example section introductory tutorials.
maltefritz May 13, 2025
542abf4
Link sources from EV tutorial
p-snft May 13, 2025
b61c069
Update district heating supply tutorial.
maltefritz May 13, 2025
d0b87a7
Remove tutorial 4.
maltefritz May 13, 2025
a784be1
Fix typo in tutorials directory name.
maltefritz May 13, 2025
5e1427b
Rename Learnings and add one for step 3.
jfreissmann May 13, 2025
7c9103a
Remove flows and bus sections and tidy up the energy system and model…
fwitte May 13, 2025
dd928a1
Remove flows and buses from toxc
fwitte May 13, 2025
ba260b7
Fix a couple of typos and minor issues
fwitte May 13, 2025
32a69b1
Update figures and include light and darkmode in grid view
fwitte May 13, 2025
ba44f9a
Include screenshot
fwitte May 13, 2025
147417a
Improve formulation of learning in EV tutorial
p-snft May 13, 2025
8949367
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
p-snft May 13, 2025
d3e42db
Add showcase of owp.
maltefritz May 13, 2025
b24a8dd
Shorten heading
fwitte May 13, 2025
fa71668
Fix outdated path to time series data
fwitte May 13, 2025
e4ec8dd
Add Acknowledgements to WhatsNew
p-snft May 13, 2025
9604a76
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
p-snft May 13, 2025
ad4945b
Include sesmg in showcase examples
fwitte May 13, 2025
24b0757
Fix formatting
fwitte May 13, 2025
94f3fe0
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
fwitte May 13, 2025
2d32a25
Add some hints towards adding recipes and add a link to the showcase …
fwitte May 13, 2025
0252718
Add blog reference from showcase page
fwitte May 13, 2025
302f815
Add graph figures to EV tutorial
p-snft May 13, 2025
856dd30
Improve EV tut graph mages
p-snft May 13, 2025
db1007c
Merge branch 'docs/make-style-modern' of github.com:oemof/oemof-solph…
p-snft May 13, 2025
acebba3
Fix some small issues.
jfreissmann May 13, 2025
ecc5f96
Fix include code refs for dhs tutorial 1.
jfreissmann May 13, 2025
e18cee2
Merge branch 'docs/make-style-modern' of github.com:maltefritz/oemof-…
jfreissmann May 13, 2025
e24e677
Merge branch 'dev' into docs/make-style-modern
p-snft May 13, 2025
7ce6fa6
Ignore plotting code in testing
fwitte May 14, 2025
af91d1e
Fix paths in plotting code
fwitte May 14, 2025
597762e
Import solph in correct location
fwitte May 14, 2025
b2d8a4b
Add two missing outputs
fwitte May 14, 2025
67e3a04
Fix merge conflicts.
maltefritz May 14, 2025
2a25ab7
Fix merge conflict in contributing.rst.
maltefritz May 14, 2025
21eed6b
Give correct name to "Introductory Tutorials"
p-snft May 15, 2025
3d2c94a
Add step 1 of home PV tutorial
p-snft May 15, 2025
fbf8347
Add home pv tutorial steps 2, 3, and 4
p-snft May 15, 2025
3c9cae2
Add license headers to PV tutorial
p-snft May 16, 2025
654640f
Add final steps of home PV totorial steps
p-snft May 16, 2025
1399187
Align format of PV tut resuls block
p-snft May 16, 2025
7056d8f
Adhere to Black
p-snft May 16, 2025
d4c0768
Add text to home PV tutorial
p-snft May 16, 2025
22d481e
Add explicit learnings to home PV tutorial
p-snft May 16, 2025
dea1cd6
Add intro for 2nd step of dhs tutorial.
jfreissmann May 19, 2025
9594f90
Merge branch 'docs/make-style-modern' of github.com:maltefritz/oemof-…
jfreissmann May 19, 2025
4956213
Update district heating supply tutorial.
maltefritz May 19, 2025
dde500a
Merge branch 'docs/make-style-modern' of github.com:jfreissmann/oemof…
maltefritz May 19, 2025
12a2bbc
Add structur for district heating supply tutorial 4.
maltefritz May 19, 2025
9287076
Add thumbmail and figures for district heating supply tutorial.
maltefritz May 20, 2025
40b1fa6
Reorder 2nd step energy system creation.
jfreissmann May 20, 2025
52b432d
Add labels and references to equations.
jfreissmann May 20, 2025
aff7f0e
Add description of 2nd step of dhs tutorial.
jfreissmann May 20, 2025
c3d73c5
Merge branch 'docs/make-style-modern' of github.com:jfreissmann/oemof…
maltefritz May 20, 2025
8b30f32
Move tutorial images to subdirectories
p-snft May 20, 2025
b45da9d
Add time series plots to home PV tutorial
p-snft May 20, 2025
1337ff4
Align naming in helpers.py funcs.
jfreissmann May 20, 2025
92d381c
Improve PV tutorial plots
p-snft May 20, 2025
e6a2da0
Adhere to Black
p-snft May 20, 2025
a62e309
Comment out multiply defined vars in PV tutorial
p-snft May 20, 2025
4a5a9e3
Add automatic figure and table numbering.
jfreissmann May 20, 2025
c79e1e4
Small changes in dhs tut step 2.
jfreissmann May 20, 2025
fc38fa5
Add more descriptions and tables for dhs tut step 2.
jfreissmann May 20, 2025
f0071bd
Finalize the setting of dhs tutorial and add figures.
maltefritz May 21, 2025
7d2aa0e
Finalize 2nd step of dhs tutorial.
jfreissmann May 22, 2025
d551173
Change heat pump to NonConvex.
jfreissmann May 23, 2025
9c6346e
Overwrite plots using NonConvex heat pump.
jfreissmann May 23, 2025
91261d3
Update current status of 3rd step of dhs tut.
jfreissmann May 23, 2025
0dbe951
Finalize step 3 of dhs tutorial.
jfreissmann May 23, 2025
c56c524
Merge branch 'docs/make-style-modern' into docs/make-style-modern
p-snft May 23, 2025
69eac16
Merge pull request #1194 from maltefritz/docs/make-style-modern
p-snft May 23, 2025
cf4f08e
Fix missing references and includes
p-snft Jun 3, 2025
398efb4
Adhere to Black
p-snft Jun 3, 2025
5551102
Fix a couple of broken references
fwitte Jun 3, 2025
75d6a53
Remove unused source file for advanced tutorials
fwitte Jun 3, 2025
535f6d3
Remove remains of advanced tutorials from docs
p-snft Jun 3, 2025
e4cc911
Remove usage.rst
p-snft Jun 3, 2025
2131797
Fix links
p-snft Jun 3, 2025
5cdb0d5
Reformulate misleading install instruction
p-snft Jun 3, 2025
826987d
Put in the time for the online meeting
fwitte Jun 3, 2025
267d76f
Update year
fwitte Jun 3, 2025
753a731
Clarify wording in installation instructions and fix Mac copy paste i…
fwitte Jun 3, 2025
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
3 changes: 2 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ sphinx:
formats: []
python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
extra_requirements:
- dev
16 changes: 10 additions & 6 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _contribute_label:

============
Contributing
============
Expand Down Expand Up @@ -45,13 +47,17 @@ To set up `oemof-solph` for local development:

git clone git@github.com:$(your_github_account)/oemof-solph.git

3. Create a branch for local development::
3. Install oemof.solph in editable mode with dev dependencies::

pip install -e ./path/to/local/clone[dev]

4. Create a branch for local development::

git checkout -b name-of-your-bugfix-or-feature
`git checkout -b features/name-of-your-feature` or `git checkout -b fix/name-of-your-fix`

Now you can make your changes locally.

4. When you're done making changes run all the checks and docs builder with `tox <https://tox.wiki/en/latest/installation.html>`_ one command::
5. When you're done making changes run all the checks and docs builder with `tox <https://tox.wiki/en/latest/installation.html>`_ one command::

tox

Expand All @@ -61,7 +67,7 @@ To set up `oemof-solph` for local development:
git commin
git push origin name-of-your-bugfix-or-feature

6. Submit a pull request through the GitHub website.
7. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------
Expand All @@ -80,7 +86,6 @@ For merging, you should:

It will be slower though ...


Tests
-----

Expand All @@ -105,7 +110,6 @@ Note, to combine the coverage data from all the tox environments run:

PYTEST_ADDOPTS=--cov-append tox


Tips
----

Expand Down
432 changes: 208 additions & 224 deletions docs/_files/ExtractionTurbine_range_of_operation.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading