Metadata-Version: 2.5
Name: cfdverify
Version: 0.0.3
Summary: A package to conduct solution verification for CFD
Project-URL: Homepage, https://github.com/ORNL/cfd-verify
Project-URL: Issues, https://github.com/ORNL/cfd-verify/issues
Author-email: Justin Weinmeister <weinmeistejr@ornl.gov>
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scipy
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Provides-Extra: full
Requires-Dist: ipykernel; extra == 'full'
Requires-Dist: pytest; extra == 'full'
Requires-Dist: sphinx; extra == 'full'
Requires-Dist: sphinx-rtd-theme; extra == 'full'
Provides-Extra: tests
Requires-Dist: pytest; extra == 'tests'
Provides-Extra: utilities
Requires-Dist: ipykernel; extra == 'utilities'
Description-Content-Type: text/x-rst

.. image:: branding/cfdverify_wordmark.svg
   :align: center
   :width: 500px
   :alt: CFDverify logo

CFDverify
=========

|pypi| |pyversions| |license| |docs|

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 <https://github.com/ORNL/cfd-verify/issues>`_ if it doesn't have a feature you need; but, be warned, the interface may change unexpectedly until the first major release!

.. note::

    CFDverify does not come with any certifications or quality guarantees. Before using CFDverify in your work, make sure you review your work requirements and perform any quality assurance work necessary. 

.. warning::

    Verification and validation (V&V) of computational models is non-trivial. While every effort has been made to make CFDverify user friendly, the documentation alone is not sufficient to understand how to run a specific computational model or apply V&V to that model.

Installation
------------

To get the latest release of CFDverify, use pip :code:`pip install cfdverify`. The latest release is hosted on the Python Package Index (PyPI) `here <https://pypi.org/project/cfdverify/>`_.

If you prefer to install from the `source <https://github.com/ORNL/cfd-verify>`_, download this repository to a suitable location on your computer, (optionally) activate your environment, and install with pip.

.. code-block:: bash

    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 :code:`pip install .[tests]`. Likewise, to install documentation dependencies use the command :code:`pip install .[docs]`. Alternatively, install all optional dependencies using the command :code:`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 <https://cfd-verify.readthedocs.io>`_.

To build CFDverify's documentation locally, execute the command :code:`make html` in the docs directory of CFDverify.

.. code-block:: bash

    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 :code:`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 :code:`pytest` in the top level of the CFDverify directory or in the tests sub-directory. Install CFDverify using :code:`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 <https://github.com/ORNL/cfd-verify/issues>`_.

Contributing
------------

Contributions are encouraged! For more information, see the `Development Process page <https://cfd-verify.readthedocs.io/en/latest/development.html>`_ 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 <https://doi.org/10.1115/VVUQ2025-151463>`_ which describes the need, design philosophy, and structure of CFDverify. 


Author
------

Justin Weinmeister: <weinmeistejr@ornl.gov>

.. |pypi| image:: https://img.shields.io/pypi/v/cfdverify.svg
   :target: https://pypi.org/project/cfdverify/
   :alt: PyPI version

.. |pyversions| image:: https://img.shields.io/pypi/pyversions/cfdverify.svg
   :target: https://pypi.org/project/cfdverify/
   :alt: Supported Python versions

.. |license| image:: https://img.shields.io/pypi/l/cfdverify.svg
   :target: https://github.com/ORNL/cfd-verify/blob/main/LICENSE
   :alt: MIT License

.. |docs| image:: https://img.shields.io/readthedocs/cfd-verify
   :target: https://cfd-verify.readthedocs.io
   :alt: Documentation status
