terrapower / armi

An open-source nuclear reactor analysis automation framework that helps design teams increase efficiency and quality
https://terrapower.github.io/armi/
Apache License 2.0
224 stars 87 forks source link

Updating installation instructions for PIP version limitation #1664

Closed john-science closed 6 months ago

john-science commented 6 months ago

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

john-science commented 6 months ago

@caiodallaqua I have made your requested improvement to the docs in this PR: https://github.com/terrapower/armi/issues/1639#issuecomment-1944123338