Skip to content

Revise modelchain.rst for multiple arrays, results attribute#1223

Merged
wholmgren merged 27 commits into
pvlib:masterfrom
cwhanse:modelchain
May 14, 2021
Merged

Revise modelchain.rst for multiple arrays, results attribute#1223
wholmgren merged 27 commits into
pvlib:masterfrom
cwhanse:modelchain

Conversation

@cwhanse

@cwhanse cwhanse commented May 9, 2021

Copy link
Copy Markdown
Member
  • Closes Update modelchain.rst #1115
  • I am familiar with the contributing guidelines
  • Tests added
  • Updates entries to docs/sphinx/source/api.rst for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels and Milestone are assigned to the Pull Request and linked Issue.

@cwhanse cwhanse added this to the 0.9.0 milestone May 9, 2021
@cwhanse cwhanse changed the title Review modelchain.rst for multiple arrays, results attribute Revise modelchain.rst for multiple arrays, results attribute May 9, 2021
Comment thread docs/sphinx/source/modelchain.rst Outdated
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The PVSystem can represent a PV system with a single array of modules, or
with [multiple arrays](#PVSystem and Arrays). The same models are applied to

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Anyone know how to link to a heading in a different file (pvsystem.rst, in this case)?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@cwhanse cwhanse mentioned this pull request May 10, 2021
24 tasks

@wholmgren wholmgren left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

thanks for the careful edits

Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
@kandersolar

Copy link
Copy Markdown
Member

Haven't looked at the new text yet, but I did quickly scroll through the log on the last RTD build and it looks like introtutorial.rst still uses mc.ac and modelchain.rst still has some deprecated use of ac, dc, effective_irradiance, and cell_temperature.

@cwhanse

cwhanse commented May 10, 2021

Copy link
Copy Markdown
Member Author

Haven't looked at the new text yet, but I did quickly scroll through the log on the last RTD build and it looks like introtutorial.rst still uses mc.ac and modelchain.rst still has some deprecated use of ac, dc, effective_irradiance, and cell_temperature.

I will search the rest of the doc files.

@kandersolar kandersolar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Mostly nitpicks about sphinx output

Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst

@wholmgren wholmgren left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I carefully read the changes and they are great. Thanks @cwhanse. Minor comments below but fine with me to merge anytime.

Comment thread docs/sphinx/source/modelchain.rst
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
Comment thread docs/sphinx/source/modelchain.rst Outdated
logic to assign one of the model-specific methods, such as
:py:meth:`~pvlib.modelchain.ModelChain.sapm` or :py:meth:`~pvlib.modelchain.ModelChain.snlinverter`,
to the universal method names ``ModelChain.dc_model`` and ``ModelChain.ac_model``,
respectively. A few examples are shown below. Inferrence methods generally work

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this suggestion might have been buried/overlooked.

Comment thread docs/sphinx/source/modelchain.rst
Comment thread docs/sphinx/source/modelchain.rst Outdated
@wholmgren

Copy link
Copy Markdown
Member

Builds clean on my machine. I say merge it now. We'll need a doc clean up PR for a few unrelated problems.

@wholmgren

Copy link
Copy Markdown
Member

ready to merge @cwhanse?

@cwhanse

cwhanse commented May 14, 2021

Copy link
Copy Markdown
Member Author

Yes, ready.

@wholmgren wholmgren merged commit 7661b05 into pvlib:master May 14, 2021
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.

Update modelchain.rst

3 participants