Installation

This guide applies to QF Solver 0.2.11. Release availability is authoritative on PyPI and GitHub Releases. The selected QF Solver 0.2.11 wheel and sdist are the audited PyPI release artifacts. Their exact hashes are recorded in the selected-release contract and checksum manifest. GitHub's automatically generated source archives are not part of the audited selected distribution. See What's New in 0.2.11 for the release scope and the capability index for maturity boundaries.

User installation

Install the published release from PyPI:

python -m pip install "qf-solver==0.2.11"
qf-solver --version

An unqualified clone follows the repository default branch; it is not a release selector. Select the immutable release tag explicitly when reproducibility matters:

git clone --branch v0.2.11 --single-branch https://github.com/emptiesvoid-cloud/QF_solver.git
cd QF_solver
python -m pip install .
qf-solver --version

The v0.2.11 tag is immutable and identifies the source used for the release. The default branch may advance and is not a release selector.

The published core package requires Python 3.10 or newer. The recommended public import is:

import qf_solver
print(qf_solver.__version__)

Optional extras

The optional extras are intended for specific workflows:

python -m pip install "qf-solver[mesh]"
python -m pip install "qf-solver[hdf5]"
python -m pip install "qf-solver[large]"
python -m pip install "qf-solver[hpc]"
python -m pip install "qf-solver[docs]"

mesh adds mesh tooling. hdf5 adds only the optional family-aware HDF5 result dependency. large adds HDF5 and MPI/PETSc support used by the large-model route. hpc adds the optional SLEPc integration. docs adds the MkDocs/MkDocs Material site builder and the controlled Markdown/PDF tooling. These extras describe optional workflows. They are not required for core import or small standard examples. Calling an HDF5 API without h5py raises a typed InfrastructureError; importing qf_solver does not require h5py.

The large and hpc extras expose Python bindings to native MPI, PETSc and SLEPc environments; they do not make those native runtimes universally installable through pip. The recorded PETSc/MPI environments are Linux conda/container setups, and native Windows compatibility is environment-specific and not guaranteed. The mixed distributed PETSc/MPI runtime remains NOT_VALIDATED.

From a repository checkout, the public documentation site can be built with:

python -m pip install ".[docs]"
python -m mkdocs build --strict -f .github/pages/mkdocs.yml

Development installation

For project development only:

git clone https://github.com/emptiesvoid-cloud/QF_solver.git
cd QF_solver
python -m pip install -e ".[test,dev]"

Development extras do not expand the qualified numerical scope. PETSc/MPI availability depends on the host and is reported explicitly by the relevant commands.

Distribution traceability data

The distribution selection retains the lightweight traceability set: the consolidated 46-record element-analysis registry and the HEX8-SRI, mixed-dynamics, mixed-MPC, mixed-multimaterial, .inp, mixed-HDF5 and contact owner/delivery records. Historical 0.2.7 capability metadata is retained separately.

Raw NPZ/HDF5 arrays, full campaign output, caches, debug artifacts and temporary files are intentionally excluded from package data. They remain repository evidence and are not required for importing or using the base package. Exact source selection, contents and artifact hashes are controlled by the matching release contract, not inferred from a default-branch build. Auditing a selected wheel/sdist does not clear the complete repository archive.