Skip to content
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

Replace pvfactors with solarfactors #1797

Merged
merged 5 commits into from
Jul 5, 2023
Merged

Conversation

kandersolar
Copy link
Member

@kandersolar kandersolar commented Jul 1, 2023

  • Closes latest version of pvfactors cannot be installed with pvlib 0.10.0 #1796
  • I am familiar with the contributing guidelines
  • [ ] Tests added
  • [ ] Updates entries in docs/sphinx/source/reference 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 (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.
  • TODO: update pvfactors_timeseries docstring

I've got a first release of solarfactors up on PyPI, with the important feature of not requiring pvlib<0.10. Other than pip installing a different name, it should be a transparent replacement for pvfactors as far as pvlib is concerned. So hopefully just by changing the dependency name, the tests and docs build should pass without any other changes being needed.

If so, I think we could proceed with making a v0.10.1 release with this update.

@kandersolar kandersolar marked this pull request as ready for review July 3, 2023 13:49
@kandersolar
Copy link
Member Author

@pvlib/pvlib-core this is ready for review. I suggest we merge this and release v0.10.1.

Copy link
Member

@wholmgren wholmgren left a comment

Choose a reason for hiding this comment

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

Works as expected!

$ conda create -n pvlib101 python=3.11
$ conda activate pvlib101
$ pip install "pvlib[optional] @ git+ssh://git@github.com/kandersolar/pvlib-python.git@solarfactors"
$ python
>>> import pvlib  # this takes ~10-20 seconds in a new environment!?
>>> pvlib.__version__  # probably need a git fetch --tags
'0.9.2a3.dev106+g8d38d65'
>>> import solarfactors
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'solarfactors'
>>> import pvfactors
>>> pvfactors.__version__
'1.5.3'

Copy link
Member

@AdamRJensen AdamRJensen left a comment

Choose a reason for hiding this comment

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

This is a bit complicated lingo: "pip install solarfactors installs a package that is still accessed in code with the original import pvfactors."

Also, I think most users would appreciate a more explicit reason for why we switched to pvfactors - i.e., state that pvfactors is not being maintained

@kandersolar kandersolar merged commit c063992 into pvlib:main Jul 5, 2023
@kandersolar kandersolar deleted the solarfactors branch July 5, 2023 13:59
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.

latest version of pvfactors cannot be installed with pvlib 0.10.0
3 participants