Skip to content

Conversation

@wholmgren
Copy link
Member

Moves the "Getting Started"/"Modeling Paradigms" section to a new top-level "Intro Examples" page. I'd eventually like to see more quick examples added to this section.

Link to the rendered docs on rtd:

https://wholmgren-pvlib-python-new.readthedocs.io/en/introexamples/

  • Addresses [REVIEW]: pvlib python: a python package for modeling solar energy systems openjournals/joss-reviews#884 (comment)
  • 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 git diff upstream/master -u -- "*.py" | flake8 --diff
  • 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.

@wholmgren wholmgren added this to the 0.6.0 milestone Aug 21, 2018
@wholmgren wholmgren requested a review from cwhanse August 21, 2018 17:16
system['surface_tilt'] = latitude
solpos = pvlib.solarposition.get_solarposition(times, latitude, longitude)
dni_extra = pvlib.irradiance.get_extra_radiation(times)
dni_extra = pd.Series(dni_extra, index=times)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this explicit conversion to pd.Series still needed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, good catch

also includes a :py:class:`~pvlib.tracking.SingleAxisTracker` class that
is a subclass of :py:class:`~pvlib.pvsystem.PVSystem`.

The following code demonstrates how to use
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add some text here about the defaults in ModelChain because our example provides the absolute minimum input. Perhaps

ModelChain objects provide convenience methods that can provide default selections for models and can also fill necessary input data with modeled data. In our example below, we use convenience methods. For example, no irradiance data is provided as input, so the ModelChain object substitutes irradiance from a clear-sky model via the prepare_inputs method. Also, no irradiance transposition model is specified (kwarg transposition for ModelChain) so the ModelChain defaults to the haydavies model. In this example, ModelChain infers the DC power model from the module provided by examining the parameters defined for module.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea, thanks.

@wholmgren
Copy link
Member Author

I confirmed that this still renders fine, so I think it's ready to merge.

@cwhanse cwhanse merged commit 5728d11 into pvlib:master Aug 22, 2018
@wholmgren wholmgren deleted the introexamples branch August 23, 2018 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants