From 7c7ead05572042c9d7c5edfc3b5aca36b82b7ce1 Mon Sep 17 00:00:00 2001 From: Andrea Date: Mon, 29 Jan 2024 17:26:32 +0400 Subject: [PATCH 1/4] refactor: Fix badges and add new ones --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cf6234e2c..70d8815ea 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ # Qibolab - -![Tests](https://github.com/qiboteam/qibolab/workflows/Tests/badge.svg) +[![tests](https://github.com/qiboteam/qibolab/actions/workflows/rules.yml/badge.svg)](https://github.com/qiboteam/qibolab/actions/workflows/rules.yml/badge.svg) +[![docs](https://github.com/qiboteam/qibolab/actions/workflows/publish.yml/badge.svg)](https://qibo.science/qibolab/stable/) [![codecov](https://codecov.io/gh/qiboteam/qibolab/branch/main/graph/badge.svg?token=11UENAPBPH)](https://codecov.io/gh/qiboteam/qibolab) -[![DOI](https://zenodo.org/badge/241307936.svg)](https://zenodo.org/badge/latestdoi/241307936) +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) +[![CodeFactor](https://www.codefactor.io/repository/github/qiboteam/qibolab/badge)](https://www.codefactor.io/repository/github/qiboteam/qibolab) +[![arXiv](https://img.shields.io/badge/arXiv-2308.06313-b31b1b.svg)](https://arxiv.org/abs/2308.06313) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10572987.svg)](https://doi.org/10.5281/zenodo.10572987) Qibolab is the dedicated [Qibo](https://github.com/qiboteam/qibo) backend for the automatic deployment of quantum circuits on quantum hardware. From 991941b37e08db7d0dae134ef1173eef7cbe5f8a Mon Sep 17 00:00:00 2001 From: Andrea Date: Mon, 29 Jan 2024 17:35:08 +0400 Subject: [PATCH 2/4] refactor: Rename workflows --- .github/workflows/publish.yml | 2 +- .github/workflows/rules.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 29a1445bc..709852406 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -1,4 +1,4 @@ -name: Deploy docs +name: docs on: workflow_dispatch: diff --git a/.github/workflows/rules.yml b/.github/workflows/rules.yml index e82f5c5bc..131c9153c 100644 --- a/.github/workflows/rules.yml +++ b/.github/workflows/rules.yml @@ -1,5 +1,5 @@ # A single CI script with github workflow -name: Tests without qpu +name: tests on: workflow_dispatch: From 13fdb9706e47977bede4b9b730c3e5f534bfef54 Mon Sep 17 00:00:00 2001 From: Andrea Date: Mon, 29 Jan 2024 17:42:28 +0400 Subject: [PATCH 3/4] chore: Add PyPi badges --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 70d8815ea..b788d53c1 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ [![tests](https://github.com/qiboteam/qibolab/actions/workflows/rules.yml/badge.svg)](https://github.com/qiboteam/qibolab/actions/workflows/rules.yml/badge.svg) [![docs](https://github.com/qiboteam/qibolab/actions/workflows/publish.yml/badge.svg)](https://qibo.science/qibolab/stable/) [![codecov](https://codecov.io/gh/qiboteam/qibolab/branch/main/graph/badge.svg?token=11UENAPBPH)](https://codecov.io/gh/qiboteam/qibolab) +![PyPI - Version](https://img.shields.io/pypi/v/qibolab) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qibolab) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![CodeFactor](https://www.codefactor.io/repository/github/qiboteam/qibolab/badge)](https://www.codefactor.io/repository/github/qiboteam/qibolab) [![arXiv](https://img.shields.io/badge/arXiv-2308.06313-b31b1b.svg)](https://arxiv.org/abs/2308.06313) From 2578bb2c3d6883bafe2f8c7897b742d1356f1044 Mon Sep 17 00:00:00 2001 From: Alessandro Candido Date: Mon, 29 Jan 2024 15:05:29 +0100 Subject: [PATCH 4/4] feat: Rearrange badges, keep only most relevant Those related to the paper have been moved to the citation section, to keep all references together, tests are omitted, assuming Codecov is already providing a superset of that information, and codefactor and Black are not adding much --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b788d53c1..40e881bd4 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,23 @@ # Qibolab -[![tests](https://github.com/qiboteam/qibolab/actions/workflows/rules.yml/badge.svg)](https://github.com/qiboteam/qibolab/actions/workflows/rules.yml/badge.svg) -[![docs](https://github.com/qiboteam/qibolab/actions/workflows/publish.yml/badge.svg)](https://qibo.science/qibolab/stable/) + [![codecov](https://codecov.io/gh/qiboteam/qibolab/branch/main/graph/badge.svg?token=11UENAPBPH)](https://codecov.io/gh/qiboteam/qibolab) ![PyPI - Version](https://img.shields.io/pypi/v/qibolab) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qibolab) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![CodeFactor](https://www.codefactor.io/repository/github/qiboteam/qibolab/badge)](https://www.codefactor.io/repository/github/qiboteam/qibolab) -[![arXiv](https://img.shields.io/badge/arXiv-2308.06313-b31b1b.svg)](https://arxiv.org/abs/2308.06313) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10572987.svg)](https://doi.org/10.5281/zenodo.10572987) Qibolab is the dedicated [Qibo](https://github.com/qiboteam/qibo) backend for the automatic deployment of quantum circuits on quantum hardware. Some of the key features of Qibolab are: -* Deploy Qibo models on quantum hardware easily. -* Create custom experimental drivers for custom lab setup. -* Support multiple heterogeneous platforms. -* Use existing calibration procedures for experimentalists. +- Deploy Qibo models on quantum hardware easily. +- Create custom experimental drivers for custom lab setup. +- Support multiple heterogeneous platforms. +- Use existing calibration procedures for experimentalists. ## Documentation +[![docs](https://github.com/qiboteam/qibolab/actions/workflows/publish.yml/badge.svg)](https://qibo.science/qibolab/stable/) + The qibolab backend documentation is available at [https://qibo.science/qibolab/stable/](https://qibo.science/qibolab/stable/). ## Minimum working example @@ -105,4 +102,7 @@ for _ in range(5): ## Citation policy +[![arXiv](https://img.shields.io/badge/arXiv-2308.06313-b31b1b.svg)](https://arxiv.org/abs/2308.06313) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10572987.svg)](https://doi.org/10.5281/zenodo.10572987) + If you use the package please refer to [the documentation](https://qibo.science/qibo/stable/appendix/citing-qibo.html#publications) for citation instructions.