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

Project has four sub-folders inside `Databank/Scripts`:


DatabankLib
-----------

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

:doc:`More info on DatabankLib <auto_gen/Scripts.DatabankLib>`


AnalyzeDatabank
---------------

Scripts that perform analysis of the entire databank.

:doc:`More info on AnalyzeDatabank <auto_gen/Scripts.AnalyzeDatabank>`


BuildDatabank
-------------

Scripts related to adding new simulations into the databank.

:doc:`More info on BuildDatabank <auto_gen/Scripts.BuildDatabank>`


updateGUI
---------

Functionality for updating the GUI of the NMRLipids Databank.

:doc:`More info on updateGUI <auto_gen/Scripts.updateGUI>`


tests
-----

Pytest-based unit and regression tests.

:doc:`More info on tests <auto_gen/Scripts.tests>`


Repository folder structure 
---------------------------

.. toctree::
   :maxdepth: 3
   

   auto_gen/Scripts