{"id":20930181,"url":"https://github.com/dpbm/qiskit-metal-docker","last_synced_at":"2026-01-17T03:47:06.021Z","repository":{"id":205602729,"uuid":"714485705","full_name":"Dpbm/qiskit-metal-docker","owner":"Dpbm","description":"Run qiskit metal inside a docker container","archived":false,"fork":false,"pushed_at":"2024-08-04T13:10:29.000Z","size":46,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-11T18:06:56.306Z","etag":null,"topics":["architecture-components","design","docker","docker-compose","dockerfile","hardware","jupyter","python","qiskit","qiskit-metal","quantum","quantum-computing","quantum-hardware","quantum-mechanics","simulating","testing","ubuntu"],"latest_commit_sha":null,"homepage":"https://qiskit.github.io/ecosystem/","language":"Dockerfile","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/Dpbm.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-11-05T01:36:07.000Z","updated_at":"2024-08-04T13:10:32.000Z","dependencies_parsed_at":"2023-11-21T02:28:34.510Z","dependency_job_id":"86eb935d-cc5d-418f-b1a2-e2d7370030af","html_url":"https://github.com/Dpbm/qiskit-metal-docker","commit_stats":{"total_commits":33,"total_committers":2,"mean_commits":16.5,"dds":0.1515151515151515,"last_synced_commit":"8f0bc1b54acd2c5e96808a91bdfcc2ab36efef58"},"previous_names":["dpbm/qiskit-metal-docker"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dpbm%2Fqiskit-metal-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dpbm%2Fqiskit-metal-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dpbm%2Fqiskit-metal-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dpbm%2Fqiskit-metal-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dpbm","download_url":"https://codeload.github.com/Dpbm/qiskit-metal-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247393558,"owners_count":20931809,"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":["architecture-components","design","docker","docker-compose","dockerfile","hardware","jupyter","python","qiskit","qiskit-metal","quantum","quantum-computing","quantum-hardware","quantum-mechanics","simulating","testing","ubuntu"],"created_at":"2024-11-18T21:29:42.607Z","updated_at":"2026-01-17T03:47:05.995Z","avatar_url":"https://github.com/Dpbm.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Qiskit-Metal docker\n\n![Docker Image Version latest-ubuntu](https://img.shields.io/docker/v/dpbm32/qiskit-metal/latest-ubuntu)\n![Docker Image Version latest-minimal-jupyter](https://img.shields.io/docker/v/dpbm32/qiskit-metal/latest-minimal-jupyter)\n![Docker Pulls](https://img.shields.io/docker/pulls/dpbm32/qiskit-metal)\n![GitHub issues](https://img.shields.io/github/issues/Dpbm/qiskit-metal-docker)\n![GitHub all releases](https://img.shields.io/github/downloads/Dpbm/qiskit-metal-docker/total)\n![GitHub pull requests](https://img.shields.io/github/issues-pr/Dpbm/qiskit-metal-docker)\n\nA *community* project to run your [qiskit-metal](https://qiskit.org/metal/) project using [docker](https://www.docker.com/).\n\n## Versions/tags\n\nThe [qiskit-metal image](https://hub.docker.com/r/dpbm32/qiskit-metal) is based on some other images.\n\n| base image | tags   | size |\n|------------|--------|------|\n| [ubuntu](https://hub.docker.com/_/ubuntu) | `latest` `latest-ubuntu` | ~2Gb|\n| [minimal-notebook](https://quay.io/repository/jupyter/minimal-notebook) | `latest-minimal-jupyter` | ~3Gb |\n\nThese are pretty the same thing, just with more dependencies or default tooling inside, but for qiskit-metal projects they are just the same.\n\n## Requirements\n\nTo use these images you must have installed on your host machine:\n\n- [Docker](https://www.docker.com/)\n- [Docker compose](https://docs.docker.com/compose/) (optional)\n- [xServer](https://www.x.org/wiki/) (for metal GUI)\n\nAlso set your the [`DISPLAY`](https://www.x.org/archive/X11R6.8.0/doc/X.7.html) environment variable, in case it wasn't configured before.\n\nIf you use `linux` or other `unix like`, probably you have the `X` installed and configured, otherwise you can see the [xOrg website](https://www.x.org/wiki/).\nFor `mac` users, you may check the [xQuartz](https://www.xquartz.org/).\nAnd finally, for `windows` users, check the either [x410](https://x410.dev/) or [Cygwin/X](https://x.cygwin.com/).\n\nThe `X` is just required for the `metal GUI application`, so if you don't need that, just skip this step.\n\nFinally, you may need to add the access permission to your `X server`, to do that, type:\n\n```bash\nxhost +local:docker\n```\n\nand then to remove the permission, after using the docker image, you can run:\n\n```bash\nxhost -local:docker\n```\n\n\n## Using the images\n\nThe images are available on:\n\n| repository | build |\n|------------|-------|\n| [dockerHub](https://hub.docker.com/r/dpbm32/qiskit-metal) | ![dockerHub workflow](https://github.com/Dpbm/qiskit-metal-docker/actions/workflows/dockerhub.yml/badge.svg) |\n| [GHRC](https://github.com/Dpbm?tab=packages\u0026repo_name=qiskit-metal-docker) | ![GHRC workflow](https://github.com/Dpbm/qiskit-metal-docker/actions/workflows/ghrc.yml/badge.svg) |\n\nTo use them, run:\n\n```bash\n# linux example\ndocker run -d -v /tmp/.X11-unix:/tmp/.X11-unix:ro -e DISPLAY=$DISPLAY dpbm32/qiskit-metal:[tag]\n\n# or (no metal GUI)\ndocker run -d dpbm32/qiskit-metal:[tag]\n```\n\nor\n\n```bash\n# linux example\ndocker run -d -v /tmp/.X11-unix:/tmp/.X11-unix:ro -e DISPLAY=$DISPLAY ghcr.io/dpbm/qiskit-metal-docker:[tag]\n\n# or (no metal GUI)\ndocker run -d ghcr.io/dpbm/qiskit-metal-docker:[tag]\n```\n\nIf you want a simpler way to run it, you can use the docker compose. There're two files for that:\n\n- [default-compose.yaml](./default-compose.yaml)\n- [template-compose.yaml](./template-compose.yaml)\n\nThe [default-compose.yaml](./default-compose.yaml) has the default configuration to run the image based on `Ubuntu`, and the second one is a template for those who want to add your own settings. \n\nThis last one can be renamed for `\u003cwhatever_you_want\u003e.yaml`.\n\nTo start the image using docker compose, run:\n\n```bash\ndocker compose --project-directory ./ -f default-compose.yaml up -d\n\n#or\n\ndocker compose --project-directory ./ -f \u003cwhatever\u003e.yaml up -d\n```\n\n\nThen, access `http://\u003cdocker_ip\u003e:8888` on your browser. If you don't know the `docker ip` run:\n\n```bash\ndocker inspect \u003ccontainerID\u003e | grep IPAddress\n```\n\n---\n\nFor real projects, you might want to create a volume to save your files. To do add volumes, checkout the [official docker tutorial](https://docs.docker.com/storage/volumes/).\n\n## Contributing\n\nIf you enjoyed our project and want to help us evolve it, you can:\n\n- [open an issue reporting a problem/feature request](https://github.com/Dpbm/qiskit-metal-docker/issues/new)\n- [solve an issue](https://github.com/Dpbm/qiskit-metal-docker/issues/)\n- [check some PR](https://github.com/Dpbm/qiskit-metal-docker/pulls)\n- [add a PR](https://github.com/Dpbm/qiskit-metal-docker/compare)\n- complete a [todo item](https://github.com/Dpbm/qiskit-metal-docker/issues/8)\n\nBe kind in your comments, and remember, there's another person across the monitor.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdpbm%2Fqiskit-metal-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdpbm%2Fqiskit-metal-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdpbm%2Fqiskit-metal-docker/lists"}