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

Update requirements to require scikit-learn and purge old requirements #204

Merged
merged 8 commits into from
Nov 30, 2022

Conversation

freemansw1
Copy link
Member

@freemansw1 freemansw1 commented Nov 17, 2022

Resolves #119 and #196.

Specific actions

  • Removes pytables and cf-units from our dependencies (both are used by our dependencies, but not by us directly)
  • Renames conda-requirements.txt to requirements.txt as that seems to be the standard (I cannot find reference to conda-requirements.txt anywhere)
  • Adds requirements to setup.py such that pip install . installs dependencies as well.

Standard questions

  • Have you followed our guidelines in CONTRIBUTING.md?
  • Have you self-reviewed your code and corrected any misspellings?
  • Have you written documentation that is easy to understand?
  • Have you written descriptive commit messages?
  • Have you added NumPy docstrings for newly added functions?
  • Have you formatted your code using black?
  • If you have introduced a new functionality, have you added adequate unit tests?
  • Have all tests passed in your local clone?
  • If you have introduced a new functionality, have you added an example notebook?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes from this branch been merged?

@freemansw1 freemansw1 added this to the Version 1.5 milestone Nov 17, 2022
@freemansw1 freemansw1 added the enhancement Addition of new features, or improved functionality of existing features label Nov 17, 2022
This was linked to issues Nov 17, 2022
@freemansw1 freemansw1 requested review from snilsn and removed request for fsenf November 17, 2022 20:36
@codecov
Copy link

codecov bot commented Nov 17, 2022

Codecov Report

Base: 41.01% // Head: 41.01% // No change to project coverage 👍

Coverage data is based on head (aded93d) compared to base (e9cfd86).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##           RC_v1.5.0     #204   +/-   ##
==========================================
  Coverage      41.01%   41.01%           
==========================================
  Files             14       14           
  Lines           2321     2321           
==========================================
  Hits             952      952           
  Misses          1369     1369           
Flag Coverage Δ
unittests 41.01% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@freemansw1
Copy link
Member Author

freemansw1 commented Nov 17, 2022

Note that the requirements in setup.py do not match those in requirements.txt because cartopy builds through pip appear to be broken, and our black runner depends on pip install . working. Removing cartopy is probably obvious, but this also required removing iris, because iris depends on cartopy.

Copy link
Collaborator

@snilsn snilsn left a comment

Choose a reason for hiding this comment

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

Good job @freemansw1, makes sense to me. There is a minor issue that I have found.

The README.md still references the old name of requirements.txt:

conda install -c conda-forge --yes --file conda-requirements.txt

@freemansw1
Copy link
Member Author

Good catch! I've updated this.

Copy link
Collaborator

@snilsn snilsn left a comment

Choose a reason for hiding this comment

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

Great! Approving this now

Copy link
Member

@JuliaKukulies JuliaKukulies left a comment

Choose a reason for hiding this comment

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

Great update @freemansw1!

setup.py Show resolved Hide resolved
@JuliaKukulies
Copy link
Member

All right, approved!

And sorry that I missed your very clear comment on cartopy and iris! You are probably right that we can not do much about that.

@freemansw1
Copy link
Member Author

All right, approved!

And sorry that I missed your very clear comment on cartopy and iris! You are probably right that we can not do much about that.

No worries! It is a bit odd, and I do worry that this will cause us headaches when putting things onto PyPI (#192), but it's the solution that we have for now.

@freemansw1
Copy link
Member Author

I had to resolve a merge conflict with #191 merged in. @JuliaKukulies or @snilsn can you give this a quick look-over again and then I will merge?

@snilsn
Copy link
Collaborator

snilsn commented Nov 30, 2022

Looks good and ready to be merged @freemansw1!

@freemansw1 freemansw1 merged commit 39c14d0 into tobac-project:RC_v1.5.0 Nov 30, 2022
@freemansw1
Copy link
Member Author

Thanks!

@freemansw1 freemansw1 deleted the requirements_update branch November 30, 2022 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Addition of new features, or improved functionality of existing features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add scikit-learn as a requirement? Pytables dependency removal
3 participants