############################################################################################################
Qiskit Metal | Quantum Device Design & Analysis (Q-EDA) |version|
############################################################################################################

.. attention::

    This is an alpha version of Qiskit Metal, the code is still under development.
    Please let us know about anything you might want us to add or elaborate upon in the
    Slack channel `#metal <https://qiskit.slack.com/archives/C01R8KP5WP7>`_ in the `qiskit workspace <https://qisk.it/join-slack>`_.

.. hint::
    You can open this documentation using

    .. code-block:: python

        import qiskit_metal
        qiskit_metal.open_docs()

.. image:: images/logo1.png
   :alt: Missing Logo Diagram

.. rubric:: **About**

**Qiskit Metal | for quantum device design & analysis (`Qiskit Metal`)**
is an open-source framework (and library) for the design of superconducting quantum
chips and devices.
Call it quantum EDA (Q-EDA) and analysis. Qiskit Metal is:

* Open source
* Community-driven
* A python API and a front-end visual GUI interface
* Leverages existing tools and aims to seamlessly interconnect for quantum analysis
* licensed under Apache 2.0. IBM reserves no copyright over outputs of qiskit-metal.
* Community-oriented and tutorial-driven, join the `#metal <https://qiskit.slack.com/archives/C01R8KP5WP7>`_ Slack.


Use the slack channel.  Join `qiskit slack <https://qisk.it/join-slack>`_ and
then join the `#metal <https://qiskit.slack.com/archives/C01R8KP5WP7>`_ channel to communicate with the developers and other participants.
You may also use this channel to learn about upcoming weekly tutorials and to inquire about potential collaborations.


.. rubric:: **Live tutorials and Q&A**:
We host live tutorials and Q&A sessions.  Announcements for future tutorials are posted in the #metal channel.

.. rubric:: **Qiskit Metal Vision**:

Designing quantum devices is the bedrock of the quantum ecosystem,
but it is a difficult, multi-step process that connects traditionally disparate worlds.
Metal is automating and streamlining this process.
Our vision is to develop a community-driven universal platform capable
of orchestrating quantum chip development from concept to fabrication in
a simple and open framework.

We want to accelerate, and to lower the barrier to, innovation of  quantum devices.
Today at the IEEE Quantum Week Conference, the team discussed their vision for this first-of-its-kind project. Led by quantum physicist Zlatko Minev and
developed with other IBM Quantum team members, this project is meant for those interested in quantum hardware design: a suite of design automation
tools that can be used to devise and analyze superconducting devices, with a focus on being able to integrate the best tools into a quantum hardware
designer’s workflow. We’ve code-named the project Qiskit Metal.

We hope that as a community, we might make the process of quantization — bridging the gap between pieces of a superconducting metal on a quantum chip
with the computational mathematics of Hamiltonians and Hilbert spaces — available to anyone with a curious mind and a laptop. We want to make quantum
device design a streamlined process that automates the laborious tasks as it does with conventional electronic device design. We are writing software
with built-in best practices and cutting-edge quantum analysis techniques, all this while seamlessly leveraging the power of conventional EDA tools.
The goal of Qiskit Metal is to allow for easy quantum hardware modeling with reduction of design-related errors plus increased speed.

(read the full `Medium blog <https://medium.com/qiskit/what-if-we-had-a-computer-aided-design-program-for-quantum-computers-4cb88bd1ddea>`_)

**Qiskit Metal consists of four foundational elements:**

    - Quantum Device Design (QDesign): :ref:`qdesign`
    - Quantum Device Components (QComponent): :ref:`qlibrary`
    - Quantum Renderer (QRenderer): :ref:`qrenderer`
    - Quantum Analysis (QAnalysis): :ref:`qanalysis`

.. toctree::
    :maxdepth: 2
    :hidden:

    Home<self>
    Installing Qiskit Metal<installation>
    Frequently Asked Questions<faq>
    Metal Workflow<workflow>

.. TODO: Add Getting Started With Metal between Metal Workflow and Installing Qiskit Metal

.. toctree::
    :maxdepth: 2
    :caption: Contributor Guide
    :hidden:

    Contributor Guide<contributor-guide>


.. toctree::
    :maxdepth: 2
    :caption: Tutorials
    :hidden:

    Tutorials<tut/index>
    Video Recordings<https://www.youtube.com/playlist?list=PLOFEBzvs-VvqHl5ZqVmhB_FcSqmLufsjb>

.. toctree::
    :maxdepth: 2
    :caption: Circuit Example Library
    :hidden:

    Circuit Examples<circuit-examples/index>

.. toctree::
    :maxdepth: 2
    :caption: Libraries
    :hidden:

    All Quantum Devices<apidocs/qlibrary>

.. toctree::
    :maxdepth: 2
    :caption: API References
    :hidden:

    Overview<overview>
    QDesigns<apidocs/designs>
    QComponents<apidocs/qlibrary>
    Analyses<apidocs/analyses>
    QRenderes<apidocs/renderers>
    Toolbox<apidocs/toolbox_metal>
    QGeometry<apidocs/qgeometries>
    GUI<apidocs/gui>

.. toctree::
    :titlesonly:
    :hidden:

    Code of Conduct<https://github.com/Qiskit/qiskit/blob/master/CODE_OF_CONDUCT.md>

.. Hiding - Indices and tables
   :ref:`genindex`
   :ref:`modindex`
   :ref:`search`