MoonRaker / pvlib-python

A set of documented functions for simulating the performance of photovoltaic energy systems.
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

documentation and/or tutorial #3

Closed wholmgren closed 8 years ago

wholmgren commented 8 years ago

Sometimes I like our IPython Notebook tutorials and sometimes I think we need to have more traditional documentation beyond just the API. Your perspective would be very helpful here. What do you want to write for forecasting? Traditional docs or an IPython Notebook?

MoonRaker commented 8 years ago

I thought about this as well. It is easy enough to do both. I think the utility of just being able to grab a traditional module and run with and begin making it my own. However, the Ipython notebooks are useful for those who are less familiar with programming or the library and want to see how and if it will work for them. It also gives a bit more detail as to why things are the way there in the code. This seems especially useful when problems or challenges arise with using the library. For now I will construct both and see how they are received.

MoonRaker commented 8 years ago

I have updated and verified that both the forecast.ipynb and the forecast_to_power.ipynb work as they should with the most recent commits. Do you think that these notebooks are sufficient or are they missing functionality of the models that we should include yet?

wholmgren commented 8 years ago

It would be great if we could get some of the overview material in your powerpoint into the sphinx documentation. This would be separate from the API documentation and it would live in docs/sphinx/source.

I'm sure that you're aware of some of this, but here are comments on each notebook...

forecast.ipynb:

forecast_to_power.ipynb:

MoonRaker commented 8 years ago

All these fixes have been made and both notebooks have been run in full.