.. _api_reference:

AutoHF API Reference
=====================

Top-level API
-------------

.. currentmodule:: autohf

.. autoclass:: AutoHFHamiltonian
   :members:
   :undoc-members:
   :show-inheritance:

.. autofunction:: solve_hf

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

.. toctree::
   :maxdepth: 1

   autohf.terms

.. autohf.interfaces


Modules
-------

.. solver
   ______

   .. automodule:: autohf.solver
      :members:
      :undoc-members:
      :show-inheritance:

.. converters
   __________

   .. automodule:: autohf.converters
      :members:
      :undoc-members:
      :show-inheritance:

.. hamiltonian
   ___________

   .. automodule:: autohf.hamiltonian
      :members:
      :undoc-members:
      :show-inheritance:

input/output (io)
_________________

.. automodule:: autohf.io
   :members:
   :undoc-members:
   :show-inheritance:

options
_______

.. automodule:: autohf.options
   :members:
   :undoc-members:
   :show-inheritance:

.. rotation tools
   _______________

   .. automodule:: autohf.rotation_tools
      :members:
      :undoc-members:
      :show-inheritance:

tools
_____

.. automodule:: autohf.tools
   :members:
   :undoc-members:
   :show-inheritance: