.. D-region-ion-scheme documentation master file, created by
   sphinx-quickstart on Thu Oct 30 14:15:26 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

LIR-ACheM documentation
=================================

This project is the implementation of an ion scheme to model the D-region ions' and electron's dynamics during solar flares, and the computation of the resulting HF absorption.

.. note::
   This project is under active development. The description of each function and their requirements is available in :ref:`functions`. An additional example of how to use this library and some results are available in the repository through the\ ``Example_use``\ Jupyter notebook.

.. note::
   Throughout the code and the documentation, all quantities are in units of\ ``cm``\ and\ ``s``\. The only exceptions are the altitudes and scale-height, which are given in\ ``km``\.


Contents
----------------------

.. toctree::
   :caption: Introduction

   source/Introduction/introduction
   source/Introduction/quickstart
   source/Introduction/class_definition

.. toctree::
   :caption: Chemistry in the D-region

   source/Model/model
   source/Model/initialisation
   source/Model/flux_absorption
   source/Model/ionisation
   source/Model/ion_initialisation

.. toctree::
   :caption: HF absorption

   source/HF_absorption/collision_frequencies
   source/HF_absorption/HF_absorption_computation

.. toctree::
   :caption: Additional ressources

   source/Introduction/references
   source/functions

Note:
-----------

LIR-ACheM stands for Lower Ionosphere Region - Absorption & Chemistry Modelling. It has been written by P. Teysseyre and C. Briand (LIRA, Observatoire de Paris, Université PSL, Sorbonne Université, Université Paris Cité, CY Cergy Paris Université, CNRS, Meudon, France)