.. CFD Mods documentation master file, created by
   sphinx-quickstart on Wed Sep  6 11:48:34 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

CFD Mod docs
============

`CFD Mod <https://github.com/AeroSim-CFD/cfdmod>`_ **is a collection of Python modules to assist a serve tools for simulation post-processing.** 

It features modules for **consulting use cases** in addition to providing **analysis tools** and an **API** 
for consuming externally or internally.

A brief list of the modules available can be found in the `Release notes <release_notes.html>`_

.. toctree::
   :maxdepth: 1
   :caption: Use Cases
   :hidden:

   Altimetry <use_cases/altimetry/index.rst>
   Loft <use_cases/loft/index.rst>
   S1 <use_cases/s1/index.rst>
   Roughness Elements <use_cases/roughness_gen/index.rst>
   Pressure <use_cases/pressure/index.rst>
   Snapshot <use_cases/snapshot/index.rst>

.. toctree::
   :maxdepth: 1
   :caption: Analysis
   :hidden:

   Inflow <analysis/inflow/index.rst>


.. toctree::
   :maxdepth: 1
   :caption: Others
   :hidden:

   Release Notes <release_notes.md>