pytest-vivarium 0.1.0__tar.gz

pytest_vivarium-0.1.0/.readthedocs.yaml

@@ -0,0 +1,37 @@
+# Paths are repo-root-relative even when this file lives in a subdirectory,
+# so the package path must be qualified with libs/pytest-vivarium/.
+#
+# This file is read by RTD only when the pytest-vivarium RTD
+# project's Admin > Advanced Settings > "Path for .readthedocs.yaml" points
+# here. The root-level /.readthedocs.yaml is a placeholder used by the
+# import wizard and ignored for any project that has overridden the path.
+version: 2
+
+sphinx:
+  configuration: libs/pytest-vivarium/docs/source/conf.py
+  fail_on_warning: true
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.13"
+  jobs:
+    post_checkout:
+      - git fetch --unshallow origin 2>/dev/null || git fetch origin main
+      # Cancel PR (external) builds that don't touch this lib (Exit 183 is RTD's
+      # signal to cancel the build immediately).
+      - |
+        if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet "origin/main...HEAD" -- libs/pytest-vivarium/; then
+          echo "Skipping docs build: this PR changes nothing under libs/pytest-vivarium/."
+          exit 183
+        fi
+
+python:
+  install:
+    - method: pip
+      path: libs/pytest-vivarium
+      extra_requirements:
+        - docs
+
+formats:
+  - pdf

pytest_vivarium-0.1.0/CHANGELOG.rst

@@ -0,0 +1,5 @@
+**0.1.0 - 07/23/26**
+
+ - Initial release: pytest plugin extracted from vivarium-testing-utils,
+   providing the slow/weekly/cluster markers, the memory-aware -n auto worker
+   cap, and the no_gbd_cache fixture.

pytest_vivarium-0.1.0/Jenkinsfile

@@ -0,0 +1,40 @@
+/* This Jenkinsfile simply loads the `reusable_pipeline` pipeline from the
+vivarium-build-utils package, which lives at ``libs/build-utils/`` inside the
+``ihmeuw/vivarium-suite`` monorepo (https://github.com/ihmeuw/vivarium-suite).
+
+vivarium-build-utils is loaded as a Jenkins shared library
+(https://www.jenkins.io/doc/book/pipeline/shared-libraries/).
+Jenkins shared library convention dictates that importable modules must be stored
+in the 'vars' folder.
+
+Jenkins shared libraries can be configured in the Jenkins UI:
+* Manage Jenkins
+  * Configure System
+    * Global Pipeline Libraries section
+      * Library subsection
+        * Name: The Name for the lib
+        * Version: The branch you want to use. Throws an error
+                   for nonexistent branches.
+        * Project Repository: Url to the shared lib
+        * Credentials: SSH key to access the repo
+
+Note that updating the shared repo will take effect on the next pipeline invocation.
+*/
+
+// Load the get_vbu_version function from build-utils/bootstrap/
+// (the directory to load from is defined in the Jenkins shared library configuration)
+@Library("get_vbu_version@main") _
+
+// Load the full vivarium_build_utils library at the expected version
+library("vivarium_build_utils@${get_vbu_version()}")
+
+reusable_pipeline(
+    scheduled_branches: [
+        // Add additional branches for cron jobs below.
+        // Note: Newly added branches will require a manual trigger of the first build
+        // for subsequent scheduled builds to run.
+        "main",
+    ],
+    skip_doc_build: true,
+    env_reqs: "ci_jenkins",
+)

pytest_vivarium-0.1.0/LICENSE

@@ -0,0 +1,27 @@
+BSD 3-Clause License
+
+Copyright 2024 Institute for Health Metrics and Evaluation
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list
+   of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this
+   list of conditions and the following disclaimer in the documentation and/or other
+   materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may
+   be used to endorse or promote products derived from this software without specific
+   prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pytest_vivarium-0.1.0/Makefile

