oemof / oemof

Open Energy Modelling Framework - Python toolbox for energy system modelling and optimisation

https://oemof.org

MIT License

99 stars 25 forks source link

Feature/#69 docs of oemof #81

Closed gplssm closed 3 years ago

gplssm commented 4 years ago

Fix #69

See the updated documentation here

What was changed

Reduced overview for oemof based on existing documentation
Updated outdated information
Added the oemof logo to the documentation
tabular package overview
General aspects of contributing to oemof libraries
full-width page

Points for discussion

Re-add figure _files/framework_concept.svg? I've kicked it out and simply pointed to www.oemof.org (project, models, publications) and to the list of packages
Shall we Include timeline figure?
Taken from existing text, RLI and ZNES are named as founders of oemof. Do want to keep this or do we want to remove institution names from the docs?

Everyone in addition to the assigned reviewer @uvchik is welcome to discuss this PR!

uvchik commented 4 years ago

Thank you for your effort. I really like the table with the packages :+1:

But I would copy the existing text into the new chapters. I think it is easier to build the new text on old fragments than writing a new one.

"about oemof" to "Open Energy Modelling Framework (oemof)" "Developing oemof" and "Contributing" to "Contributing"

What's your opinion on that?

gplssm commented 4 years ago

Thank you for your effort. I really like the table with the packages +1

But I would copy the existing text into the new chapters. I think it is easier to build the new text on old fragments than writing a new one.

"about oemof" to "Open Energy Modelling Framework (oemof)" "Developing oemof" and "Contributing" to "Contributing"

What's your opinion on that?

Thanks for pointing this out again! In general, I agree with you. Don't re-invent the wheel... But, the text is partiallly outdated, belonging to oemof-solph, too specific while information is already available elsewhere. Therefore, I go the extra step and create new text based on the existing as decribed in https://github.com/oemof/oemof/issues/69#issuecomment-695925822

codecov[bot] commented 4 years ago

Codecov Report

Merging #81 (b7eadd8) into master (3c7708e) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##            master       #81   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines            8         8           
=========================================
  Hits             8         8

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3c7708e...b7eadd8. Read the comment docs.

gplssm commented 3 years ago

Hey @uvchik, can I ask you for a quick review of the updated docs. I think it's quite a valuable improvement compared to the outdated docs that are shown at the moment.