POEM: Performance pOlar Exchange forMat
=======================================

This document describes the **POEM File Format Specifications**.
It is proposed by `D-ICE ENGINEERING <https://www.dice-engineering.com/en>`_ to the Wind-Propulsion community and
is intended to provide a common efficient solution to store and manipulate multidimensional polar data tables
generated by Performance Prediction Programs or other means and used by Weather Routing optimization software,
embedded control systems, training simulators.

`POEM on GitHub <https://github.com/D-ICE/poem>`_

POEM Documentation
------------------

:doc:`documentation/poem_in_a_nuttshell`
    What is POEM

:doc:`documentation/poem_features`
    Specific POEM features

:doc:`documentation/poem_data_model`
    How data is organized in **POEM Files** and **POEM Library**

:doc:`documentation/poem_polar_modes`
    Different Polar modes in POEM

:doc:`documentation/poem_specifications`
    Specifications of a **POEM File**


POEM Usage
----------

:doc:`usage/cpp-lib`
    Using the C++ library

:doc:`usage/pypoem`
    Using the Python API


API
---

:doc:`api/cpp/index`
    C++ API

:doc:`api/python/index`
    Python API


.. Hidden TOCs

.. toctree::
    :caption: POEM Documentation
    :maxdepth: 2
    :hidden:

    documentation/poem_in_a_nuttshell
    documentation/poem_features
    documentation/poem_data_model
    documentation/poem_polar_modes
    documentation/poem_specifications

.. toctree::
    :caption: POEM Usage
    :maxdepth: 2
    :hidden:

    usage/cpp-lib
    usage/pypoem

.. toctree::
    :caption: API
    :maxdepth: 2
    :hidden:

    api/cpp/index
    api/python/index


Credits
-------

POEM is made Open Source with the support of the French Agency for Ecological Transition
(`OPERVENT project, 2024 <https://www.wind-ship.fr/projets-etudes>`_)

.. image:: _static/logo_ademe.png
   :height: 80px


.. Contact and Feedback
.. --------------------
..
.. For bug reports and feature requests, please contact francois.rongere@dice-engineering.com