Welcome to TRIOMA's documentation 

Theory
======

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

   theory.md
   

For more detailed information, please refer to the `additional documentation <theory.md>`_.

Installation
============
To install TRIOMA, you can use the following command:
.. code-block:: bash

   pip install TRIOMA

TRIOMA API Documentation
===========================

In this section the documentation for all modules in TRIOMA:
  

Correlations
------------

.. automodule:: src.TRIOMA.tools.correlations
   :members:

Component Class
---------------
.. autoclass:: src.TRIOMA.tools.component_tools.Component
   :members:

Circuit Class
-------------
.. autoclass:: src.TRIOMA.tools.component_tools.Circuit
   :members:

Fluid Class 
-----------

.. autoclass:: src.TRIOMA.tools.component_tools.Fluid
   :members:

Membrane Class
--------------

.. autoclass:: src.TRIOMA.tools.component_tools.Membrane
   :members:

Solid Material Class
--------------------

.. autoclass:: src.TRIOMA.tools.component_tools.SolidMaterial
   :members:

Fluid Material Class
--------------------

.. autoclass:: src.TRIOMA.tools.component_tools.FluidMaterial
   :members:

Breeding Blanket Class
----------------------

.. autoclass:: src.TRIOMA.tools.component_tools.BreedingBlanket
   :members:

GLC Class
---------
.. autoclass:: src.TRIOMA.tools.component_tools.GLC
   :members:

GLC_Gas Class
-------------
.. autoclass:: src.TRIOMA.tools.component_tools.GLC_Gas
   :members: