Package: qiskit-metal
Qiskit MetalQiskit Metal is an open-source framework for engineers and scientists to design superconducting quantum devices with ease.InstallationIf you are interested in customizing your experience, or if you are unable to install qiskit-metal using thepip installinstructions below, consider installing directly the source code, following the instructions in thedocumentationand/or theinstallation instructions for developers.For normal use, please continue reading.The Qiskit Metal deployed packageYou can install Qiskit Metal via the pip tool (a python package manager).pipinstallqiskit-metalPIP 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 theFAQ.We recommend to install qiskit-metal in a conda environment or venv, to prevent version conflicts with pre-existing package versions.Jupyter NotebookAt 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 eitheranaconda.orgorjupyter.org.Unless you installed the entirejupyterpackage in your current environment, do not forget to create the appropriate kernel to make the environment (thus qiskit-metal) available to jupyter (instructions in theFAQ)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>>>fromqiskit_metalimportdesigns,draw,MetalGUI,Dict,open_docs>>>design=designs.DesignPlanar()>>>design.overwrite_enabled=True>>>design.chips.main>>>design.chips.main.size.size_x='11mm'>>>design.chips.main.size.size_y='9mm'>>>gui=MetalGUI(design)Launch the Qiskit Metal GUI to interactively view, edit, and simulate a QDesign:>>>gui=MetalGUI(design)Let's create a new qubit (a transmon) by creating an object of this class.>>>fromqiskit_metal.qlibrary.qubits.transmon_pocketimportTransmonPocket>>>q1=TransmonPocket(design,'Q1',options=dict(connection_pads=dict(a=dict())))>>>gui.rebuild()>>>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()Get a list of all the qcomponents in QDesign and then zoom on them.>>>all_component_names=design.components.keys()>>>gui.zoom_on_components(all_component_names)Closing the Qiskit Metal GUI.>>>gui.main_window.close()A script is availablehere, where we also show the overview of Qiskit Metal.Community and SupportWatch the recorded tutorialsThe streaming will also be recorded and made availableherefor offline review.Take part in the live tutorials and discussionThrough June 2021 we are offering live tutorials and Q&A.Sign upto receive an invite to the upcoming sessions.  The streaming will also be recorded and made available for offline review.  Findheremore details on schedule and use the Slack channel to give us feedback and to request the most relevant content to you.Get help: SlackUse the slack channel.  Joinqiskit slackand then join the#metalchannel to communicate with the developers and other participants.  You may also use this channel to inquire about collaborations.Contribution GuidelinesIf you'd like to contribute to Qiskit Metal, please take a look at ourcontribution guidelines. This project adheres to Qiskit'scode of conduct. By participating, you are expected to uphold this code.
We useGitHub issuesfor tracking requests and bugs. Pleasejoin the Qiskit Slack communityand use ourQiskit Slack channelfor discussion and simple questions.
For questions that are more suited for a forum we use the Qiskit tag in theStack Exchange.Next StepsNow you're set up and ready to check out some of the other examples from ourQiskit Metal Tutorialsrepository orQiskit Metal Documentation.Authors and CitationQiskit Metal is the work ofmany peoplewho contribute to the project at different levels. Metal was conceived and developed byZlatko Minevat IBM; then co-led with Thomas McConkey. If you use Qiskit Metal, please cite as per the includedBibTeX file. For icon attributions, seehere.Changelog and Release NotesThe 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 the0.0.4releasehereThe changelog for all releases can be found in the release page: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.LicenseApache License 2.0