-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Mount gallery examples #1266
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
Mount gallery examples #1266
Conversation
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.
Thanks @kanderso-nrel for the great examples.
The Example Gallery in this PR is feeling a bit disorganized. Have we previously discussed adding subsections to the Example Gallery? I feel like we have but I don't remember where, when, or anything that might have been said. Certainly not required in this PR.
# Let's take a look at the tracker rotation curve it produces: | ||
|
||
# a simple weather dataset for illustration -- one day of 1-minute weather | ||
DATA_DIR = pathlib.Path(pvlib.__file__).parent / 'data' |
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 the downward spike due to DNI momentarily dropping to 0 in the weather data file? While it might be nice to highlight the read_bsrn
function here, the spike is the most noticeable thing in the results. My concern is that the people that would most benefit from this example are also the people most likely to be distracted by that spike.
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 don't like that spike either, but that was the only clear-sky day in the file. Would it be better to keep it simple and do a quick clear-sky simulation instead of using the BSRN data?
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 say yes but it's not a clear win and I certainly don't insist on it.
system = pvsystem.PVSystem(arrays=[array], inverter_parameters={'pdc0': 1}) | ||
mc = modelchain.ModelChain(system, loc, spectral_model='no_loss') | ||
|
||
_ = mc.run_model(weather) |
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 the underscore to suppress output? I'm not sure about sphinx-gallery, but the ipython directive will suppress output if you end the line in ;
. No big deal to keep it.
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.
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.
Have we previously discussed adding subsections to the Example Gallery?
Briefly, see the conversation starting here: #1077 (comment). I think if we agree on what the sections should be, it should be an easy change to make.
# Let's take a look at the tracker rotation curve it produces: | ||
|
||
# a simple weather dataset for illustration -- one day of 1-minute weather | ||
DATA_DIR = pathlib.Path(pvlib.__file__).parent / 'data' |
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 don't like that spike either, but that was the only clear-sky day in the file. Would it be better to keep it simple and do a quick clear-sky simulation instead of using the BSRN data?
system = pvsystem.PVSystem(arrays=[array], inverter_parameters={'pdc0': 1}) | ||
mc = modelchain.ModelChain(system, loc, spectral_model='no_loss') | ||
|
||
_ = mc.run_model(weather) |
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.
Let's defer example organization for now. I originally wanted to organize by object layer vs not object layer but perhaps other approaches (e.g. how do I do this?) are better. And I don't want to put the thought into it now. |
thanks @kanderso-nrel! |
Closes #xxxxTests addedUpdates entries todocs/sphinx/source/api.rst
for API changes.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.Rendered examples: