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

Updating installation instructions for PIP version limitation #1664

Merged
merged 1 commit into from Mar 12, 2024

Conversation

john-science
Copy link
Member

What is the change?

Updating the installation docs to explicitly state the PIP version limitation.

Why is the change being made?

ARMI depends on the pyproject.toml feature set, which is not fully supported until pip>=22.1 (which was released in May 2022). So, this version limit is mandatory.

Notes

@albeanth :

  1. This is a SCR-like change, because the "User Installation" guide is part of our official documentation.
  2. All our downstream projects already explicitly state the pip>=22.1 dependency limit; so no change needs to be made to those projects.

Checklist

  • The release notes have been updated if necessary.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in pyproject.toml.

@john-science john-science added the documentation Improvements or additions to documentation label Mar 12, 2024
@john-science
Copy link
Member Author

@caiodallaqua I have made your requested improvement to the docs in this PR: #1639 (comment)

Copy link
Member

@albeanth albeanth left a comment

Choose a reason for hiding this comment

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

Seems reasonable enough to me. So instead of the stub file @ntouran suggests, we're enforcing a min version of pip. This enforcement aligns with at least one of our internal projects, so no problems on that front.

@john-science john-science merged commit b9f1f13 into main Mar 12, 2024
21 checks passed
@john-science john-science deleted the pip_install_guide branch March 12, 2024 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ARMI cannot be installed in editable mode with pip<22.1
2 participants