add ModelChain tutorial, nbsphinx extension #362
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a ModelChain tutorial to the documentation.
I'm trying a different documentation build technique than I've used in the past: write the tutorial in a Jupyter notebook, then use nbsphinx to embed it in the html documentation. After a few hiccups, I found that overall it's a lot easier than writing rst files with ipython directives. The downside is that the source ipynb file is harder to read with a simple text editor (or on github) than a simple rst file. The ipynb file doesn't have any output, though, so it's not as bad as it can be.
You can few the documentation here:
http://wholmgren-pvlib-python-new.readthedocs.io/en/mcdocs2/modelchain.html
I'll leave this open for a day for edits/suggestions. We can always improve it later, too.