Verify Install¶
Use this page after installation, on a new workstation, or after loading a new HPC environment. The goal is to confirm that PhAST can import, see the expected optional backends, and validate a public configuration before launching a full solve.
Environment Doctor¶
Run:
python -m phast doctor
The command reports:
Python, PyTorch, CUDA, and MPS availability;
core packages such as NumPy, SciPy, Gmsh, meshio, Zarr, and ffmpeg;
optional sparse-direct backends such as PETSc/MUMPS and cuDSS;
the backend selected by
backend: autoon the current machine;recommended defaults by problem class.
Typical CPU/macOS output begins like:
PhAST environment doctor
==================================
Python: 3.10.x
PyTorch: 2.x
CUDA: False
MPS: True
Core packages:
numpy: ...
scipy: ...
gmsh: ...
meshio: ...
Backend availability is machine-dependent. Missing PETSc/MUMPS or cuDSS is not an installation failure unless the workflow you intend to run requires that backend.
Validate A Public Configuration¶
Before launching a full run, validate one public example:
python -m phast run examples/dynamic/B2_kalthoff_winkler/config.yaml --validate-only
Expected output:
OK: examples/dynamic/B2_kalthoff_winkler/config.yaml passes schema validation.
This check confirms that the YAML parser, schema validation, material presets, and example path resolution are working without allocating the full solver.
Inspect A Setup¶
For a human-readable setup summary, run:
python -m phast explain-config examples/dynamic/B2_kalthoff_winkler/config.yaml
Use this output to confirm the material, geometry, solver type, output settings,
and device.compile policy before running a costly simulation.
Common Outcomes¶
Outcome |
Meaning |
Next step |
|---|---|---|
|
Portable CPU sparse-direct fallback is available. |
Good for small or moderate sparse checks. |
|
MUMPS is not active in this environment. |
Install a consistent PETSc/petsc4py/MUMPS stack only if needed. |
|
PyTorch cannot see an NVIDIA GPU. |
Use CPU validation or install a CUDA-compatible PyTorch wheel. |
|
Apple Silicon acceleration is visible. |
Prefer CPU float64 for verification-sensitive fracture runs. |
Validation passes |
The config is structurally valid. |
Run the example with an explicit |
If these checks fail, use Troubleshooting before opening an issue.