.. LorenzCycleToolKit documentation master file, created by
   sphinx-quickstart on Tue Jul 16 08:16:48 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

LorenzCycleToolkit
==================

Welcome to the LorenzCycleToolkit documentation! This toolkit is designed to calculate the Lorenz Energy Cycle (LEC) for specific atmospheric regions.

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

   overview
   installation
   usage
   configuration
   file_naming_convention
   examples_and_tutorials
   results
   math
   contributing
   support
   license
   references