API reference for NuQuLib
=========================

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

.. automodule:: nuqulib


Submodules
----------

angular\_momentum\_projection submodule
---------------------------------------

.. automodule:: nuqulib.angular_momentum_projection
   :members:
   :exclude-members: ProjectionRecord
   :show-inheritance:
   :undoc-members:

.. autoclass:: nuqulib.angular_momentum_projection.ProjectionRecord
   :show-inheritance:

ansatz submodule
---------------------

.. automodule:: nuqulib.ansatz
   :members:
   :show-inheritance:
   :undoc-members:

circuits submodule
-----------------------

.. automodule:: nuqulib.circuits
   :members:
   :show-inheritance:
   :undoc-members:

diagonalization submodule
-------------------------

.. automodule:: nuqulib.diagonalization
   :members:
   :show-inheritance:
   :undoc-members:

encoding submodule
-----------------------

.. automodule:: nuqulib.encoding
   :members:
   :show-inheritance:
   :undoc-members:

hatt\_mapper submodule
----------------------

.. automodule:: nuqulib.hatt_mapper
   :members:
   :show-inheritance:
   :undoc-members:

majoranaop submodule
--------------------

.. automodule:: nuqulib.majoranaop
   :members:
   :show-inheritance:
   :undoc-members:

mode\_based\_mapper submodule
-----------------------------

.. automodule:: nuqulib.mode_based_mapper
   :members:
   :show-inheritance:
   :undoc-members:

myutils submodule
----------------------

.. automodule:: nuqulib.myutils
   :members:
   :show-inheritance:
   :undoc-members:

nft\_opt\_method submodule
-------------------------------

.. automodule:: nuqulib.nft_opt_method
   :members:
   :show-inheritance:
   :undoc-members:

pairing\_hamiltonian submodule
-----------------------------------

.. automodule:: nuqulib.pairing_hamiltonian
   :members:
   :show-inheritance:
   :undoc-members:

operators submodule
-------------------

.. automodule:: nuqulib.operators
   :members:
   :show-inheritance:
   :undoc-members:

pairwise submodule
-----------------------

.. automodule:: nuqulib.pairwise
   :members:
   :show-inheritance:
   :undoc-members:

postselection submodule
----------------------------

.. automodule:: nuqulib.postselection
   :members:
   :show-inheritance:
   :undoc-members:

quantum\_algorithms submodule
----------------------------------

.. automodule:: nuqulib.quantum_algorithms
   :members:
   :show-inheritance:
   :undoc-members:


nuclear\_hamiltonian submodule
--------------------------------------

.. automodule:: nuqulib.nuclear_hamiltonian
   :members:
   :show-inheritance:
   :undoc-members:

vqe\_example\_pennylane submodule
--------------------------------------

.. automodule:: nuqulib.vqe_example_pennylane
   :members:
   :show-inheritance:
   :undoc-members: