VorLap Documentation
===================

Generalized Vortex Overlap Fluid Structure Interaction Prediction Code

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   quickstart
   api/index
   examples
   contributing

Quick Start
-----------

To get started with VorLap:

TODO: Add quick start example

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

To install VorLap, first clone the repository and then run pip install on the folder. It is recommended to use an environment manager such as [conda](https://docs.conda.io/projects/conda/en/stable/index.html) or [venv](https://docs.python.org/3/library/venv.html).

```bash
git clone https://github.com/sandialabs/VorLap.git
pip install VorLap
```

Requirements
~~~~~~~~~~~~

* Python >= 3.8
* NumPy >= 1.21.0
* SciPy >= 1.7.0
* Pandas >= 1.5.0
* H5Py >= 3.0.0
* Plotly >= 5.15.0
* Matplotlib >= 3.5.0

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`