search

rl-institut / oemof-B3

An open-source energy system model for Brandenburg/Berlin.
https://oemof-b3.readthedocs.io/
GNU Affero General Public License v3.0
9 stars 5 forks source link

Feature/improve docs #263

Closed MaGering closed 1 year ago

MaGering commented 1 year ago

With this PR issues mentioned in https://github.com/rl-institut/oemof-B3/issues/119 are handled.

MaGering commented 1 year ago

I could trace the error of docstrings not rendering in model pipeline back to an error involving dynaconf and logging together with spinx / readthedocs. I used a dirty fix with commit https://github.com/rl-institut/oemof-B3/pull/263/commits/2718b43f29ef80c8cfa7a9e6989a2651914e25db skipping the code lines at issue if readthedocs is building the docs using:

if "readthedocs" not in str(THIS_FILE_PATH)

Not solving the problem but working for now, after a long and unsuccessful research on how I can fix this error.

I renamed "plotting" to "visualization" since I had to add the missing scripts:

I also updated all the other scripts that were missing or differed.

Unfortunately the new structure is not shown in the branch docs. I don't know why. Maybe readthedocs takes still the structure from dev branch? To test this @jnnr you'll need to build the docs locally. You may need to change the code in config.py to 

if "readthedocs" not in str(THIS_FILE_PATH) and "<insert_your_user_here>" not in str(THIS_FILE_PATH)

exchanging with your username in your system.

monika-o commented 1 year ago

I've just read through the docs and they improved a lot. The most important thing we should still add is in my opinion what @SabineHaas wrote in #81 , i.e. how oemof-B3 and oemoflex (and perhaps also oemof-tabular and oemof-solph) operate together to create scenarios, busses and components. This would really help a lot to understand how the model works and thus how to use it. Could one of you do that, @MaGering or @jnnr ?

jnnr commented 1 year ago

With this PR issues mentioned in #119 are handled.

Did you check of the respective boxes?

MaGering commented 1 year ago

I've just read through the docs and they improved a lot. The most important thing we should still add is in my opinion what @SabineHaas wrote in #81 , i.e. how oemof-B3 and oemoflex (and perhaps also oemof-tabular and oemof-solph) operate together to create scenarios, busses and components. This would really help a lot to understand how the model works and thus how to use it. Could one of you do that, @MaGering or @jnnr ?

In order not to make the PR more extended than it already is, I would open a separate PR for this (after PR https://github.com/rl-institut/oemof-B3/pull/270 is merged).