search

pvlib / pvlib-python

A set of documented functions for simulating the performance of photovoltaic energy systems.
https://pvlib-python.readthedocs.io
BSD 3-Clause "New" or "Revised" License
1.2k stars 1k forks source link

doc: describe modeling steps #60

Open dacoex opened 9 years ago

dacoex commented 9 years ago

Just to catch your options:

Would the documentation benefit from having a section, mapping the functionality against the typical modelling steps outlined in: https://pvpmc.sandia.gov/modeling-steps/ https://pvpmc.sandia.gov/wp-content/uploads/2014/08/1199X499_slide2.png

If so, I would embark (slowly) on that. It would help me and maybe others to understand the library.

Additionally, this would show where functionality is still lacking.

OK, this would be similar to PV_LIB Version 1_2 Release/html/html/pvlib_functions_by_cat.html But a bit more semantic and linked.

wholmgren commented 9 years ago

Better linking to PVPMC would be very helpful, but we should avoid duplicating their effort. Better ipython notebook tutorials should be a priority too (see #30). I think we can make the equivalent of pvlib_functions_by_cat.html by modifying the sphinx scripts.

Would be happy to see some PRs for documentation.

dacoex commented 9 years ago

I think we can make the equivalent of pvlib_functions_by_cat.html by modifying the sphinx scripts.

OK. that's it. I will have a look at this someday ;-)

dacoex commented 8 years ago

I think the following will solve this: