convert modelchain.ipynb to rst, remove nbsphinx #568

wholmgren · 2018-09-08T21:33:32Z

Closes readthedocs are failing #567
I am familiar with the contributing guidelines.
Fully tested. Added and/or modified tests to ensure correct behavior for all reasonable inputs. Tests (usually) must pass on the TravisCI and Appveyor testing services.
Updates entries to docs/sphinx/source/api.rst for API changes.
Adds description and name entries in the appropriate docs/sphinx/source/whatsnew file for all changes.
Code quality and style is sufficient. Passes LGTM and SticklerCI checks.
New code is fully documented. Includes sphinx/numpydoc compliant docstrings and comments in the code where necessary.
Pull request is nearly complete and ready for detailed review.

New documentation using the new modelchain.rst file:

https://wholmgren-pvlib-python-new.readthedocs.io/en/mcdocclean/modelchain.html

Last successful build on pvlib/master using the old modelchain.ipynb file:

https://pvlib-python.readthedocs.io/en/latest/modelchain.html

wholmgren · 2018-09-08T21:43:23Z

docs/sphinx/source/modelchain.rst

+
+    ModelChain(poorly_specified_system, location)
+
+If our goal is simply to get the object constructed, we can specify the


This section will need to change due to #555

wholmgren · 2018-09-08T21:43:41Z

docs/sphinx/source/modelchain.rst

+of the modeling process while providing user-control and remaining
+extensible. This guide aims to build users' understanding of the
+ModelChain class. It assumes some familiarity with object-oriented
+ipython in Python, but most information should be understandable even


wholmgren · 2018-09-08T21:44:21Z

docs/sphinx/source/modelchain.rst

+    mc.run_model(times=weather.index, weather=weather)
+
+The ModelChain attempted to execute the PVSystem object's
+:py:meth:`~pvlib.pvsystem.PVSystem.singlediode` method, and the method


if reworking this section, replace singlediode with a different method

cec should be our default example

I decided to remove this section that referenced singlediode because #555 disallowed this "feature".

The remaining examples demonstrate sapm and pvwatts. I'm ok adding another example that demonstrates the behavior when pulling from the cec database if you don't think it would be pedantic. Not sure about pvsyst/desoto.

OK with me to remove it. The scope of this PR is to rehost the example, so we can push off expanding the example to a follow on.

wholmgren · 2018-09-08T21:47:45Z

docs/sphinx/source/modelchain.rst

+---------------------------------
+
+The ModelChain class has a lot going in inside it in order to make
+users' ipython as simple as possible.


another code --> ipython replace all issue

wholmgren · 2018-09-08T21:48:03Z

docs/sphinx/source/modelchain.rst

+The key parts of ModelChain are:
+
+1. The :py:meth:`ModelChain.run_model() <.ModelChain.run_model>` method
+1. A set of methods that wrap and call the PVSystem methods.


wholmgren · 2018-09-08T21:49:02Z

docs/sphinx/source/modelchain.rst

+Wrapping methods into a unified API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Readers may notice that the source ipython of the ModelChain.run_model


replace all again

wholmgren · 2018-09-08T21:49:46Z

docs/sphinx/source/modelchain.rst

+The ModelChain.pvwatts_dc method calls the pvwatts_dc method of the
+PVSystem object that we supplied using data that is stored in its own
+``effective_irradiance`` and ``temps`` attributes. Then it assigns the
+result to the ``dc`` attribute of the ModelChain object. The ipython below


mikofski · 2018-09-08T23:57:54Z

Does this also drop the jupyter requirement too? If so it will be a huge relief for those of us running headless, no gui, eg as in Windows Subsystem for Linux. Two less requirements to install that come with a lot of overhead, so thanks! 😄

stickler-ci · 2018-09-09T16:47:23Z

pvlib/clearsky.py

