Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
120 commits
Select commit Hold shift + click to select a range
a5e434c
Create tutorial how to add a new component.
maltefritz Oct 22, 2025
eddfea3
Fix typo.
maltefritz Oct 22, 2025
6da8dfc
Expand the how to contribute a new component tutorial.
maltefritz Oct 23, 2025
3702bf4
Structure rtd.
maltefritz Oct 24, 2025
ae97624
Finish how to contribute a new component.
maltefritz Oct 24, 2025
9dd9fa0
Add drawing of polynominal compressor with cooling.
maltefritz Oct 24, 2025
695cf95
Give it a first try for a different kind of entry point
fwitte Oct 25, 2025
28af4a9
Fix some typos
fwitte Nov 6, 2025
5f1999c
Merge branch 'dev' into feature/#808-restructure-documentation
fwitte Nov 6, 2025
b2fce6b
Try to break down to more concrete subsections
fwitte Nov 6, 2025
44215d2
Make some nice card layout
fwitte Nov 7, 2025
08f0ec5
Change the color of the icons to match the logo main color
fwitte Nov 7, 2025
cfbafdd
Consistently use &
fwitte Nov 7, 2025
cc85144
Adjust the grid according to comment of @jfreissmann
fwitte Nov 7, 2025
6744103
Fine tune colors and layouts
fwitte Nov 7, 2025
81a9caf
Merge branch 'dev' into feature/#808-restructure-documentation
fwitte Nov 7, 2025
7d68eb7
Try some kind of subpage layout
fwitte Nov 7, 2025
dbcae3f
Add a darkmode version of the small logo
fwitte Nov 7, 2025
97512fc
Merge branch 'dev' into feature/#808-restructure-documentation
fwitte Nov 7, 2025
b1b4338
Reorder the building blocks overview and add a page for component ove…
fwitte Nov 9, 2025
e896316
Add missing parameters in script
fwitte Nov 9, 2025
189dd95
Add the missing tables in the docs source
fwitte Nov 9, 2025
b26fb1b
Include the mandatory constraints as well
fwitte Nov 9, 2025
fa542a8
Add the missing constraints to docs source
fwitte Nov 9, 2025
bb3489f
Readd the power inlets/outlets update in the network topology setup part
fwitte Nov 9, 2025
137cdf7
Add educational resources to the bullets
fwitte Nov 9, 2025
7faa9a3
Moving around a lot of stuff
fwitte Nov 9, 2025
f7b6baa
More restructuring and cleaning up a bit
fwitte Nov 9, 2025
05041b2
Fix most internal links, card titles and sublinks
fwitte Nov 10, 2025
2b6c8f8
Fix a couple internal references
fwitte Nov 11, 2025
a8bc41b
Merge branch 'dev' into feature/#808-restructure-documentation
fwitte Nov 11, 2025
5410e8b
Merge branch 'dev' into HEAD
fwitte Nov 11, 2025
34df5ef
Change order of icons and update educational resources
fwitte Nov 11, 2025
03486f6
Add an example question to the faq
fwitte Nov 11, 2025
05a1030
Merge branch 'dev' into feature/#808-restructure-documentation
fwitte Nov 12, 2025
49e88de
Add a few FAQ entries and suggestions for answers.
jfreissmann Nov 13, 2025
8c9eb8f
Modify some wording and add few a few bullets
fwitte Nov 13, 2025
1b76d24
Add one best practice example from the user meeting
fwitte Nov 13, 2025
1d2c2e1
Add some notes on the eduactional resources
fwitte Nov 13, 2025
cfd4dee
Add some missing newlines
fwitte Nov 13, 2025
a9c990e
Let sphinx automatically build the toctree for the api docs
fwitte Nov 13, 2025
6d87759
Ignore new .rst files in the api docs
fwitte Nov 13, 2025
542bd7b
Make the tables for the component overviews automatically on building…
fwitte Nov 13, 2025
d75bf28
Ignore _components_overview.rst file as it will be autogenerated
fwitte Nov 13, 2025
9e707fe
Add descriptions for quite a few parameters
fwitte Nov 13, 2025
5772dad
Merge branch 'dev' into feature/#808-restructure-documentation
fwitte Nov 24, 2025
78b0fe1
Add thumbnails for getting started.
maltefritz Nov 24, 2025
6df12e7
Flesh out FAQ answer about fluid property diagrams.
jfreissmann Nov 24, 2025
8f37b6c
Flesh out Q-T diagram FAQ and turn FAQ into accordion.
jfreissmann Nov 24, 2025
cb2fb64
Improve Q-T diagram answer text.
jfreissmann Nov 24, 2025
cc746ae
Fix typo Q-T diagram FAQ answer.
jfreissmann Nov 24, 2025
ee42ae6
Remove the button layout again and use the default tab look
fwitte Nov 24, 2025
9b962fc
Add a js method to implement accordion behavior for dropdowns
fwitte Nov 24, 2025
a2292ce
Add missing descriptions and prepare connection parameter descriptions
fwitte Nov 24, 2025
4428d8a
Fix a couple of minor issues
fwitte Nov 24, 2025
ba216d8
Implement tabular overviews for the connection classes
fwitte Nov 24, 2025
6f57ca0
Move around some sections and try to condensate to the most important…
fwitte Nov 24, 2025
cb09529
Show how to generate cycle diagrams automatically
fwitte Nov 24, 2025
4d07149
Remove unused deprecated 'modules.rst'
fwitte Nov 24, 2025
f93152f
Fix failing doctest
fwitte Nov 24, 2025
8059a62
Add new thumbnails for building blocks.
maltefritz Nov 25, 2025
7917904
Add new thumbnails for examples and benchmarks.
maltefritz Nov 25, 2025
b4843f3
Fix the wrong thumbnail size.
maltefritz Nov 25, 2025
1e2ee4f
Make nice responsive grids on highest level
fwitte Nov 26, 2025
7d03d08
Move the example to a different subfolder
fwitte Nov 26, 2025
37f8d18
Merge maltefritz/dev into feature/#808
fwitte Nov 26, 2025
c5f14d0
Add thumbnails for advanced tutorials and features as well as integra…
maltefritz Nov 26, 2025
f4699fe
Fix some typos and links
fwitte Nov 26, 2025
5fb729d
Add thumbnails for documentation.
maltefritz Nov 26, 2025
88619fc
Include a note to make users aware of derivative method pitfalls
fwitte Nov 27, 2025
972e1ed
Use caution block
fwitte Nov 27, 2025
85a2f64
Check for reference_container equality
fwitte Nov 27, 2025
ce8f6af
Skip testing the build tutorial for custom component
fwitte Nov 27, 2025
c2e4b83
Add thumbnails for community and knowledge center.
maltefritz Nov 27, 2025
2b39c71
Update some thumbnails.
maltefritz Nov 27, 2025
be7592a
Add dark mode versions of thumbnails.
maltefritz Nov 27, 2025
2adbe35
Merge maltefritz/#808 into origin/#808
fwitte Nov 27, 2025
7a61111
Move the introductory tutorials to highest level in toc
fwitte Nov 27, 2025
c16c770
Add a debugging tutorial
fwitte Nov 27, 2025
aec7221
Readd basic tutorial overview page
fwitte Nov 27, 2025
9f72b63
Fix a couple things in notebook
fwitte Nov 27, 2025
7ba81f6
Add an example for workflow integration
fwitte Nov 27, 2025
ccd08cd
Remove best practices for now
fwitte Nov 27, 2025
7f23360
Change the font color of dark mode images.
maltefritz Nov 28, 2025
1c41c4f
Add thumbnails for educational resources.
maltefritz Nov 28, 2025
ab32d83
Add thumbnails for some tutorials.
maltefritz Nov 28, 2025
297ee26
Standardize the grid card layout.
maltefritz Nov 28, 2025
9567625
Add thumbnails for integration.
maltefritz Nov 28, 2025
e44ba79
Merge dev into feature/#808
fwitte Nov 28, 2025
c97ccac
Remove unused footnote
fwitte Nov 28, 2025
88171a6
Add powerconnection usage example
fwitte Nov 28, 2025
dd20ec6
Merge branch 'dev' into feature/#808-restructure-documentation
fwitte Nov 30, 2025
92d77ad
Double check the tutorial
fwitte Nov 30, 2025
40817e9
Aling the headings
fwitte Nov 30, 2025
f8264b4
Link to the oemof heat pump workshop
fwitte Nov 30, 2025
b341254
Add a thumbnail for PowerConnection tutorial
fwitte Nov 30, 2025
3c125e2
Change order of sections
fwitte Nov 30, 2025
3834425
Change order
fwitte Nov 30, 2025
100c23a
Include a note and indicate which component parameters can be used as…
fwitte Dec 1, 2025
23639d4
Indicate which parameters can be variable and add missing descriptions
fwitte Dec 1, 2025
6d85544
Adhere to the model template
fwitte Dec 1, 2025
ec236f5
Adjust sizing
fwitte Dec 1, 2025
40a510c
Fix some typos
fwitte Dec 1, 2025
40a4929
Merge branch 'feature/#808-restructure-documentation' into HEAD
fwitte Dec 1, 2025
6a03b01
Update a couple of FAQ
fwitte Dec 2, 2025
acaf4f2
Flesh out FAQ convergence answer.
jfreissmann Dec 2, 2025
b0bdf47
Update the FAQ
fwitte Dec 3, 2025
0c35f33
Update block on exergy analysis
fwitte Dec 3, 2025
95421c6
Merge remote-tracking branch 'jfreissmann/feature/#808-restructure-do…
fwitte Dec 3, 2025
bb56177
Add a couple of missing parameter descriptions
fwitte Dec 3, 2025
0475e1e
Fix a typo
fwitte Dec 3, 2025
53693c1
Fix missing descriptions
fwitte Dec 3, 2025
6f1452e
Restructure and group FAQ answers.
jfreissmann Dec 5, 2025
3af864d
Add a short introduction to the FAQ.
jfreissmann Dec 5, 2025
f8b1f77
Add another optimization example to FAQ.
jfreissmann Dec 5, 2025
d460662
Add FAQ entry for debugging presolve errors.
jfreissmann Dec 5, 2025
482fe92
Add missing period,
jfreissmann Dec 5, 2025
17a347a
Add FAQ entry for singularities in the Jacobian.
jfreissmann Dec 5, 2025
a57bda0
Update high level entry card for knowledge center
fwitte Dec 5, 2025
2b12b87
Fix some typos and link issues
fwitte Dec 5, 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: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ htmlcov

