quantum-metal 0.5.1__tar.gz

quantum_metal-0.5.1/LICENSE.txt

@@ -0,0 +1,203 @@
+                    Copyright 2017 IBM and its contributors
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 IBM and its contributors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

quantum_metal-0.5.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include requirements.txt
+include LICENSE.txt
+include README.md

quantum_metal-0.5.1/PKG-INFO

@@ -0,0 +1,460 @@
+Metadata-Version: 2.4
+Name: quantum-metal
+Version: 0.5.1
+Summary: Quantum Metal (formerly Qiskit Metal): superconducting quantum device design toolkit.
+Home-page: https://github.com/Qiskit/qiskit-metal
+Author: Qiskit Metal Development Team
+Author-email: Quantum Metal Community <qiskit-metal@qiskit.org>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/qiskit-community/qiskit-metal/
+Project-URL: Documentation, https://qiskit-community.github.io/qiskit-metal/
+Keywords: quantum,hardware,EDA,superconducting,qiskit
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: numpy>=1.23
+Requires-Dist: scipy>=1.10
+Requires-Dist: pandas>=1.5
+Requires-Dist: shapely>=2.0
+Requires-Dist: geopandas>=0.13
+Requires-Dist: networkx>=2.8
+Requires-Dist: jsonschema
+Requires-Dist: pyyaml
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: cycler
+Requires-Dist: requests
+Requires-Dist: jinja2
+Requires-Dist: addict
+Requires-Dist: gdstk
+Requires-Dist: pyqtgraph
+Provides-Extra: gui
+Requires-Dist: PySide6; extra == "gui"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0; extra == "docs"
+Requires-Dist: sphinx-design; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: qiskit-sphinx-theme; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: nbconvert; extra == "docs"
+Requires-Dist: graphviz; extra == "docs"
+Requires-Dist: pandoc; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: tox; extra == "test"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Quantum Metal (formerly: Qiskit Metal)
+[![License](https://img.shields.io/github/license/Qiskit/qiskit-metal.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)<!--- long-description-skip-begin -->[![Release](https://img.shields.io/github/release/Qiskit/qiskit-metal.svg?style=popout-square)](https://github.com/Qiskit/qiskit-metal/releases)<!--- long-description-skip-begin -->[![join slack](https://img.shields.io/badge/slack-@qiskit-yellow.svg?logo=slack&style=popout-square)](https://qisk.it/join-slack)[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4618153.svg)](https://doi.org/10.5281/zenodo.4618153) [Discord](https://discord.gg/kaZ3UFuq)
+
+>![Welcome to Qiskit Metal!](https://raw.githubusercontent.com/Qiskit/qiskit-metal/main/docs/images/zkm_banner.png 'Welcome to Qiskit Metal')
+> Quantum Metal is an open-source framework for engineers and scientists to design superconducting quantum devices with ease.
+
+
+
+
+## ⚠️ Transition Notice – Qiskit Metal → Quantum Metal (v0.5)
+
+As part of the **v0.5 release**, we are formally beginning the transition of the project:
+
+- **New project name:** Quantum Metal
+- **Current import path:** `qiskit_metal` (will remain until a follow-up PR)
+- **Repository rename:** This repository will soon be renamed to **`quantum-metal`**
+- **GitHub continuity:** We will keep the same repo, issues, stars, forks, and history
+- **PyPI transition:** `qiskit-metal` will remain available in a stable, archived state
+- **Future package:** `quantum-metal` (or similar) will be published after the import change PR
+
+This ensures a smooth, non-breaking transition for all existing users.
+
+
+## 🌐 Part of the Quantum Device Design Ecosystem
+
+Quantum Metal has graduated from being an IBM maintained project and is now one of the core tools in a growing community ecosystem for superconducting quantum device design and education, including:
+
+- **Quantum Device Workspace (QDW)** – https://qdw-ucla.squarespace.com/
+  Hosted annually at UCLA/USC with invited leaders in the field.
+  Recent speakers include: *Michel Devoret, Andreas Wallraff, Zlatko Minev, Eli Levenson-Falk.*
+  [Video recordings](https://www.youtube.com/@uclaqcsa)
+
+  [Sign for 2026](https://qdw-ucla.squarespace.com/qdw2026) to meet the community, learn from experts, and participate directly.*
+
+- **Quantum Device Consortium (QDC)** — an upcoming community organization that will maintain and evolve Quantum Metal as part of a shared ecosystem of tools (including SQUADDS, SQDMetal, scqubits, pyEPR, and many others).
+  *([Website and governance page](https://qdc-qcsa.vercel.app))* [Discord Channel here](https://discord.gg/kaZ3UFuq)
+
+
+## 🌱 From IBM to a Community-Maintained Project
+
+Originally developed at IBM, originated by **Dr. Zlatko K. Minev**, Qiskit Metal has, over the last two years, naturally transitioned into a **community-driven project** supported by multiple universities, research groups, labs, and individual contributors.
+
+This v0.5 release marks the formal graduation into that next phase of the project’s life.
+
+Development continues through the **QDC**, the community, and active maintainers, working in close collaboration with Zlatko Minev and contributors across QDW/QDC who are shaping this next chapter.
+
+---
+
+## 🙏 BIG THANK YOU to Community Contributors (PR #1002)
+
+This release is the result of a substantial collective effort.
+Our deepest thanks go to:
+
+**Sadman Ahmed Shanto**, **Abhishek Chakraborty**, **PositroniumJS**, **SamWolski**,
+**Nicolas Dirnegger**, **Eli Levenson-Falk**, and **Murat Can Sarıhan**
+
+for their extensive testing, debugging, patching, platform validation, and contributions to the massive PySide6 transition in PR #1002.
+
+We are grateful to all users, contributors, and maintainers who continue to move the project forward.
+
+
+
+<!-- ## Installation
+If you are interested in customizing your experience, or if you are unable to install qiskit-metal using the `pip install` instructions below, consider installing directly the source code, following the instructions in the [documentation](https://qiskit-community.github.io/qiskit-metal/installation.html) and/or the [installation instructions for developers](https://github.com/Qiskit/qiskit-metal/blob/main/README_Developers.md).
+
+For normal use, please continue reading.
+
+### The Qiskit Metal deployed package
+You can install Qiskit Metal via the pip tool (a python package manager).
+```bash
+pip install qiskit-metal
+```
+PIP will handle most of the dependencies automatically and you will always install the latest (and well-tested) version of the package.
+
+Some of the dependencies, namely pyside2 and geopandas, might require manual installation, depending on your specific system compatibility. If you encounter installation or execution errors, please refer first to the [FAQ](https://qiskit-community.github.io/qiskit-metal/faq.html).
+
+We recommend to install qiskit-metal in a conda environment or venv, to prevent version conflicts with pre-existing package versions.
+
+### Jupyter Notebook
+At this time, we recommend using Jupyter notebook/lab to be able to access all the Qiskit Metal features. Jupyter is not installed with the default dependencies, to accommodate those users intending to utilize a centralized or customized installation.
+
+If you require a fresh installation, please refer to either [anaconda.org](https://anaconda.org/) or [jupyter.org](https://jupyter.org/install).
+
+Unless you installed the entire `jupyter` package in your current environment, do not forget to create the appropriate kernel to make the environment (thus qiskit-metal) available to jupyter (instructions in the [FAQ](https://qiskit-community.github.io/qiskit-metal/faq.html)) -->
+
+## Installation
+
+During the transition to **Quantum Metal**, the package is still published on PyPI under the legacy name `qiskit-metal` until the import path is updated in a follow-up release. The instructions below ensure users can install the new **v0.5** release while keeping compatibility.
+
+If you prefer installing from source or contributing, please follow the developer installation guide in the [documentation](https://qiskit-community.github.io/qiskit-metal/installation.html) and/or the [developer README](https://github.com/Qiskit/qiskit-metal/blob/main/README_Developers.md).
+
+### Installing the Current Release (v0.5)
+
+For now, Quantum Metal v0.5 is **not** published on PyPI. The only way to install the updated version is directly **from source**. Clone the repository and install it locally.
+
+Continuous integration runs on **Python 3.11 and 3.12** across Linux (Ubuntu 24.04), macOS 15, and Windows, plus separate jobs for lint and docs. Sticking to those versions mirrors the CI-tested setup; on Ubuntu you may need extra system libs for Gmsh (see CI script).
+
+> **Key notes to keep in mind:**
+>
+> * Python **3.11/3.12** mirror the CI matrix; earlier 3.10 also works but isn’t CI-covered.
+> * macOS ARM users should avoid Python 3.12+ to prevent C/C++ toolchain errors.
+> * `uv` is the **preferred and fastest** method and avoids most scientific‑stack headaches.
+
+### Preferred: `uv` (fast, modern, reliable)
+First install `uv`, then clone the repository, use Python 3.11, set up the virtual environment, then install requirements and Quantum Metal.
+
+- **macOS / Linux (bash):**
+  ```bash
+  curl -LsSf https://astral.sh/uv/install.sh | sh
+  git clone https://github.com/qiskit-community/qiskit-metal.git quantum-metal
+  cd quantum-metal
+  uv python pin 3.11
+  uv venv
+  source .venv/bin/activate
+  uv pip install -r requirements.txt
+  uv pip install -e .
+  ```
+- **Windows (PowerShell):**
+  ```powershell
+  iwr https://astral.sh/uv/install.ps1 -UseBasicParsing | iex
+  git clone https://github.com/qiskit-community/qiskit-metal.git quantum-metal
+  cd quantum-metal
+  uv python pin 3.11
+  uv venv
+  .\.venv\Scripts\Activate.ps1
+  uv pip install -r requirements.txt
+  uv pip install -e .
+  ```
+On Ubuntu you may need system packages for Gmsh/Qt (see CI: `libglu1-mesa`, `libegl1-mesa-dev`), and on Windows/macOS ensure build tools/CLT are present if you add native extensions.
+
+### Option 2: Conda (best for binary-heavy scientific stacks)
+
+```bash
+conda create -n quantum-metal python=3.11
+conda activate quantum-metal
+pip install -r requirements.txt
+pip install -e .
+```
+
+### Option 3: Standard venv (simple, lightweight)
+
+```bash
+python3.11 -m venv qm_env
+source qm_env/bin/activate
+pip install --upgrade pip
+pip install -r requirements.txt
+pip install -e .
+```
+
+
+### Using Jupyter Notebook
+
+We recommend using Jupyter Notebook/Lab to access the full GUI and interactive features. If Jupyter is not installed in your environment, install it with:
+
+```bash
+pip install jupyterlab
+```
+
+If needed, add your environment as a Jupyter kernel:
+
+```bash
+python -m ipykernel install --user --name quantum-metal
+```
+
+## Quick Start: Creating Your First Quantum Component in Qiskit Metal:
+Now that Qiskit Metal is installed, it's time to begin working with it.
+We are ready to try out a quantum chip example, which is simulated locally using
+the Qiskit MetalGUI element. This is a simple example that makes a qubit.
+```python
+from qiskit_metal import designs, MetalGUI, open_docs, draw
+
+# Start a planar-chip quantum device design
+design = designs.DesignPlanar()
+design.chips.main.size.size_x = '11mm'
+design.chips.main.size.size_y = '9mm'
+print(design.chips.main)
+
+# Launch the Qiskit Metal GUI to interactively view, edit, and simulate the design
+gui = MetalGUI(design)
+
+# Create a new qubit form the library, a transmon, by creating an object of this class.
+from qiskit_metal.qlibrary.qubits.transmon_pocket import TransmonPocket
+# Let's also add a connector pad, called "a" with default options, you can overwrite them as dictionary keys
+q1 = TransmonPocket(design, 'Q1', options=dict(connection_pads=dict(a=dict())))
+
+# To see qubit, rebuild the design with this new qubit in place
+gui.rebuild()
+# Select for editing, highlight, and autoscale gui view
+gui.edit_component('Q1')
+gui.autoscale()
+
+# Change options.
+q1.options.pos_x      = '0.5 mm'
+q1.options.pos_y      = '0.25 mm'
+q1.options.pad_height = '90um'
+q1.options.pad_width  = '455um'
+q1.options.pad_gap    = '30 um'
+
+# Update the component geometry after changing the options.
+gui.rebuild()
+gui.autoscale()
+```
+
+![Example_Image!](https://raw.githubusercontent.com/Qiskit/qiskit-metal/main/docs/images/1_1_Birds_eye_view_of_Qiskit_Metal_example_image.jpg 'Example_Image')
+
+Get a list of all the qcomponents in QDesign and then zoom on them.
+```python
+all_component_names = design.components.keys()
+gui.zoom_on_components(all_component_names)
+```
+
+<!-- ```python
+# Lets the design automatically delete an existing component when you create a new component with the same name, so the new component replaces the old one.
+design.overwrite_enabled = True
+``` -->
+
+#### Closing the Qiskit Metal GUI.
+```python
+>>> gui.main_window.close()
+```
+
+A script is available [here](https://qiskit-community.github.io/qiskit-metal/tut/overview/1.1%20High%20Level%20Demo%20of%20Qiskit%20Metal.html), where we also show the overview of Qiskit Metal.
+
+## Community and Support
+
+#### Watch the recorded tutorials
+[![Video Tutorials](https://img.shields.io/badge/youtube-Video_Tutorials-red.svg?logo=youtube)](https://youtube.com/playlist?list=PLOFEBzvs-VvqHl5ZqVmhB_FcSqmLufsjb)
+
+The streaming will also be recorded and made available [here](https://www.youtube.com/playlist?list=PLOFEBzvs-VvqHl5ZqVmhB_FcSqmLufsjb) for offline review.
+
+#### Take part in the live tutorials and discussion
+Through June 2021 we are offering live tutorials and Q&A. [Sign up](https://airtable.com/shrxQEgKqZCf319F3) to receive an invite to the upcoming sessions.  The streaming will also be recorded and made available for offline review.  Find [here](https://github.com/Qiskit/qiskit-metal/blob/main/README_Tutorials.md) more details on schedule and use the Slack channel to give us feedback and to request the most relevant content to you.
+
+#### Get help: Slack
+[![join slack](https://img.shields.io/badge/slack-blue.svg?logo=slack)](https://qisk.it/join-slack)
+
+Use the slack channel.  Join [qiskit slack](https://qisk.it/join-slack) and then join the `#metal` channel to communicate with the developers and other participants.  You may also use this channel to inquire about collaborations.
+
+## Contribution Guidelines
+If you'd like to contribute to Qiskit Metal, please take a look at our
+[contribution guidelines](https://github.com/Qiskit/qiskit-metal/blob/main/CONTRIBUTING.md). This project adheres to Qiskit's [code of conduct](https://github.com/Qiskit/qiskit-metal/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+We use [GitHub issues](https://github.com/Qiskit/qiskit-metal/issues) for tracking requests and bugs. Please
+[join the Qiskit Slack community](https://qisk.it/join-slack)
+and use our [Qiskit Slack channel](https://qiskit.slack.com) for discussion and simple questions.
+For questions that are more suited for a forum we use the Qiskit tag in the [Stack Exchange](https://quantumcomputing.stackexchange.com/questions/tagged/qiskit).
+
+## Next Steps
+Now you're set up and ready to check out some of the other examples from our
+[Qiskit Metal Tutorials](https://github.com/Qiskit/qiskit-metal/blob/main/tutorials/) repository or [Qiskit Metal Documentation](https://qiskit-community.github.io/qiskit-metal/tut/).
+
+
+---
+
+# Big Picture Architecutre Overview
+
+### Diagram
+
+The **Qiskit Metal** codebase is organized into several key modules, each with a distinct role in enabling the design, analysis, and visualization of quantum circuits. Below is an overview of the primary components and their interactions, discussed deeper in the [Architecture Readme](README_Architecture.md) and the docs:
+
+```mermaid
+   %%{init: {"flowchart": {"htmlLabels": true}, 'theme':'forest'} }%%
+    graph TB
+        classDef core fill:#87cefa,stroke:#000000;
+        classDef gui fill:#FFDDC1,stroke:#000000;
+        classDef renderer fill:#DBB9FF,stroke:#000000;
+        classDef utility fill:#FFD700,stroke:#000000;
+        classDef design fill:#90EE90,stroke:#000000;
+        classDef analysis fill:#FFB6C1,stroke:#000000;
+
+        subgraph Qiskit_Metal
+            subgraph Core
+                QLibraryComponents["QLibrary Components"]
+                QDesign["QDesign"]
+                QComponent["QComponent"]
+                QRoute["QRoute"]
+                BaseQubit["BaseQubit"]
+            end
+
+            subgraph GUI
+                MetalGUI["MetalGUI"]
+            end
+
+            subgraph Renderers
+                QRenderer["QRenderer"]
+                QRendererGui["QRendererGui"]
+                QGDSRenderer["QGDSRenderer"]
+                QAnsysRenderer["QAnsysRenderer"]
+                QHFSSRenderer["QHFSSRenderer"]
+                QQ3DRenderer["QQ3DRenderer"]
+                QPyaedt["QPyaedt"]
+                QGmshRenderer["QGmshRenderer"]
+                QElmerRenderer["QElmerRenderer"]
+            end
+
+            subgraph Analyses
+                Hamiltonian["Hamiltonian"]
+                Sweep_Options["Sweep_Options"]
+            end
+
+            subgraph Utilities
+                Parsing["Parsing"]
+                Exceptions["Exceptions"]
+                Logging["Logging"]
+                Toolbox["Toolbox"]
+            end
+        end
+
+        QLibraryComponents --> QDesign
+        QRenderer --> QDesign
+        QRendererGui --> QRenderer
+        MetalGUI --> QRendererGui
+        MetalGUI --> QLibraryComponents
+        MetalGUI --> QDesign
+        QGDSRenderer --> QRenderer
+        QAnsysRenderer --> QRenderer
+        QHFSSRenderer --> QRenderer
+        QQ3DRenderer --> QRenderer
+        QPyaedt --> QRenderer
+        QGmshRenderer --> QRenderer
+        QElmerRenderer --> QRenderer
+        Parsing --> QDesign
+        Exceptions --> QDesign
+        Logging --> QDesign
+        Toolbox --> QDesign
+        QDesign --> QComponent
+        QDesign --> QRoute
+        QDesign --> BaseQubit
+        Hamiltonian --> QDesign
+        Sweep_Options --> QDesign
+
+        class QLibraryComponents,QDesign,QComponent,QRoute,BaseQubit core;
+        class MetalGUI gui;
+        class QRenderer,QRendererGui,QGDSRenderer,QAnsysRenderer,QHFSSRenderer,QQ3DRenderer,QPyaedt,QGmshRenderer,QElmerRenderer renderer;
+        class Parsing,Exceptions,Logging,Toolbox utility;
+        class Hamiltonian,Sweep_Options analysis;
+```
+
+
+### Core
+The **Core** module serves as the backbone of Qiskit Metal, housing essential elements for design and component creation:
+- **QLibrary Components**: Predefined library of quantum circuit elements, such as qubits and resonators, that can be used in designs.
+- **QDesign**: The central design framework that integrates all components and handles design rules.
+- **QComponent**: Base class for all components in the design.
+- **QRoute**: Specialized class for managing connections between components.
+- **BaseQubit**: Represents foundational qubit structures used in circuit designs.
+
+### Renderers
+The **Renderers** module facilitates exporting designs to external tools for electromagnetic simulation and layout rendering:
+- **QRenderer**: Base class for all renderers.
+- **QRendererGui**: GUI interface for managing renderers.
+- Specialized renderers like:
+  - **QGDSRenderer**
+  - **QAnsysRenderer**
+  - **QHFSSRenderer**
+  - **QQ3DRenderer**
+  - **QPyaedt**
+  - **QGmshRenderer**
+  - **QElmerRenderer**
+
+These renderers enable integration with industry-standard tools for detailed simulation and fabrication.
+
+### Analyses
+The **Analyses** module includes tools for performing simulations and extracting insights from designs:
+- **Hamiltonian**: Supports calculations of Hamiltonian parameters.
+- **Sweep Options**: Provides tools for parametric sweeps and optimizations.
+
+
+### GUI
+The **GUI** module provides tools for user-friendly interaction with Qiskit Metal. The **MetalGUI** clas is the primary graphical interface for managing designs and visualizations. It is discussed in more depth in the [Architecture Readme](README_Architecture.md).
+
+### Utilities
+The **Utilities** module supports the overall functionality of Qiskit Metal by offering supplementary tools.
+
+
+
+### Key Interactions
+- The **Core** modules form the foundation and integrate tightly with the **Renderers**, **GUI**, and **Analyses** modules.
+- The **GUI** depends on the **Core** and **Renderers** to provide visualization and interactivity.
+- The **Renderers** serve as bridges between Qiskit Metal and external tools, interacting with the **Core** to export designs.
+- The **Analyses** modules leverage the **Core** to extract meaningful data for optimization and validation.
+- The **Utilities** modules provide essential supporting functionalities across the entire codebase.
+
+This modular structure ensures scalability, flexibility, and ease of use for designing, analyzing, and fabricating quantum circuits.
+
+
+---
+
+# Backmatter
+
+## Authors and Citation
+Qiskit Metal is the work of [many people](https://github.com/Qiskit/qiskit-metal/pulse/monthly) who contribute to the project at different levels. Metal was conceived and developed by [Zlatko Minev](https://www.zlatko-minev.com) at IBM; then co-led with Thomas McConkey. If you use Qiskit Metal, please cite as per the included [BibTeX file](https://github.com/Qiskit/qiskit-metal/blob/main/Qiskit_Metal.bib). For icon attributions, see [here](https://github.com/Qiskit/qiskit-metal/blob/main/qiskit_metal/_gui/_imgs/icon_attributions.txt).
+
+## Changelog and Release Notes
+The changelog provides a quick overview of notable changes for a given release.
+
+The changelog for a particular release can be found in the correspondent Github release page. For example, you can find the changelog for the `0.0.4` release [here](https://github.com/Qiskit/qiskit-metal/releases/tag/0.0.4)
+
+The changelog for all releases can be found in the release page: [![Releases](https://img.shields.io/github/release/Qiskit/qiskit-metal.svg?style=popout-square)](https://github.com/Qiskit/qiskit-metal/releases)
+
+Additionally, as part of each release detailed release notes are written to document in detail what has changed as part of a release. This includes any documentation on potential breaking changes on upgrade and new features.
+
+## License
+[Apache License 2.0](https://github.com/Qiskit/qiskit-metal/blob/main/LICENSE.txt)