.. THIS FILE WAS AUTOGENERATED BY GENERATE_API.PY. ANY CHANGES WILL BE OVERWRITTEN.

.. _API:

API
===

.. _analysis:
analysis
--------

.. automodule:: qnngds.analysis

fem
~~~

.. automodule:: qnngds.analysis.fem
    :members:
    :exclude-members:
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

tdgl
~~~~

.. automodule:: qnngds.analysis.tdgl
    :members:
    :exclude-members:
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

.. _decorator:
decorator
---------

.. automodule:: qnngds.decorator
    :members:
    :exclude-members:
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

.. _devices:
devices
-------

.. automodule:: qnngds.devices

diode
~~~~~

.. automodule:: qnngds.devices.diode
    :members:
    :exclude-members: basic, gated
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: basic

        .. image:: images/devices/diode/basic.png
            :alt: basic.png

    .. autofunction:: gated

        .. image:: images/devices/diode/gated.png
            :alt: gated.png

htron
~~~~~

.. automodule:: qnngds.devices.htron
    :members:
    :exclude-members: heater, multilayer, planar
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: heater

        .. image:: images/devices/htron/heater.png
            :alt: heater.png

    .. autofunction:: multilayer

        .. image:: images/devices/htron/multilayer.png
            :alt: multilayer.png

    .. autofunction:: planar

        .. image:: images/devices/htron/planar.png
            :alt: planar.png

nanowire
~~~~~~~~

.. automodule:: qnngds.devices.nanowire
    :members:
    :exclude-members: sharp, variable_length
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: sharp

        .. image:: images/devices/nanowire/sharp.png
            :alt: sharp.png

    .. autofunction:: variable_length

        .. image:: images/devices/nanowire/variable_length.png
            :alt: variable_length.png

ntron
~~~~~

.. automodule:: qnngds.devices.ntron
    :members:
    :exclude-members: sharp, slotted, smooth
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: sharp

        .. image:: images/devices/ntron/sharp.png
            :alt: sharp.png

    .. autofunction:: slotted

        .. image:: images/devices/ntron/slotted.png
            :alt: slotted.png

    .. autofunction:: smooth

        .. image:: images/devices/ntron/smooth.png
            :alt: smooth.png

resistor
~~~~~~~~

.. automodule:: qnngds.devices.resistor
    :members:
    :exclude-members: meander, meander_sc_contacts
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: meander

        .. image:: images/devices/resistor/meander.png
            :alt: meander.png

    .. autofunction:: meander_sc_contacts

        .. image:: images/devices/resistor/meander_sc_contacts.png
            :alt: meander_sc_contacts.png

resonator
~~~~~~~~~

.. automodule:: qnngds.devices.resonator
    :members:
    :exclude-members: meandered, pad, straight, transmission_line, transmission_line_resonator
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: meandered

        .. image:: images/devices/resonator/meandered.png
            :alt: meandered.png

    .. autofunction:: pad

        .. image:: images/devices/resonator/pad.png
            :alt: pad.png

    .. autofunction:: straight

        .. image:: images/devices/resonator/straight.png
            :alt: straight.png

    .. autofunction:: transmission_line

        .. image:: images/devices/resonator/transmission_line.png
            :alt: transmission_line.png

    .. autofunction:: transmission_line_resonator

        .. image:: images/devices/resonator/transmission_line_resonator.png
            :alt: transmission_line_resonator.png

snspd
~~~~~

.. automodule:: qnngds.devices.snspd
    :members:
    :exclude-members: basic, vertical
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: basic

        .. image:: images/devices/snspd/basic.png
            :alt: basic.png

    .. autofunction:: vertical

        .. image:: images/devices/snspd/vertical.png
            :alt: vertical.png

.. _experiment:
experiment
----------

.. automodule:: qnngds.experiment
    :members:
    :exclude-members:
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

.. _geometries:
geometries
----------

.. automodule:: qnngds.geometries
    :members:
    :exclude-members: angled_taper, euler_taper, fillet_90deg, fine_to_coarse, hyper_taper, optimal_hairpin, taper, tee, via
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: angled_taper

        .. image:: images/geometries/angled_taper.png
            :alt: angled_taper.png

    .. autofunction:: euler_taper

        .. image:: images/geometries/euler_taper.png
            :alt: euler_taper.png

    .. autofunction:: fillet_90deg

        .. image:: images/geometries/fillet_90deg.png
            :alt: fillet_90deg.png

    .. autofunction:: fine_to_coarse

        .. image:: images/geometries/fine_to_coarse.png
            :alt: fine_to_coarse.png

    .. autofunction:: hyper_taper

        .. image:: images/geometries/hyper_taper.png
            :alt: hyper_taper.png

    .. autofunction:: optimal_hairpin

        .. image:: images/geometries/optimal_hairpin.png
            :alt: optimal_hairpin.png

    .. autofunction:: taper

        .. image:: images/geometries/taper.png
            :alt: taper.png

    .. autofunction:: tee

        .. image:: images/geometries/tee.png
            :alt: tee.png

    .. autofunction:: via

        .. image:: images/geometries/via.png
            :alt: via.png

