Project structure
=================

Project has four sub-folders in the root directory:


#. ``src/fairmd/lipids``

   Main project package. Contains most of the project’s logic and API.

   :doc:`More info on fairmd-lipids <auto_gen/fairmd.lipids>`


#. ``tests``

   Pytest-based unit and regression tests.

   More :ref:`info on tests <unittesting>`.

#. ``docs``

   Documentation source files.

#. ``developer``

   Helper scripts and utilities for developers and CI/CD pipelines.
   It is not distributed with the package.

.. toctree::
   :maxdepth: 3

   auto_gen/fairmd.lipids
   auto_gen/developer
   miscsrc/unittesting.rst