.. phlower documentation master file, created by
   sphinx-quickstart on Thu Mar 28 15:13:42 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Phlower : A Deep Learning Framework for Physical Phenomenon
=============================================================

*Phlower* is a deep learning framework based on PyTorch Ignite especially for physical phenomenon such as fluid dynamics.


Key Features
-------------

Tutorials are prepared for key features !

1. `Extended Tensor object which enables you to handle physics dimention <https://ricosjp.github.io/phlower/tutorials/basic_usages/01_phlower_tensor_basic.html>`_
2. `Model definition by yaml file <https://ricosjp.github.io/phlower/tutorials/basic_usages/02_model_definition_by_yaml_file.html>`_
3. `High Level API for scaling, training and predicion <https://ricosjp.github.io/phlower/tutorials/basic_usages/03_high_level_api_for_scaling_training_and_prediction.html>`_


.. include:: usage.rst


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

   usage
   reference/index
   tutorials/index


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

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