Installation & optional extras
Install the public 0.2.11 release from PyPI with pip, pin the version, and choose only the integrations your workflow needs.
Source and release provenance · v0.2.11
docs/getting-started/installation.md ↗Install the public release
Python 3.10 or newer is required. QF Solver 0.2.11 is published on PyPI. Pin the version to keep the installation reproducible; the matching GitHub release provides the source tag and wheel.
python -m pip install "qf-solver==0.2.11"
qf-solver --versionOptional: install from the source tag
Use this path only if you specifically need the source checkout. It is a separate installation method from the PyPI command above.
git clone --branch v0.2.11 --single-branch https://github.com/emptiesvoid-cloud/QF_solver.git
cd QF_solver
python -m pip install .Optional integrations
Install optional extras from PyPI with the same version pin. The large and hpc extras also require compatible native MPI, PETSc or SLEPc runtimes.
| Extra | Purpose |
|---|---|
| mesh | Mesh tooling |
| hdf5 | Family-aware HDF5 result storage via h5py |
| large | HDF5 and MPI/PETSc bindings for large-model workflows |
| hpc | Optional SLEPc integration |
| docs | MkDocs and controlled documentation tooling |
python -m pip install "qf-solver[mesh]==0.2.11"
python -m pip install "qf-solver[hdf5]==0.2.11"Native runtime requirements
The core import and small examples do not require Docker, PETSc, MPI or HDF5. The large and hpc extras need suitable native MPI/PETSc/SLEPc runtimes. Recorded environments use Linux conda or containers; native Windows support depends on the environment.