.. api_type:: private
.. _private_api:

Private API Documentation
=========================
**NOTE**: This is the private API documentation for the ``tsunami_ip_utils`` package. This documentation is intended for developers who 
are working on the Tsunami IP Utils package itself. If you are a user of the ``tsunami_ip_utils`` package, you should refer to the 
:ref:`public_api` instead.


Subpackages
-----------

.. toctree::
   :maxdepth: 4

   tsunami_ip_utils.viz

Submodules
----------

tsunami\_ip\_utils.\_error module
---------------------------------

.. automodule:: tsunami_ip_utils._error
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members:

tsunami\_ip\_utils.comparisons module
-------------------------------------

.. automodule:: tsunami_ip_utils.comparisons
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members:

tsunami\_ip\_utils.config module
--------------------------------

.. automodule:: tsunami_ip_utils.config
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members:

tsunami\_ip\_utils.integral\_indices module
-------------------------------------------

.. automodule:: tsunami_ip_utils.integral_indices
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members:

tsunami\_ip\_utils.perturbations module
---------------------------------------

.. automodule:: tsunami_ip_utils.perturbations
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members:

tsunami\_ip\_utils.readers module
---------------------------------

.. automodule:: tsunami_ip_utils.readers
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members:

tsunami\_ip\_utils.utils module
-------------------------------

.. automodule:: tsunami_ip_utils.utils
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members:

tsunami\_ip\_utils.xs module
----------------------------

.. automodule:: tsunami_ip_utils.xs
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members:

Module contents
---------------

.. automodule:: tsunami_ip_utils
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members: