.. CelerisAi documentation master file, created by
   sphinx-quickstart on Wed Feb 19 10:37:10 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

CelerisAi
====================================

**CelerisAi** is Python-Taichi-based software for nearshore wave modeling. This solver offers high-performance simulations on various hardware platforms and seamlessly integrates with machine learning and artificial intelligence environments. The solver makes use of the flexibility of the Python language for customization and interoperability, while the Taichi implementation provides high-performance capabilities and facilitates integration into artificial intelligence environments such as PyTorch.

Check out the :doc:`usage` section for further information, including how to :ref:`install <installation>` the project for external use.

.. note::

   This project is under active development.


Code Documentation
**************************

.. toctree::
   :maxdepth: 3
   :caption: Contents:
   
   introduction
   usage
   modules
  

User Interface
**************************

.. toctree::
   :maxdepth: 3
   :caption: Contents:
   
   introduction
   usage
   modules