.. FrameIt documentation master file, created by
   sphinx-quickstart on Wed Jan 21 07:36:11 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


FrameIt |release| documentation
===============================

.. toctree::
   :maxdepth: 1
   :caption: What is FrameIt

   what_is_frameit

.. toctree::
   :maxdepth: 2
   :caption: Getting started

   getting_started/installation
   getting_started/quick_start

.. toctree::
   :maxdepth: 2
   :caption: User guide

   user_guide/input_files
   user_guide/configuration_file
   user_guide/output_files


.. toctree::
   :maxdepth: 2
   :caption: Tracker

   tracker/prescribed_track
   tracker/pressure_wind_tracker
   tracker/utrack
   tracker/fixed_box

.. toctree::
   :maxdepth: 2
   :caption: Polar projection

   polar_projection/xESMF_proj

.. toctree::
   :maxdepth: 2
   :caption: Visualization tools

   visualization_tools/rotate_polar_axes

.. toctree::
   :maxdepth: 2
   :caption: Developper section

   developper/how_to_add_my_tracker