-
Notifications
You must be signed in to change notification settings - Fork 1.1k
move modeling paradigms to intro examples #539
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
docs/sphinx/source/introexamples.rst
Outdated
| 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) |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good idea, thanks.
|
I confirmed that this still renders fine, so I think it's ready to merge. |
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/
docs/sphinx/source/api.rstfor API changes.docs/sphinx/source/whatsnewfile for all changes.git diff upstream/master -u -- "*.py" | flake8 --diff