HQS Spin Mapper API Reference 
=========================================

This document contains the API reference documentation for HQS Spin Mapper.

.. autosummary::
   :toctree: generated/

   hqs_spin_mapper
   hqs_spin_mapper.spin_mapper_protocols
   hqs_spin_mapper.transformables
   hqs_spin_mapper.orbital_optimization
   hqs_spin_mapper.preconditioning
   hqs_spin_mapper.schrieffer_wolff
   hqs_spin_mapper.linear_algebraic_schrieffer_wolff
   hqs_spin_mapper.extract_couplings
   hqs_spin_mapper.struqture_interface

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Copyright © 2023-2025 HQS Quantum Simulations GmbH. All Rights Reserved.