rl-institut / oemoflex

A flexible model structure for creating and analysing multi-regional sector-integrated energy systems with oemof featuring many flexibility options.
https://oemoflex.readthedocs.io
GNU Affero General Public License v3.0
4 stars 1 forks source link

Add tables to docstrings of plots and test plot functions #88

Open jnnr opened 1 year ago

jnnr commented 1 year ago

This adds tables to the docstrings of plot functions which show what data format the plot expects. The tables are created from csv files that lie in tests/_files/plot_data. This allows us to use the same data to write tests (can happen later or in this PR).

This will help to better understand and maintain the plotting functions collected here. More of oemof-B3s plotting can relocate here and be re-used (and ultimately send to oemof.tabular).

jnnr commented 1 year ago

@monika-o or @Stefanie08, can one of you take over this PR and do the following for each of the function which has been given a table:

It may be that most of the functions expect data of the same form. In that case, do not create a csv for each function, but only one. You can choose a more general name for the csv in that case.