@@ -829,8 +829,7 @@ def bird(zenith, airmass_relative, aod380, aod500, precipitable_water,

    `SERI/TR-642-761 <http://rredc.nrel.gov/solar/pubs/pdfs/tr-642-761.pdf>`_

-    `Error Reports
-     <http://rredc.nrel.gov/solar/models/clearsky/error_reports.html>`_
+    `Error Reports <http://rredc.nrel.gov/solar/models/clearsky/error_reports.html>`_


E501 line too long (85 > 79 characters)

This was causing doc build errors when it was two lines. Not sure why or how to fix it. I'm ok with allowing it to be too long.

stickler-ci · 2018-09-09T16:47:23Z

pvlib/solarposition.py

@@ -934,8 +934,7 @@ def equation_of_time_pvcdrom(dayofyear):
    `PVCDROM`_ is a website by Solar Power Lab at Arizona State
    University (ASU)

-    .. _PVCDROM:
-    http://www.pveducation.org/pvcdrom/2-properties-sunlight/solar-time
+    .. _PVCDROM: http://www.pveducation.org/pvcdrom/2-properties-sunlight/solar-time


E501 line too long (84 > 79 characters)

same as above

wholmgren · 2018-09-09T17:06:24Z

@mikofski I believe we can drop jupyter. The docs are now mostly building without jupyter present. For some reason the ipython directive no longer executes the code in the pvsystem.rst and timetimezones.rst files. I think it's unrelated but not 100% sure.

I am a bit confused as to why you're concerned about a jupyter requirement for the doc builds but also in favor of adding scipy to the base requirements. Feels like I'm missing something.

mikofski · 2018-09-09T17:17:32Z

Well scipy can be used for many things other than pvlib, whereas Jupyter is mainly used as a graphical user interface, which is pointless in a headless environment. But it doesn't really matter, it's more just the principle I guess.

stickler-ci · 2018-09-09T17:35:18Z

pvlib/clearsky.py

@@ -829,8 +829,7 @@ def bird(zenith, airmass_relative, aod380, aod500, precipitable_water,

    `SERI/TR-642-761 <http://rredc.nrel.gov/solar/pubs/pdfs/tr-642-761.pdf>`_

-    `Error Reports
-     <http://rredc.nrel.gov/solar/models/clearsky/error_reports.html>`_
+    `Error Reports <http://rredc.nrel.gov/solar/models/clearsky/error_reports.html>`_


E501 line too long (85 > 79 characters)

stickler-ci · 2018-09-09T17:35:18Z

pvlib/solarposition.py

@@ -934,8 +934,7 @@ def equation_of_time_pvcdrom(dayofyear):
    `PVCDROM`_ is a website by Solar Power Lab at Arizona State
    University (ASU)

-    .. _PVCDROM:
-    http://www.pveducation.org/pvcdrom/2-properties-sunlight/solar-time
+    .. _PVCDROM: http://www.pveducation.org/pvcdrom/2-properties-sunlight/solar-time


E501 line too long (84 > 79 characters)

stickler-ci · 2018-09-09T18:25:56Z

Your configuration file uses an unknown linter. The flake8 linter is not a supported linter.

stickler-ci · 2018-09-09T21:36:37Z

Your configuration file uses an unknown linter. The flake8 linter is not a supported linter.

wholmgren · 2018-09-09T21:53:27Z

I cannot reliably reproduce the ipython execution failures locally or on rtd. I'll merge and hope for the best. At least the docs should build again.

wholmgren · 2018-09-09T22:15:43Z

Aaaaand the docs build but fail to execute the ipython directive blocks in pvsystem.rst and timetimezones.rst. :(

stickler-ci · 2018-09-10T01:19:24Z

pvlib/clearsky.py

@@ -829,8 +829,7 @@ def bird(zenith, airmass_relative, aod380, aod500, precipitable_water,

    `SERI/TR-642-761 <http://rredc.nrel.gov/solar/pubs/pdfs/tr-642-761.pdf>`_

-    `Error Reports
-     <http://rredc.nrel.gov/solar/models/clearsky/error_reports.html>`_
+    `Error Reports <http://rredc.nrel.gov/solar/models/clearsky/error_reports.html>`_


E501 line too long (85 > 79 characters)

stickler-ci · 2018-09-10T01:19:24Z

pvlib/solarposition.py

@@ -934,8 +934,7 @@ def equation_of_time_pvcdrom(dayofyear):
    `PVCDROM`_ is a website by Solar Power Lab at Arizona State
    University (ASU)

-    .. _PVCDROM:
-    http://www.pveducation.org/pvcdrom/2-properties-sunlight/solar-time
+    .. _PVCDROM: http://www.pveducation.org/pvcdrom/2-properties-sunlight/solar-time


E501 line too long (84 > 79 characters)

convert modelchain.ipynb to rst, remove nbsphinx

8a0e794

wholmgren added bug documentation labels Sep 8, 2018

wholmgren added this to the 0.6.0 milestone Sep 8, 2018

wholmgren commented Sep 8, 2018

View reviewed changes

some clean up

799aa4e

wholmgren added 4 commits September 8, 2018 21:10

remove ipywidgets and docutils from doc env

26a5051

remove outdated section

b27f733

hacks to make other pages compile

fa5ba86

other doc clean up

34da738

stickler-ci bot reviewed Sep 9, 2018

View reviewed changes

3 spaces for directive options

6ff6b8f

stickler-ci bot reviewed Sep 9, 2018

View reviewed changes

cwhanse approved these changes Sep 9, 2018

View reviewed changes

use bare .. ipython:: (no python)

37584a7

enabled install option on rtd. now removing previously added output

af7cdff

wholmgren merged commit 6c6685a into pvlib:master Sep 9, 2018

stickler-ci bot reviewed Sep 10, 2018

View reviewed changes

wholmgren mentioned this pull request Dec 10, 2018

documentation fixes #632

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

convert modelchain.ipynb to rst, remove nbsphinx #568

convert modelchain.ipynb to rst, remove nbsphinx #568

wholmgren commented Sep 8, 2018 •

edited

Loading

wholmgren Sep 8, 2018

wholmgren Sep 8, 2018

wholmgren Sep 8, 2018

cwhanse Sep 9, 2018

wholmgren Sep 9, 2018

cwhanse Sep 9, 2018

wholmgren Sep 8, 2018

wholmgren Sep 8, 2018

wholmgren Sep 8, 2018

wholmgren Sep 8, 2018

wholmgren Sep 8, 2018

mikofski commented Sep 8, 2018 •

edited

Loading

stickler-ci bot Sep 9, 2018

wholmgren Sep 9, 2018

stickler-ci bot Sep 9, 2018

wholmgren Sep 9, 2018

wholmgren commented Sep 9, 2018

mikofski commented Sep 9, 2018

stickler-ci bot Sep 9, 2018

stickler-ci bot Sep 9, 2018

stickler-ci bot commented Sep 9, 2018

stickler-ci bot commented Sep 9, 2018

wholmgren commented Sep 9, 2018

wholmgren commented Sep 9, 2018

stickler-ci bot Sep 10, 2018

stickler-ci bot Sep 10, 2018


		ModelChain(poorly_specified_system, location)

		If our goal is simply to get the object constructed, we can specify the

convert modelchain.ipynb to rst, remove nbsphinx #568

convert modelchain.ipynb to rst, remove nbsphinx #568

Conversation

wholmgren commented Sep 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikofski commented Sep 8, 2018 • edited Loading

stickler-ci bot Sep 9, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stickler-ci bot Sep 9, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wholmgren commented Sep 9, 2018

mikofski commented Sep 9, 2018

stickler-ci bot Sep 9, 2018

Choose a reason for hiding this comment

stickler-ci bot Sep 9, 2018

Choose a reason for hiding this comment

stickler-ci bot commented Sep 9, 2018

stickler-ci bot commented Sep 9, 2018

wholmgren commented Sep 9, 2018

wholmgren commented Sep 9, 2018

stickler-ci bot Sep 10, 2018

Choose a reason for hiding this comment

stickler-ci bot Sep 10, 2018

Choose a reason for hiding this comment

wholmgren commented Sep 8, 2018 •

edited

Loading

mikofski commented Sep 8, 2018 •

edited

Loading