-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Update tutorial notebooks for compat with current pvlib #999
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
@kanderso-nrel about Maybe that provides some clues? |
I think the link on the RTD index page is pointing to the current version on master, which I agree has some errors. I was trying to get the notebooks in this PR to recreate the versions on master, but I'm starting to think that the version of For tracking.ipynb, maybe we should leave it with some funky plots until we pick up #823 again? I suspect that implementing the method Mark and I worked out for non-parallel slope would solve those problems as a side effect. |
The CEC module parameters changed between the two notebooks. SAM used to supply a generic "Example Module", maybe it still does, but we're no longer using that module in the notebook or test fixtures, which I think is an improvement.
Agree. There's a lot of little edits I'd suggest but I don't know how to comment on the ipynb file, so OK for now.
Also agree. I've looked at the new notebooks. I agree that the PR meets its objective, that the notebooks work with pvlbi v0.7.2. Further improvement of the notebooks can be in different PRs. @kanderso-nrel what do you need next here? |
Thanks @cwhanse for going through the notebooks. I don't intend to make any more changes to this PR unless requested from reviewers. I do still think it's worth trying to add the notebooks to the CI testing using nbval, but figuring out the best way might take some iteration and I'd prefer to do that in another PR later. For now the notebooks can be tested with nbval locally if anyone cares to, which is a good step forward itself in addition to bringing the notebooks up to date with the current API. |
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 take #329 more seriously before we think about improving tooling around notebooks.
Updates 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.Here is an updated set of notebooks. I'll echo @mikofski's suggestion to use nbdime to review the changes. If you clone this branch, you can spawn a handy visual diff between commits in the browser with
nbdiff-web 065e10c 97c6698 docs\tutorials\atmosphere.ipynb
I also made some other changes unrelated to pvlib compat -- semicolons to suppress matplotlib output text and such. I also removed the section in
tmy.ipynb
that called out to the RREDC website (see #996). Lastly, I made the notebooks work with the nbval pytest plugin (added comments like# NBVAL_SKIP
for cells that shouldn't be tested) -- runpytest --nbval docs\tutorials\atmosphere.ipynb
if you want to check it out.I am aware of two remaining issues, neither of which I have investigated yet. I would not be upset if someone else figures out what's going on with these before I do :)