.. _layout:
layout
------

.. automodule:: qnngds.layout
    :members:
    :exclude-members:
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

.. _pads:
pads
----

.. automodule:: qnngds.pads
    :members:
    :exclude-members: array, quad_line, stack, vdp
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: array

        .. image:: images/pads/array.png
            :alt: array.png

    .. autofunction:: quad_line

        .. image:: images/pads/quad_line.png
            :alt: quad_line.png

    .. autofunction:: stack

        .. image:: images/pads/stack.png
            :alt: stack.png

    .. autofunction:: vdp

        .. image:: images/pads/vdp.png
            :alt: vdp.png

.. _pdk:
pdk
---

.. automodule:: qnngds.pdk
    :members:
    :exclude-members:
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

.. _sample:
sample
------

.. automodule:: qnngds.sample
    :members:
    :exclude-members: piece10mm, wafer100mm, wafer150mm
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: piece10mm

        .. image:: images/sample/piece10mm.png
            :alt: piece10mm.png

    .. autofunction:: wafer100mm

        .. image:: images/sample/wafer100mm.png
            :alt: wafer100mm.png

    .. autofunction:: wafer150mm

        .. image:: images/sample/wafer150mm.png
            :alt: wafer150mm.png

.. _test_structures:
test_structures
---------------

.. automodule:: qnngds.test_structures
    :members:
    :exclude-members: alignment_mark, circ_tlm, cross_bridge_kelvin_resistor, dose_defocus, etch_test, multilayer_alignment, rect_tlm, resolution_L, resolution_checkerboard, resolution_steps, resolution_test, resolution_waffle, vdp, vernier_comb, via_chain
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

    .. autofunction:: alignment_mark

        .. image:: images/test_structures/alignment_mark.png
            :alt: alignment_mark.png

    .. autofunction:: circ_tlm

        .. image:: images/test_structures/circ_tlm.png
            :alt: circ_tlm.png

    .. autofunction:: cross_bridge_kelvin_resistor

        .. image:: images/test_structures/cross_bridge_kelvin_resistor.png
            :alt: cross_bridge_kelvin_resistor.png

    .. autofunction:: dose_defocus

        .. image:: images/test_structures/dose_defocus.png
            :alt: dose_defocus.png

    .. autofunction:: etch_test

        .. image:: images/test_structures/etch_test.png
            :alt: etch_test.png

    .. autofunction:: multilayer_alignment

        .. image:: images/test_structures/multilayer_alignment.png
            :alt: multilayer_alignment.png

    .. autofunction:: rect_tlm

        .. image:: images/test_structures/rect_tlm.png
            :alt: rect_tlm.png

    .. autofunction:: resolution_L

        .. image:: images/test_structures/resolution_L.png
            :alt: resolution_L.png

    .. autofunction:: resolution_checkerboard

        .. image:: images/test_structures/resolution_checkerboard.png
            :alt: resolution_checkerboard.png

    .. autofunction:: resolution_steps

        .. image:: images/test_structures/resolution_steps.png
            :alt: resolution_steps.png

    .. autofunction:: resolution_test

        .. image:: images/test_structures/resolution_test.png
            :alt: resolution_test.png

    .. autofunction:: resolution_waffle

        .. image:: images/test_structures/resolution_waffle.png
            :alt: resolution_waffle.png

    .. autofunction:: vdp

        .. image:: images/test_structures/vdp.png
            :alt: vdp.png

    .. autofunction:: vernier_comb

        .. image:: images/test_structures/vernier_comb.png
            :alt: vernier_comb.png

    .. autofunction:: via_chain

        .. image:: images/test_structures/via_chain.png
            :alt: via_chain.png

.. _typing:
typing
------

.. automodule:: qnngds.typing
    :members:
    :exclude-members:
    :undoc-members:
    :show-inheritance:
    :special-members: __init__

.. _utilities:
utilities
---------

.. automodule:: qnngds.utilities
    :members:
    :exclude-members:
    :undoc-members:
    :show-inheritance:
    :special-members: __init__