.. AeroSim's Documentation documentation master file, created by
   sphinx-quickstart on Wed Sep 28 13:22:52 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

AeroSim's documentation
=======================

**AeroSim is a CFD (computational fluid-dynamics) solver.** 
It uses **LBM (lattice Boltzmann-method)** to run high performance CFD simulations.

To check all other AeroSim's documentations:

* :external+nassu:doc:`Nassu <index>`: LBM solver behind AeroSim's web interface, runs the bulk of the simulation
* :external+validation:doc:`Validation <index>`: Validation portfolio of AeroSim's solvers, with cases and results
* :external+cfdmod:doc:`CFDmod <index>`: Python API for pre and post processing of simulation cases


.. toctree::
   :caption: Installation
   :maxdepth: 1

   Getting AeroSim <aerosim/getting-aerosim.md>
   Requirements <aerosim/requirements.md>
   Installation <aerosim/installation.md>


.. toctree::
   :caption: Getting Started
   :maxdepth: 1

   Creating a Project <aerosim/getting-started/creating-project.md>
   Configuring a Simulation <aerosim/getting-started/configuring-simulation.md>
   Running a Simulation <aerosim/getting-started/running-simulation.md>
   Visualizing Results <aerosim/getting-started/visualizing-results.md>


.. toctree::
   :caption: Guided Cases
   :maxdepth: 1

   ABL (Atmospheric Boundary Layer) <aerosim/guided-cases/ABL.md>
   Pressure Measurement on Buildings (CAARC) <aerosim/guided-cases/pressure-buildings-caarc.md>
   Pedestriam Comfort (AIJ Niigata) <aerosim/guided-cases/pedestriam-comfort.md>
   Topography Factor (Bolund Hill) <aerosim/guided-cases/topography-factor.md>


.. toctree::
   :caption: Guidelines & Best Practices
   :maxdepth: 1

   Matching Custom Inlet <aerosim/guidelines/matching-custom-inlet.md>
   Pressure Coefficient Measurement <aerosim/guidelines/pressure-coefficient-measurement.md>
   Structural Load from Simulation <aerosim/guidelines/structural-load-from-simulation.md>


.. toctree::
   :caption: References
   :maxdepth: 2

   Reference <aerosim/reference/index>