@@ -0,0 +1,101 @@
+# Check if we're running in Jenkins
+ifdef JENKINS_URL
+# 	Files are already in workspace from shared library
+	MAKE_INCLUDES := .
+else
+# 	For local dev, use the installed vivarium.build_utils package if it exists
+# 	First, check if we can import vivarium.build_utils and assign 'yes' or 'no'.
+# 	We do this by importing the package in python and redirecting stderr to the null device.
+# 	If the import is successful (&&), it will print 'yes', otherwise (||) it will print 'no'.
+	VIVARIUM_BUILD_UTILS_AVAILABLE := $(shell python -c "import vivarium.build_utils" 2>/dev/null && echo "yes" || echo "no")
+# 	If vivarium.build_utils is available, get the makefiles path or else set it to empty
+	ifeq ($(VIVARIUM_BUILD_UTILS_AVAILABLE),yes)
+		MAKE_INCLUDES := $(shell python -c "from vivarium.build_utils.resources import get_makefiles_path; print(get_makefiles_path())")
+	else
+		MAKE_INCLUDES :=
+	endif
+endif
+
+# Set the package name as the last part of this file's parent directory path
+PACKAGE_NAME = $(notdir $(CURDIR))
+
+ifneq ($(MAKE_INCLUDES),) # not empty
+# Include makefiles from vivarium.build_utils
+include $(MAKE_INCLUDES)/base.mk
+include $(MAKE_INCLUDES)/test.mk
+else # empty
+# Use this help message (since the vivarium.build_utils version is not available)
+help:
+	@echo
+	@echo "For Make's standard help, run 'make --help'."
+	@echo
+	@echo "Most of our Makefile targets are provided by the vivarium.build_utils"
+	@echo "package. To access them, you need to create a development environment first."
+	@echo
+	@echo "make build-env"
+	@echo
+	@echo "USAGE:"
+	@echo "  make build-env [name=<environment name>] [py=<python version>] [artifactory_access=<yes|no>]"
+	@echo
+	@echo "ARGUMENTS:"
+	@echo "  name [optional]"
+	@echo "      Name of the conda environment to create (defaults to <PACKAGE_NAME>)"
+	@echo "  py [optional]"
+	@echo "      Python version (defaults to latest supported)"
+	@echo "  artifactory_access [optional]"
+	@echo "      Whether the build host can reach the IHME artifactory. Either 'yes'"
+	@echo "      (default) or 'no'; use 'no' to build off-VPN without artifactory."
+	@echo
+	@echo "After creating the environment:"
+	@echo "  1. Activate it: 'conda activate <environment_name>'"
+	@echo "  2. Run 'make help' again to see all newly available targets"
+	@echo
+endif
+
+build-env: # Create a new environment with installed packages
+#	Validate arguments - exit if unsupported arguments are passed
+	@allowed="name py artifactory_access"; \
+	for arg in $(filter-out build-env,$(MAKECMDGOALS)) $(MAKEFLAGS); do \
+		case $$arg in \
+			*=*) \
+				arg_name=$${arg%%=*}; \
+				if ! echo " $$allowed " | grep -q " $$arg_name "; then \
+					allowed_list=$$(echo $$allowed | sed 's/ /, /g'); \
+					echo "Error: Invalid argument '$$arg_name'. Allowed arguments are: $$allowed_list" >&2; \
+					exit 1; \
+				fi \
+				;; \
+		esac; \
+	done
+	
+#   Handle arguments and set defaults
+#	name
+	@$(eval name ?= $(PACKAGE_NAME))
+#	python version - validate if specified, else get default from json file
+	@supported_versions=$$(python -c "import json; print(' '.join(json.load(open('python_versions.json'))))" 2>/dev/null || echo ""); \
+	if [ -n "$(py)" ] && ! echo "$$supported_versions" | grep -q "$(py)"; then \
+		echo "Error: Python version '$(py)' is not supported. Available: $$(echo $$supported_versions | sed 's/ /, /g')" >&2; \
+		exit 1; \
+	fi
+	@$(eval py ?= $(shell python -c "import json; print(max(json.load(open('python_versions.json')), key=lambda x: tuple(map(int, x.split('.')))))"))
+#	artifactory_access
+	@$(eval artifactory_access ?= yes)
+	@case "$(artifactory_access)" in \
+		yes|no) ;; \
+		*) echo "Error: 'artifactory_access' must be 'yes' or 'no', got '$(artifactory_access)'" >&2; exit 1 ;; \
+	esac
+
+	conda create -n $(name) python=$(py) --yes
+# 	Bootstrap vivarium.build_utils into the new environment
+	conda run -n $(name) pip install vivarium-build-utils
+# 	artifactory_access=no passes an empty IHME_PYPI, which clears base.mk's EXTRA_INDEX_FLAGS
+	conda run -n $(name) make install $(if $(filter no,$(artifactory_access)),IHME_PYPI=)
+
+	@echo
+	@echo "Finished building environment"
+	@echo "  name: $(name)"
+	@echo "  python version: $(py)"
+	@echo
+	@echo "Don't forget to activate it with:"
+	@echo "conda activate $(name)"
+	@echo

