q-optimize/c3

View on GitHub
docs/c3.libraries.rst

Summary

Maintainability
Test Coverage
Libraries package
======================

Libraries contain a collection of functions that all share a signature to be used interchangably.
One entry of a library is selected in the corresponding config file.


Algorithms module
--------------------------------

.. automodule:: c3.libraries.algorithms
   :members:
   :undoc-members:
   :show-inheritance:

Chip module
--------------------------------

.. automodule:: c3.libraries.chip
   :members:
   :undoc-members:
   :show-inheritance:

Constants module
-------------------------------

.. automodule:: c3.libraries.constants
   :members:
   :undoc-members:
   :show-inheritance:

Envelopes module
-------------------------------

.. automodule:: c3.libraries.envelopes
   :members:
   :undoc-members:
   :show-inheritance:

Estimators module
--------------------------------

.. automodule:: c3.libraries.estimators
   :members:
   :undoc-members:
   :show-inheritance:

Fidelities module
--------------------------------

.. automodule:: c3.libraries.fidelities
   :members:
   :undoc-members:
   :show-inheritance:

Hamiltonians module
----------------------------------

.. automodule:: c3.libraries.hamiltonians
   :members:
   :undoc-members:
   :show-inheritance:

Sampling module
------------------------------

.. automodule:: c3.libraries.sampling
   :members:
   :undoc-members:
   :show-inheritance:

Tasks module
--------------------------------

.. automodule:: c3.libraries.tasks
   :members:
   :undoc-members:
   :show-inheritance:

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

.. automodule:: c3.libraries
   :members:
   :undoc-members:
   :show-inheritance: