Install the required packages and libraries
conda env create -f environment.yml
conda env activate helmholtz-solver
pip install -e .Install the git hook scripts
pre-commit installnow pre-commit will run automatically on git commit .
Ensure the test optional dependencies are installed.
Run tests with
pytest test/The documentation of this project can be read here.
Ensure the doc optional dependencies are installed.
To build the documentation locally run
pytest --cov=src/nos --cov-report html:doc/source/_static/codecov test/
sphinx-apidoc -f -o doc/source/ hsc
sphinx-build -M html doc/source doc/buildThese commands build a coverage report for the project, automatically documents the project using docstrings and builds
the documentation.
The build documentation can then be found in doc/build/html. Open the index.html to access it.