pytest_vivarium-0.1.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: pytest-vivarium
+Version: 0.1.0
+Summary: Shared pytest configuration and fixtures for Vivarium projects.
+Author-email: The vivarium developers <vivarium.dev@gmail.com>
+License: BSD-3-Clause
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: BSD
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Education
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: vivarium-dependencies[numpy,pytest]
+Requires-Dist: vivarium-build-utils<5.0.0,>=4.0.0
+Requires-Dist: vivarium-config-tree
+Provides-Extra: cluster
+Provides-Extra: test
+Provides-Extra: docs
+Requires-Dist: vivarium-dependencies[docutils,sphinx]; extra == "docs"
+Provides-Extra: interactive
+Provides-Extra: lint
+Requires-Dist: vivarium-dependencies[lint]; extra == "lint"
+Provides-Extra: dev
+Requires-Dist: pytest-vivarium[docs,interactive,lint,test]; extra == "dev"
+Provides-Extra: ci-github
+Requires-Dist: pytest-vivarium[docs,lint,test]; extra == "ci-github"
+Provides-Extra: ci-jenkins
+Requires-Dist: pytest-vivarium[ci_github,cluster]; extra == "ci-jenkins"
+Dynamic: license-file
+
+===============
+pytest-vivarium
+===============
+
+A `pytest <https://docs.pytest.org/>`_ plugin providing the shared test
+configuration used across the Institute for Health Metrics and Evaluation's
+Simulation Science team's `Vivarium <https://vivarium-engine.readthedocs.io/en/latest/>`_
+projects: the ``slow``/``weekly``/``cluster`` markers and their ``--runslow`` /
+``--runweekly`` / ``--slurm-project`` options, a memory- and CPU-aware ceiling on
+``pytest -n auto`` xdist workers, and the ``no_gbd_cache`` fixture.
+
+It is one of the libraries in the
+`vivarium-suite <https://github.com/ihmeuw/vivarium-suite>`_ monorepo.
+
+**Supported Python versions: 3.10, 3.11**
+
+Installation
+------------
+
+.. code-block:: console
+
+   $ pip install pytest-vivarium
+
+pytest discovers the plugin automatically via its ``pytest11`` entry point; there
+is nothing to import or enable.
+
+Documentation
+-------------
+
+Check out the `documentation <https://pytest-vivarium.readthedocs.io/en/latest/>`_
+for the full list of markers, options, and fixtures.

pytest_vivarium-0.1.0/README.rst

@@ -0,0 +1,31 @@
+===============
+pytest-vivarium
+===============
+
+A `pytest <https://docs.pytest.org/>`_ plugin providing the shared test
+configuration used across the Institute for Health Metrics and Evaluation's
+Simulation Science team's `Vivarium <https://vivarium-engine.readthedocs.io/en/latest/>`_
+projects: the ``slow``/``weekly``/``cluster`` markers and their ``--runslow`` /
+``--runweekly`` / ``--slurm-project`` options, a memory- and CPU-aware ceiling on
+``pytest -n auto`` xdist workers, and the ``no_gbd_cache`` fixture.
+
+It is one of the libraries in the
+`vivarium-suite <https://github.com/ihmeuw/vivarium-suite>`_ monorepo.
+
+**Supported Python versions: 3.10, 3.11**
+
+Installation
+------------
+
+.. code-block:: console
+
+   $ pip install pytest-vivarium
+
+pytest discovers the plugin automatically via its ``pytest11`` entry point; there
+is nothing to import or enable.
+
+Documentation
+-------------
+
+Check out the `documentation <https://pytest-vivarium.readthedocs.io/en/latest/>`_
+for the full list of markers, options, and fixtures.

pytest_vivarium-0.1.0/docs/Makefile

@@ -0,0 +1,22 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = pytest_vivarium
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	rm -rf build/*

pytest_vivarium-0.1.0/docs/nitpick-exceptions

@@ -0,0 +1,4 @@
+# Add "py:class <target>" entries here for cross-references that Sphinx's
+# nitpicky mode cannot resolve. Empty for now: these docs are narrative-only,
+# so no autodoc-generated type references need suppressing. Populate this when
+# the package starts auto-documenting its API.

pytest_vivarium-0.1.0/docs/source/conf.py

@@ -0,0 +1,235 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import importlib.metadata
+
+from docutils.nodes import Text
+from sphinx.ext.intersphinx import missing_reference
+
+# -- Project information -----------------------------------------------------
+
+project = "pytest-vivarium"
+author = "The vivarium developers"
+copyright = "2023, Institute for Health Metrics and Evaluation"
+
+version = importlib.metadata.version("pytest-vivarium")
+release = version
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+
+needs_sphinx = "4.0"
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.doctest",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+
+html_theme_path = ["_theme"]
+html_theme = "sphinx_rtd_theme"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    "**": [
+        "globaltoc.html",  # needs 'show_related': True theme option to display
+        "searchbox.html",
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = f"{project}doc"
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (
+        master_doc,
+        f"{project}.tex",
+        f"{project} Documentation",
+        author,
+        "manual",
+    ),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, f"{project}", f"{project} Documentation", [author], 1)]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        f"{project}",
+        f"{project} Documentation",
+        author,
+        project,
+        "Shared pytest configuration and fixtures for Vivarium projects.",
+        "Miscellaneous",
+    ),
+]
+
+# Other docs we can link to
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "pandas": ("https://pandas.pydata.org/docs/", None),
+    "tables": ("https://www.pytables.org/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "networkx": ("https://networkx.org/documentation/stable/", None),
+    "vivarium_engine": ("https://vivarium-engine.readthedocs.io/en/latest/", None),
+    "vivarium_research": ("https://vivarium-research.readthedocs.io/en/latest/", None),
+}
+
+
+# -- Autodoc configuration ------------------------------------------------
+
+autodoc_default_options = {
+    # Automatically document members (e.g. classes in a module,
+    # methods in a class, etc.)
+    "members": True,
+    # Order of items documented is determined by the order
+    # of appearance in the source code
+    "member-order": "bysource",
+    # Generate docs even if an item has no docstring.
+    "undoc-members": True,
+    # Don't document things with a leading underscore.
+    "private-members": False,
+}
+# Display type hints in the description instead of the signature.
+autodoc_typehints = "description"
+
+
+# -- nitpicky mode --------------------------------------------------------
+# Ensures that all references in the docs resolve.
+
+nitpicky = True
+
+nitpick_ignore = []
+for line in open("../nitpick-exceptions"):
+    if line.strip() == "" or line.startswith("#"):
+        continue
+    dtype, target = line.split(None, 1)
+    target = target.strip()
+    nitpick_ignore.append((dtype, target))
+
+
+# Fix sphinx warnings when for literal Ellipses in type hints.
+def setup(app):
+    app.connect("missing-reference", __sphinx_issue_8127)
+
+
+def __sphinx_issue_8127(app, env, node, contnode):
+    reftarget = node.get("reftarget", None)
+    if reftarget == "..":
+        node["reftype"] = "data"
+        node["reftarget"] = "Ellipsis"
+        text_node = next(iter(contnode.traverse(lambda n: n.tagname == "#text")))
+        replacement_node = Text("...", "")
+        if text_node.parent is not None:
+            text_node.parent.replace(text_node, replacement_node)
+        else:  # e.g. happens in rtype fields
+            contnode = replacement_node
+        return missing_reference(app, env, node, contnode)

pytest_vivarium-0.1.0/docs/source/index.rst

@@ -0,0 +1,47 @@
+===============
+pytest-vivarium
+===============
+
+``pytest-vivarium`` is a `pytest <https://docs.pytest.org/>`_ plugin providing the
+shared test configuration used across the
+`vivarium-suite <https://github.com/ihmeuw/vivarium-suite>`_ monorepo and the
+Institute for Health Metrics and Evaluation's Simulation Science team's model
+repositories. Installing it as a test dependency auto-registers everything below
+via pytest's ``pytest11`` entry point - there is nothing to import.
+
+Markers and options
+--------------------
+
+``slow``
+    Mark a test as slow. Skipped unless ``--runslow`` is passed.
+
+``weekly``
+    Mark a test as part of the weekly suite. Skipped unless ``--runweekly`` is
+    passed or it is the designated slow-test day (Sunday).
+
+``cluster``
+    Mark a test as requiring a SLURM cluster. Skipped automatically when
+    ``sbatch`` is not on the ``PATH``. ``--slurm-project`` sets the SLURM project
+    (default ``proj_simscience``).
+
+Bounded ``-n auto`` workers
+---------------------------
+
+The plugin implements ``pytest_xdist_auto_num_workers`` so that ``pytest -n auto``
+does not oversubscribe large shared nodes. The worker count targets a small
+ceiling and is clamped to the process's usable CPUs and to the memory available
+to it - reading both node free memory and any cgroup (for example a SLURM
+``--mem``) limit. The resolved plan is printed in the run header.
+
+The ``no_gbd_cache`` fixture
+----------------------------
+
+``no_gbd_cache`` disables ``vivarium_gbd_access`` caching for test isolation. It
+is not ``autouse``; wrap it in an ``autouse`` fixture in your own ``conftest.py``
+to apply it broadly.
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+
+   self