cfdverify 0.0.3

Installation

To get the latest release of CFDverify, use pip pip install cfdverify. The latest release is hosted on the Python Package Index (PyPI) here.

If you prefer to install from the source, download this repository to a suitable location on your computer, (optionally) activate your environment, and install with pip.

git clone git@github.com:ORNL/cfd-verify.git
cd cfd-verify
source /path/to/your/venv/bin/activate
pip install .

To install dependencies for testing the code, install with the command pip install .[tests]. Likewise, to install documentation dependencies use the command pip install .[docs]. Alternatively, install all optional dependencies using the command pip install .[full]. The full installation includes additional helpful modules that a user will likely need for scientific computing workflow in the utilities optional dependency lists (e.g. ipykernel for running interactive Jupyter notebooks). Users new to scientific computing are recommended to use the full install.

Documentation

Documentation is available on Read the Docs.

To build CFDverify’s documentation locally, execute the command make html in the docs directory of CFDverify.

cd cfd-verify/docs
make html
# or make latexpdf to generate a PDF

The documentation can then be read using any web browser by opening the file cfd-verify/docs/build/html/index.html. Install CFDverify using pip install .[docs] to ensure you have all the required dependencies to build the documentation. If you choose to build a PDF version, you will need to make sure your system has the necessary LaTeX executables.

Testing

To run CFDverify’s tests, execute the command pytest in the top level of the CFDverify directory or in the tests sub-directory. Install CFDverify using pip install .[tests] to ensure you have all the required dependencies to run tests.

Issues

Please report all issues with CFDverify on the GitHub’s issues page.

Contributing

Contributions are encouraged! For more information, see the Development Process page in the documentation.

Citing

If you would like to cite CFDverify in an academic work beyond reference to the code repository, please use the 2025 American Society of Mechanical Engineers Verification, Validation, and Uncertainty Quantification Symposium conference paper which describes the need, design philosophy, and structure of CFDverify.

Author

Justin Weinmeister: <weinmeistejr@ornl.gov>