{"id":24074831,"url":"https://github.com/lfl-lab/metal-library","last_synced_at":"2025-10-13T18:35:29.648Z","repository":{"id":166194935,"uuid":"641651041","full_name":"LFL-Lab/metal-library","owner":"LFL-Lab","description":"Library of pre-simulated superconducting quantum components built on Qiskit Metal.","archived":false,"fork":false,"pushed_at":"2023-08-17T21:57:17.000Z","size":546,"stargazers_count":1,"open_issues_count":3,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-09T18:21:51.709Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LFL-Lab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"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":"2023-05-16T22:10:31.000Z","updated_at":"2024-09-06T12:18:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"c5898c2d-9247-44c9-9020-543858ab1439","html_url":"https://github.com/LFL-Lab/metal-library","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFL-Lab%2Fmetal-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFL-Lab%2Fmetal-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFL-Lab%2Fmetal-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFL-Lab%2Fmetal-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LFL-Lab","download_url":"https://codeload.github.com/LFL-Lab/metal-library/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240947637,"owners_count":19883029,"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":[],"created_at":"2025-01-09T18:21:50.556Z","updated_at":"2025-10-13T18:35:24.584Z","avatar_url":"https://github.com/LFL-Lab.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# metal-library\n`metal-library` is a powerful framework made to expedite the design and simulation phase of a superconducting quantum devices. Its primary objective is to reduce the time spent by design engineers by providing an initial estimation of a components characteristics. We do this by comparing a component's geometry to experimentally verified quantities of qubits and cavities.\n\n**As a design engineer, your current workflow probably looks like:**\n\nPI tells you they want a qubit w/ certain target observables. For example: \"Give me a TransmonCross ($f_{q} \\approx 5$) strongly coupled to a cavity ($f_{c} \\approx 7$). Let's say $g \\approx 200\\,  \\text{MHz}$\". So you start w/ a default cross design, simulate it (even though you've done this hundred of times), and then use some capacitance proportionality relationship ($\\omega \\propto \\sqrt{1 / C}$) to guess the frequency. From there you reiterate w/ various coupling pad sizes until you find something which spits out a semi decent couling.\n\nThis is super long and boring.\n\n**What if it could be faster?**\n\nLuckily that's the point of this library! In our case, you just tell the library, \"Hey I want a TransmonCross coupled to a cavity w/ this $\\omega_q, \\omega_c, g$, etc. and it'll give a geometry which was presimulated.\n\n**How can I trust the output of this library?**\n\nAll simulation done in this library have been verified by experiment.\n\nWhat I mean is:\n1. Get experimental characteristics from fabricated devices\n2. Get theoretical characteristics by running simulation of the same devices.\n3. If there's \"good enough\" agreement, we run the same simulation setup on various geometries close to the fabricated devices.\n\n**What do you mean by \"good enough\" agreement**\n\nNOTE TO SELF: ask Eli what to put here or if to rewrite?\n\n# Installation\n1. Install Qiskit-Metal. See [here](https://qiskit.org/documentation/metal/installation.html)\n2. Clone repository into a directory of your choice\n```\ncd \u003cREPO PATH\u003e\ngit clone https://github.com/LFL-Lab/metal-library\n```\n3. Install dependencies in your Qiskit Metal conda environment.\n```\nconda activate \u003cQISKIT METAL ENV\u003e\ncd metal-library\npip install .\n```\n\n### Updates\nTo update the repository\n```\nconda activate \u003cQISKIT METAL ENV\u003e\ncd \u003cREPO PATH\u003e\ngit pull\npip install --upgrade .\n```\n\n# How to Use \n```\nfrom metal_library import \n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flfl-lab%2Fmetal-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flfl-lab%2Fmetal-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flfl-lab%2Fmetal-library/lists"}