uclchem
=======

.. py:module:: uclchem

.. autoapi-nested-parse::

   UCLCHEM project entry.

   The UCLCHEM python module is divided into several parts:
    - :mod:`model` contains the functions for running chemical models under different physics.
    - :mod:`analysis` contains functions for reading output files as well
         as investigating the chemistry.
    - :mod:`plot` contains functions for plotting output files.
    - :mod:`advanced` provides access to Fortran modules, parameters, heating/cooling controls
         and advanced solver parameters.



Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   advanced/index.rst
   makerates/index.rst
   plot/index.rst


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   analysis/index.rst
   constants/index.rst
   debug/index.rst
   functional/index.rst
   model/index.rst
   style/index.rst
   tests/index.rst
   utils/index.rst
   version/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   uclchem.auto_initialize_coolant_directory



.. py:function:: auto_initialize_coolant_directory() -> bool

   Automatically initialize the coolant data directory for the Fortran module.

   This is a convenience wrapper around initialize_coolant_directory() that:
   - Attempts to locate coolant data files
   - Sets the coolant directory in the Fortran module if found
   - Logs warnings instead of raising exceptions if initialization fails

   This function is called automatically when the uclchem module is imported.

   :returns: True if initialization succeeded, False if it failed
   :rtype: bool

   .. rubric:: Examples

   >>> from uclchem.advanced.advanced_heating import auto_initialize_coolant_directory
   >>> if auto_initialize_coolant_directory():
   ...     print("Coolant data initialized successfully")
   ...
   Coolant data initialized successfully