Document dependencies for running regression tests
BenWibking opened this issue · 6 comments
Python and several Python packages are needed to be able to run the regression tests:
numpy
scipy
h5py
matplotlib
unyt
I think we should add a requirements.txt
file with the required versions of these somewhere (https://pip.pypa.io/en/stable/reference/requirements-file-format/).
IIRC CMake should tell you that these modules are needed if not found.
If not, we should check why.
Can we define "optional" requirements (given that it's just for the test suite and not related to AthenaPK itself)?
IIRC CMake should tell you that these modules are needed if not found. If not, we should check why.
At least for unyt
, CMake doesn't do that.
It doesn't do it for numpy or matplotlib either, the tests just fail with:
ModuleNotFoundError: No module named 'numpy'
or
ModuleNotFoundError: No module named 'matplotlib'
Okay, so we should update our CMakeLists txt to use the
PARTHENON_ENABLE_PYTHON_MODULE_CHECK
and add the modules to the REQUIRED_PYTHON_MODULES
variable, cf. https://github.com/parthenon-hpc-lab/parthenon/blob/develop/tst/regression/CMakeLists.txt#L68
It works.