Adding some version limits to our Dependencies (#1660)

pyproject.toml

@@ -30,25 +30,23 @@ authors = [
     { name="TerraPower, LLC", email="armi-devs@terrapower.com" },
 ]
 dependencies = [
-    "configparser",
-    "coverage",
-    "h5py>=3.0,<=3.9",
-    "htmltree",
-    "matplotlib",
-    "numpy>=1.21,<=1.23.5",
-    "ordered-set",
-    "pillow",
-    "pluggy",
-    "pyDOE",
-    "pyevtk",
-    "ruamel.yaml<=0.17.21",
-    "ruamel.yaml.clib<=0.2.7",
-    "scipy",
-    "tabulate",
-    "toml>0.9.5",
-    "voluptuous",
-    "xlrd",
-    "yamlize==0.7.1",
+    "coverage>=7.2.0", # Code coverage tool. Sadly baked into every Case.
+    "docutils>=0.18.1", # Tools for processing docs into HTML
+    "h5py>=3.0,<=3.9", # Needed because our database files are H5 format
+    "htmltree>=0.7.6", # Our reports have HTML output
+    "matplotlib>=3.5.3", # Important plotting library
+    "numpy>=1.21,<=1.23.5", # Important math library
+    "ordered-set>=3.1.1", # A useful data structure
+    "pluggy>=1.2.0", # Central tool behind the ARMI Plugin system
+    "pyDOE>=0.3.8", # We import a Latin-hypercube algorithm to explore a phase space
+    "pyevtk>=1.2.0", # Handles binary VTK visualization files
+    "ruamel.yaml.clib<=0.2.7", # C-based core of ruamel below
+    "ruamel.yaml<=0.17.21", # Our foundational YAML library
+    "scipy>=1.7.0", # Used for curve-fitting and matrix math
+    "tabulate>=0.8.9", # Used to pretty-print tabular data
+    "toml>0.9.5", # Needed to parse the pyproject.toml file
+    "voluptuous>=0.12.1", # Used to validate YAML data files
+    "yamlize==0.7.1", # Custom YAML-to-object library
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -78,16 +76,14 @@ grids = ["wxpython==4.2.1"]
 memprof = ["psutil"]
 mpi = ["mpi4py"]
 test = [
-    "black==22.6.0",
-    "docutils",
-    "ipykernel",
-    "jupyter_client",
-    "nbconvert",
-    "pytest",
-    "pytest-cov",
-    "pytest-html",
-    "pytest-xdist",
-    "ruff==0.0.272",
+    "black==22.6.0", # Code formatter (version-pinned)
+    "ipykernel>=6.0.0", # IPython Kernel (We run test notebooks from the doc tutorials.)
+    "jupyter_client>=7.0.0", # Reference implementation of the Jupyter protocol
+    "nbconvert>=7.0.0", # Converting Jupyter Notebooks to other formats
+    "pytest>=7.0.0", # Our primary test tooling
+    "pytest-cov>=4.0.0", # coverage plugin
+    "pytest-xdist>=3.0.0", # To spread our tests over multiple CPUs
+    "ruff==0.0.272", # Linting and code formatting (version-pinned)
 ]
 docs = [
 #######################################################################
@@ -99,8 +95,8 @@ docs = [
 #
 # We are only building our docs with Python 3.9.
 #######################################################################
-    "Sphinx==5.3.0",
-    "docutils==0.18.1",
+    "Sphinx==5.3.0", # central library used to build our docs
+    "docutils==0.18.1", # Needed by sphinx-rtd-them
     "sphinx-rtd-theme==1.2.2", # Read-The-Docs theme for Sphinx
     "nbsphinx==0.9.2", # Parses Jupyter notebooks
     "nbsphinx-link==1.3.0", # Adds Jupyter NBs to Sphinx source root
@@ -114,7 +110,7 @@ docs = [
     "pylint==2.17.5", # Generates UML diagrams
     "Jinja2==3.0.3", # Used in numpydoc and nbconvert
     "sphinxcontrib-jquery==4.1", # Handle missing jquery errors
-    "jupyter-contrib-nbextensions",
+    "jupyter-contrib-nbextensions", # A collections of JS extensions for jupyter notebooks
     "lxml<5.0.0", # Needed because the dep above is no longer an active project
 ]