Installation
The main dependencies of genericROM are:
python=3.8
The solid mechanics ROMs with nonlinear constitutive laws require the use of a constitutive law solver. Two optionnal constitutive law solvers can be used:
The user is responsible for the installation of these solvers and the acception of the terms of use defined in their respective licenses.
Once the required dependencies have been installed, and the genericROM repo downloaded, path/to/genericROM/src should be added to the PYTHONPATH environment variable.
Testing
There are two different type of tests, both using pytest and both checking non-regression by compararing the produced values with precomputed references.
Unit testing
Checks all functions and produces a coverage report.
cd path/to/genericROM
pytest tests --cov=src/genericROM --cov-report=html:path/to/bluid/html
Simplified use cases
Illustrates the functionalities of the library in complete use cases, sequential and parallel.
cd path/to/genericROM
pytest -m "not mpi" examples
mpirun -n 2 pytest -m "mpi" examples
Doc generation
The present sphinx web documentation can be generated from the main folder.
cd path/to/genericROM
python setup.py build_sphinx