Welcome to SQDMetal's documentation!
====================================

This is the documentation for the `SQDMetal` Python package. SQDMetal extends *Quantum-Metal* (formerly *Qiskit-Metal*) with the key components highlighted below:


.. toctree::
   :maxdepth: 1
   :caption: Simulations

   Worked examples <examples/index>
   Simulations using Palace <simulations/simpalace>
   Simulations using COMSOL <simulations/simcomsol>

.. toctree::
   :maxdepth: 1
   :caption: Helper utility modules

   Accounting for shadow evaporation <general/pvd>
   GDS Exporter and Manipulator <general/gds>
   Qubit Designer <general/qbd>
   Full Chip Maker <general/fcm>

.. toctree::
   :maxdepth: 1
   :caption: Custom components

   Component gallery <comps/Comps_All.ipynb>
   Component naming convention <comps/convention>

.. toctree::
   :maxdepth: 5
   :caption: API reference

   API reference <reference/index>