# Sphinx
docs/_build
docs/api/*.rst
docs/building_blocks/_*.rst
docs/jupyter_execute

.DS_Store
*~
Expand Down
48 changes: 48 additions & 0 deletions docs/_static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,51 @@ figure figcaption p {
text-align: center;
font-weight: bold;
}

/* Let the content of the page (usually 46em) use the right sidebar space (15em) */

.page:has(.toc-drawer.no-toc) .content {
width: 61em;
}

/* This is to style the cards on the landing page */

.sd-material-icon {
background: var(--color-background-secondary);
border-radius: 50%;
padding: 0.25em;
overflow: visible;
}

/* Add the color of the logo */

:root {
--color-logo-main: #1f567d;
--color-logo-main-transparent: #1f567d0d;
}

.sd-text-logo-main {
color: var(--color-logo-main);
}

/* This is to change the labels of tabs and make a nice rounded box around them */

.sd-card {
background-color: var(--color-logo-main-transparent) !important;
border-color: var(--color-logo-main-transparent) !important;
margin: 0.25em;
}

/* This is to change the text on the landing page card grid */

.sd-card.landing-card:hover ul.simple {
color: var(--color-foreground-primary);
}

.sd-card.landing-card ul.simple {
color: var(--color-foreground-secondary);
}

span.backrefs {
display: none !important;
}
Loading