Documentation of Unit example #262
Conversation
There was a problem hiding this comment.
Adding the tutorial to the list is needed for it to show up on the docs too:
https://github.com/assume-framework/assume/blob/b3aa9c185e88061cbdfc87c38b3eaaac06b70fbf/docs/source/examples_basic.rst
docs/source/ASSUME_Architecture.png
Outdated
There was a problem hiding this comment.
There is already https://github.com/assume-framework/assume/blob/main/docs/source/img/architecture.svg
If added - this picture would belong into the same folder, but I would just use the .svg where you need it.
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "" |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #262 +/- ##
=======================================
Coverage 81.90% 81.90%
=======================================
Files 38 38
Lines 4161 4162 +1
=======================================
+ Hits 3408 3409 +1
Misses 753 753
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
@kim-mskw could you please check this commit please? You have a good eye for details and consistency :-) |
|
@Manish-Khanra the part of adding the new unit type is missing. Also, you need something like %%add_to RLStrategy from tutorial 4 RL to be able to have functions inside classes up and running. Please add it where needed. Also, at the beginning, the part about docker and limitations is repeated twice. Please check |
…work/assume into Dokumentation_Units
-rename tutorial 6 to 5 -add automated execution function
docs/source/examples_basic.rst
Outdated
There was a problem hiding this comment.
This does not look right - it should not undo the renaming
There was a problem hiding this comment.
the electrolyzer png works on the docs but is broken on the notebook itself..
This is due to the relative paths being different.
We could fix this, by loading the picture with python and displaying it - resulting in the images being embedded as an output of a cell.
We could also fix this by adding a new folder /img next to the notebook, which includes this image a second time.
Both is really stupid.
We could have something like:
from IPython.display import Image, display
display(Image('docs/source/img/Electrolyzer.png'))
|
yes true, I changed the way how it is displayed, is ugly, but this is the only way how it works for docs, but also in collab and locally |
Documentation of an electrlyser unit example