API Reference
=============

This section contains the detailed API reference for the modules in the *General Python Utilities* library. The documentation below is generated automatically by Sphinx using autodoc, listing the classes, functions, and constants available in each module.

Algebra Module
--------------

.. automodule:: general_python.algebra
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.algebra.utils
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.algebra.backend_linalg
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.algebra.solver
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.algebra.solvers
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.algebra.ode
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.algebra.preconditioners
   :members:
   :undoc-members:
   :show-inheritance:

Common Utilities
----------------

.. automodule:: general_python.common
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.common.directories
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.common.plot
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.common.datah
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.common.flog
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.common.binary
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.common.timer
   :members:
   :undoc-members:
   :show-inheritance:

Lattices Module
---------------

.. automodule:: general_python.lattices
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.lattices.lattice
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.lattices.square
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.lattices.hexagonal
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.lattices.triangular
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.lattices.honeycomb
   :members:
   :undoc-members:
   :show-inheritance:

Mathematics Module
------------------

.. automodule:: general_python.maths
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.maths.math_utils
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.maths.statistics
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.maths.random
   :members:
   :undoc-members:
   :show-inheritance:

Machine Learning Module
-----------------------

.. automodule:: general_python.ml
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.ml.networks
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.ml.schedulers
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.ml.training_phases
   :members:
   :undoc-members:
   :show-inheritance:

Physics Module
--------------

.. automodule:: general_python.physics
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.physics.density_matrix
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.physics.entropy
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.physics.operators
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.physics.statistical
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.physics.thermal
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.physics.eigenlevels
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: general_python.physics.entanglement_module
   :members:
   :undoc-members:
   :show-inheritance: