Skip to main content
CFDverify logo

CFDverify

PyPI version Supported Python versions MIT License Documentation status

Efficient solution verification tools for computational fluid dynamics (CFD).

CFDverify is a python package designed to make verifying computational fluid dynamics (CFD) simulations easier! Solution verification is essential for trustworthy CFD results, but you need to spend your time running simulations, not fiddling with error analysis. CFDverify provides tested methods, batteries included! Check out the tutorial notebooks, use the provided utilities for easy plotting and output, or peruse the documentation to catch up on the theory. CFDverify is in early stages of development, so make sure to open an issue if it doesn’t have a feature you need; but, be warned, the interface may change unexpectedly until the first major release!

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>

Metadata

Release files for cfdverify 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cfdverify 0.0.3
File Size Uploaded Provenance Actions
cfdverify-0.0.3.tar.gz 45.8 kB Without provenance Details for cfdverify-0.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cfdverify 0.0.3
File Interpreter ABI Platform Actions
cfdverify-0.0.3-py3-none-any.whl Python 3 none any Details for cfdverify-0.0.3-py3-none-any.whl

Total release size: 66.8 kB

Release files / cfdverify-0.0.3.tar.gz

Download URL cfdverify-0.0.3.tar.gz
Size 45.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1d5ad812dc7c5d8559c4047774389c2df781f42e7142344a279bd78a3198bb30
BLAKE2b-256 checksum
How to use checksums
b041b6cde432811be2987622a9d362d8d4533595f32120addf1b26c9cf7d476d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.7

Release files / cfdverify-0.0.3-py3-none-any.whl

Download URL cfdverify-0.0.3-py3-none-any.whl
Size 21.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
99bd2a4080c7b13e7ed8242ca8b75731ffd2eb54bb97646f172d13a9f1d757d0
BLAKE2b-256 checksum
How to use checksums
2fed0b165f09ab22020c7c59569e7d831dd6df179356109ba066a351d299c5b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.7

Security for cfdverify 0.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page