{"id":13536144,"url":"https://github.com/qiskit-community/qiskit-metal","last_synced_at":"2026-06-01T02:06:01.984Z","repository":{"id":37077369,"uuid":"312331045","full_name":"qiskit-community/qiskit-metal","owner":"qiskit-community","description":"Quantum Hardware Design. Open-source project for engineers and scientists to design superconducting quantum devices with ease. ","archived":false,"fork":false,"pushed_at":"2025-01-20T00:48:12.000Z","size":106265,"stargazers_count":312,"open_issues_count":151,"forks_count":223,"subscribers_count":31,"default_branch":"main","last_synced_at":"2025-05-06T22:49:38.541Z","etag":null,"topics":["device","eda","gds","hamiltonian","quantum","quantum-computing","qubits","simulation-modeling","superconducting"],"latest_commit_sha":null,"homepage":"https://qiskit-community.github.io/qiskit-metal/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qiskit-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-12T16:19:21.000Z","updated_at":"2025-05-04T16:17:17.000Z","dependencies_parsed_at":"2023-09-26T05:43:49.336Z","dependency_job_id":"63200b54-7505-4390-b305-b5dd7dccee30","html_url":"https://github.com/qiskit-community/qiskit-metal","commit_stats":null,"previous_names":["qiskit-community/qiskit-metal","qiskit/qiskit-metal"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiskit-community%2Fqiskit-metal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiskit-community%2Fqiskit-metal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiskit-community%2Fqiskit-metal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiskit-community%2Fqiskit-metal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qiskit-community","download_url":"https://codeload.github.com/qiskit-community/qiskit-metal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253554062,"owners_count":21926609,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["device","eda","gds","hamiltonian","quantum","quantum-computing","qubits","simulation-modeling","superconducting"],"created_at":"2024-08-01T09:00:35.213Z","updated_at":"2026-06-01T02:06:01.979Z","avatar_url":"https://github.com/qiskit-community.png","language":"Python","funding_links":[],"categories":["Quantum SDKs","Community"],"sub_categories":[],"readme":"# Quantum Metal (formerly: Qiskit Metal)\n\n[![PyPI](https://img.shields.io/pypi/v/quantum-metal.svg?logo=pypi\u0026logoColor=white\u0026style=flat-square)](https://pypi.org/project/quantum-metal/)\n[![Python versions](https://img.shields.io/pypi/pyversions/quantum-metal.svg?style=flat-square\u0026logo=python\u0026logoColor=white)](https://pypi.org/project/quantum-metal/)\n[![PyPI downloads](https://img.shields.io/pypi/dm/quantum-metal.svg?style=flat-square\u0026label=PyPI%20downloads)](https://pypi.org/project/quantum-metal/)\n[![License](https://img.shields.io/github/license/qiskit-community/qiskit-metal.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)\n[![CI](https://img.shields.io/github/actions/workflow/status/qiskit-community/qiskit-metal/main.yml?branch=main\u0026style=flat-square\u0026label=CI\u0026logo=github)](https://github.com/qiskit-community/qiskit-metal/actions)\n[![Docs](https://img.shields.io/badge/docs-online-blue.svg?style=flat-square\u0026logo=read-the-docs\u0026logoColor=white)](https://qiskit-community.github.io/qiskit-metal/)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4618153.svg)](https://doi.org/10.5281/zenodo.4618153)\n[![GitHub stars](https://img.shields.io/github/stars/qiskit-community/qiskit-metal.svg?style=flat-square\u0026logo=github)](https://github.com/qiskit-community/qiskit-metal/stargazers)\n[![Contributors](https://img.shields.io/github/contributors/qiskit-community/qiskit-metal.svg?style=flat-square\u0026logo=github)](https://github.com/qiskit-community/qiskit-metal/graphs/contributors)\n[![Discord](https://img.shields.io/badge/Discord-Join_Community-5865F2?logo=discord\u0026logoColor=white\u0026style=flat-square)](https://discord.gg/kaZ3UFuq)\n\n\u003e ![Welcome to Quantum Metal!](https://raw.githubusercontent.com/qiskit-community/qiskit-metal/main/docs/images/zkm_banner.png 'Welcome to Quantum Metal')\n\u003e\n\u003e **Quantum Metal** is an open-source framework for engineers and scientists to design superconducting quantum devices with ease.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/qiskit-community/qiskit-metal/main/docs/_static/hero.gif\" alt=\"Build a 4-qubit chip in ~15 lines of Python — qubits, CPW routing, launchpads, qm.view()\" width=\"640\"/\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003csub\u003e\u003ca href=\"./scripts/make_hero_gif.py\"\u003eRegenerate this GIF\u003c/a\u003e · \u003ca href=\"./tutorials/2 From components to chip/C. My first full quantum chip design/2.21 Design a 4 qubit full chip.ipynb\"\u003eFull tutorial: 2.21\u003c/a\u003e\u003c/sub\u003e\u003c/p\u003e\n\n### 🚀 Try it now — zero install\n\n[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/qiskit-community/qiskit-metal/blob/main/tutorials/1%20Overview/1.1%20Quick%20start.ipynb)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/qiskit-community/qiskit-metal/main?labpath=tutorials%2F1%20Overview%2F1.1%20Quick%20start.ipynb)\n[![Open in GitHub Codespaces](https://img.shields.io/badge/Open_in-Codespaces-181717?logo=github\u0026logoColor=white\u0026style=flat-square)](https://codespaces.new/qiskit-community/qiskit-metal)\n\nOne click → working Quantum Metal in your browser in 60 seconds (lite install, no Qt required).\n\n📍 **Where we're heading:** see [ROADMAP.md](./ROADMAP.md) for the\nlite-by-default install (v0.7.0, shipped), the AI-orchestration profile,\nthe open FEM stack (gmsh + Elmer + AWS Palace), and the upcoming\nimport-path rename.\n\n---\n\n## Install\n\n```bash\npip install quantum-metal             # lite (v0.7.0+ default)\npip install \"quantum-metal[full]\"     # everything (v0.6.x compatibility)\n```\n\nPick the install command that matches your workflow:\n\n| | What you get | When |\n|---|---|---|\n| **🪶 Lite** `pip install quantum-metal` | Core API, `qm.view(design)` headless viewer, GDS export, pure-Python analyses | AI orchestration, Colab / Binder, cloud Jupyter, CI, any non-interactive workflow |\n| **🖥️ GUI** `pip install \"quantum-metal[gui]\"` | + `MetalGUI` desktop app (PySide6, qdarkstyle) | Interactive design work |\n| **🧲 Ansys** `pip install \"quantum-metal[ansys]\"` | + HFSS / Q3D renderers, EPR analyses (pyaedt, pyEPR-quantum) | HFSS / Q3D simulation (Windows + Ansys AEDT license) |\n| **🔺 Open FEM mesher** `pip install \"quantum-metal[mesh]\"` | + gmsh meshing (foundation for Elmer / Palace) | Open-source FEM (no Ansys license). `[fem]` is a backward-compat alias. |\n| **📦 Full** `pip install \"quantum-metal[full]\"` | All of the above | Migrating from v0.6.x, want zero behavior change |\n\nExtras compose: `pip install \"quantum-metal[gui,ansys]\"` works.\n\n\u003cdetails\u003e\n\u003csummary\u003eFeature matrix — what each install gives you\u003c/summary\u003e\n\n| | lite | `[gui]` | `[ansys]` | `[mesh]` | `[full]` |\n|---|---|---|---|---|---|\n| `import qiskit_metal` | ✅ | ✅ | ✅ | ✅ | ✅ |\n| `qm.view(design)` (headless matplotlib) | ✅ | ✅ | ✅ | ✅ | ✅ |\n| Build designs + components from `qlibrary` | ✅ | ✅ | ✅ | ✅ | ✅ |\n| GDS export | ✅ | ✅ | ✅ | ✅ | ✅ |\n| `LOManalysis`, LOM math, capacitance reductions | ✅ | ✅ | ✅ | ✅ | ✅ |\n| `MetalGUI` desktop app | — | ✅ | — | — | ✅ |\n| HFSS / Q3D renderers | — | — | ✅ | — | ✅ |\n| EPR analyses (`EigenmodeSim`, `LumpedElementsSim`) | — | — | ✅ | — | ✅ |\n| gmsh mesher (for Elmer / Palace) | — | — | — | ✅ | ✅ |\n\n`[fem]` is a backward-compatible alias of `[mesh]` — both install gmsh.\n\n\u003c/details\u003e\n\nSource install, conda, troubleshooting, and per-persona migration recipes:\n[`docs/installation.rst`](./docs/installation.rst) ·\n[`docs/migration-to-v0.7.0.rst`](./docs/migration-to-v0.7.0.rst).\n\nCI runs on **Python 3.10 / 3.11 / 3.12** across Linux, macOS, and Windows.\n\n---\n\n## Quick Start\n\nCreate your first quantum design in a notebook or script — **no Qt required**:\n\n```python\nimport qiskit_metal as qm\nfrom qiskit_metal import designs\nfrom qiskit_metal.qlibrary.qubits.transmon_pocket import TransmonPocket\n\n# Start a planar-chip quantum device design\ndesign = designs.DesignPlanar()\ndesign.chips.main.size.size_x = '11mm'\ndesign.chips.main.size.size_y = '9mm'\n\n# Add a transmon qubit with a connector pad \"a\"\nq1 = TransmonPocket(design, 'Q1', options=dict(\n    pos_x='0.5 mm', pos_y='0.25 mm',\n    pad_height='90um', pad_width='455um', pad_gap='30um',\n    connection_pads=dict(a=dict()),\n))\n\n# Render to an inline matplotlib figure — works in Colab, CI, any notebook\nfig = qm.view(design)\nfig.savefig(\"my_first_chip.png\")\n```\n\n![Example image](https://raw.githubusercontent.com/qiskit-community/qiskit-metal/main/docs/images/1_1_Birds_eye_view_of_Qiskit_Metal_example_image.jpg)\n\n\u003cdetails\u003e\n\u003csummary\u003ePrefer the interactive desktop GUI?\u003c/summary\u003e\n\nInstall with `pip install \"quantum-metal[gui]\"`, then replace the `qm.view(...)`\nline with the GUI flow:\n\n```python\nfrom qiskit_metal import MetalGUI\n\ngui = MetalGUI(design)        # launch the interactive editor\ngui.rebuild()                 # re-render after edits\ngui.edit_component('Q1')      # select for editing\ngui.autoscale()\n# ... later\ngui.main_window.close()\n```\n\nSee [`docs/headless-usage.rst`](./docs/headless-usage.rst) for the full\nno-Qt workflow and what to use when.\n\n\u003c/details\u003e\n\n**Next:** browse the [tutorial notebooks](./tutorials/) (40+ Jupyter notebooks\ncovering the full API) or the\n[online documentation](https://qiskit-community.github.io/qiskit-metal/).\n\n---\n\n## Transition notices\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eQiskit Metal → Quantum Metal\u003c/b\u003e rebrand (in progress)\u003c/summary\u003e\n\n- ✅ **New project name**: Quantum Metal\n- ✅ **PyPI package**: `quantum-metal` (current; the old `qiskit-metal` package\n  stays archived at its pre-v0.5 state)\n- ✅ **Lite-by-default install** (v0.7.0)\n- 🔜 **Repository rename to `quantum-metal`** — will keep redirects so existing\n  clones and links continue to work\n- 🔜 **Python import path rename** (`qiskit_metal` → `quantum_metal`) — target\n  v0.8 or v1.0. Plan to update your imports ahead of that release.\n\n\u003c/details\u003e\n\n---\n\n## 🌐 Ecosystem\n\nQuantum Metal is the **open-source chip-design layer** for superconducting\nquantum hardware. A growing community of tools builds on it, extends it\nwith new simulation backends, and plugs into it for quantization and\ndiscovery. **Full map: [docs.../ecosystem](https://qiskit-community.github.io/qiskit-metal/ecosystem.html)**.\n\n### Built on Quantum Metal\n\n- 🔬 **[SQuADDS](https://github.com/LFL-Lab/SQuADDS)** (LFL-Lab @ USC) —\n  validated qubit-design database + parameter interpolation. Published\n  in *Quantum* journal (Sept 2024).\n- 🧲 **[SQDMetal](https://github.com/sqdlab/SQDMetal)** (SQDLab @ UQ) —\n  simulation wrapper for `QDesign` → AWS Palace / COMSOL.\n- 🤖 **[ML_qubit_design](https://github.com/CosmiQuantum/ML_qubit_design)**\n  (Fermilab + Northwestern) — ML-based inverse design predicting Quantum\n  Metal parameters from target qubit properties.\n- ⚗️ **[Qiskit-Metal-to-Litho](https://github.com/OJB-Quantum/Qiskit-Metal-to-Litho)**\n  (Onri Jay Benally) — end-to-end design → lithography workflow with\n  headless Colab install scripts, GDS post-processing (PHIDL / GDSTK),\n  EBPG / BEAMER fab prep, and 3D Blender viz. Real fabricated chip examples.\n- 🌐 **[pypalace](https://pypalace.readthedocs.io/)** (Northwestern) —\n  Python toolkit for AWS Palace with Quantum Metal gmsh export.\n\n### Solvers Quantum Metal integrates with\n\n[AWS Palace](https://github.com/awslabs/palace) (roadmap) ·\n[Ansys HFSS/Q3D](https://www.ansys.com/products/electronics/ansys-hfss)\n(via `[ansys]`) · [Elmer FEM](https://www.elmerfem.org/) (via `[mesh]`) ·\n[gmsh](https://gmsh.info/) (via `[mesh]`).\n\n### Quantization \u0026 analysis\n\n[pyEPR](https://github.com/zlatko-minev/pyEPR) ·\n[scqubits](https://github.com/scqubits/scqubits) ·\n[QuTiP](https://github.com/qutip/qutip).\n\n### Community organization \u0026 events\n\n- **[Quantum Device Workshop (QDW)](https://qdw-ucla.squarespace.com/)** — annual\n  workshop at UCLA/USC with invited leaders in the field. Recent speakers:\n  *Michel Devoret, Andreas Wallraff, Zlatko Minev, Eli Levenson-Falk.*\n  [Video recordings](https://www.youtube.com/@uclaqcsa) ·\n  [Sign for 2026](https://qdw-ucla.squarespace.com/qdw2026).\n- **[Quantum Device Consortium (QDC)](https://qdc-qcsa.vercel.app)** — the\n  community organization stewarding Quantum Metal alongside the tools above.\n  [Join the QDC Discord](https://discord.gg/kaZ3UFuq).\n\n**Building something on Quantum Metal?** [Open an issue](https://github.com/qiskit-community/qiskit-metal/issues/new/choose)\nor ping us on Discord — we'd love to add you to the list.\n\n---\n\n## 🌱 From IBM to a Community-Maintained Project\n\nOriginally developed at IBM, **conceived and led by [Dr. Zlatko K. Minev](https://www.zlatko-minev.com)**,\nQuantum Metal has transitioned into a **community-driven project** supported by\nuniversities, research groups, labs, and individual contributors worldwide.\n\nDevelopment continues through the **Quantum Device Consortium (QDC)**, the\nbroader community, and active maintainers — in close collaboration with Zlatko\nMinev and contributors across QDW/QDC shaping this next chapter.\n\nAcknowledgements for the v0.5+ community release effort and ongoing\ncontributors are tracked in the [changelog](./changelog.md) and the\n[contributors graph](https://github.com/qiskit-community/qiskit-metal/graphs/contributors).\n\n---\n\n## Community and Support\n\n- 💬 **[Discord](https://discord.gg/kaZ3UFuq)** — fastest way to reach maintainers\n  and the broader community. *Primary community channel.*\n- 📺 **[YouTube video tutorials](https://youtube.com/playlist?list=PLOFEBzvs-VvqHl5ZqVmhB_FcSqmLufsjb)**\n- 💻 **[GitHub Issues](https://github.com/qiskit-community/qiskit-metal/issues)** — bugs and feature requests\n- 🟪 **[Qiskit Slack `#metal`](https://qiskit.slack.com/archives/C01R8KP5WP7)** — legacy channel, being phased out in favor of Discord\n\n---\n\n## Contributing\n\nIf you'd like to contribute, please read the\n[contribution guidelines](https://github.com/qiskit-community/qiskit-metal/blob/main/CONTRIBUTING.md)\nand the [contributor guide in the docs](https://qiskit-community.github.io/qiskit-metal/contributor-guide.html).\nThis project adheres to the [code of conduct](https://github.com/qiskit-community/qiskit-metal/blob/main/CODE_OF_CONDUCT.md).\nWe use [GitHub issues](https://github.com/qiskit-community/qiskit-metal/issues)\nfor bugs and feature requests.\n\n---\n\n## Architecture\n\nFor a high-level walkthrough of the codebase — Core, Renderers, Analyses, GUI,\nUtilities — and how they interact, see\n[`README_Architecture.md`](./README_Architecture.md).\n\nModule-level deep dive:\n[`docs/overview.rst`](./docs/overview.rst) ·\n[`docs/workflow.rst`](./docs/workflow.rst).\n\n---\n\n## Authors and Citation\n\nQuantum Metal is the work of [many people](https://github.com/qiskit-community/qiskit-metal/pulse/monthly)\nwho contribute to the project at different levels. The project was **conceived\nand developed by [Zlatko Minev](https://www.zlatko-minev.com)** at IBM, then\nco-led with Thomas McConkey, and has since transitioned to community maintenance\nthrough the QDC.\n\nIf you use Quantum Metal in your research, please cite it — see the\n[BibTeX entry](https://github.com/qiskit-community/qiskit-metal/blob/main/Qiskit_Metal.bib).\n\n## Changelog and Release Notes\n\nRelease notes for each version are published on the\n[GitHub releases page](https://github.com/qiskit-community/qiskit-metal/releases).\nDeveloper notes for in-flight releases live in [`changelog.md`](./changelog.md).\n\n## License\n\n[Apache License 2.0](https://github.com/qiskit-community/qiskit-metal/blob/main/LICENSE.txt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqiskit-community%2Fqiskit-metal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqiskit-community%2Fqiskit-metal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqiskit-community%2Fqiskit-metal/lists"}