diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 1f0171853..097e80c46 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/README.md b/README.md index 8e6d6619d..b840319b9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Qibocal -![Tests](https://github.com/qiboteam/qibocal/workflows/Tests/badge.svg) [![codecov](https://codecov.io/gh/qiboteam/qibocal/branch/main/graph/badge.svg?token=1EKZKVEVX0)](https://codecov.io/gh/qiboteam/qibocal) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7662185.svg)](https://doi.org/10.5281/zenodo.7662185) +![PyPI - Version](https://img.shields.io/pypi/v/qibocal) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qibocal) Qibocal provides Quantum Characterization Validation and Verification protocols using [Qibo](https://github.com/qiboteam/qibo) and [Qibolab](https://github.com/qiboteam/qibolab). @@ -13,6 +13,12 @@ Qibocal key features: - Generation of a report. +## Documentation + +[![docs](https://github.com/qiboteam/qibocal/actions/workflows/publish.yml/badge.svg)](https://qibo.science/qibocal/stable/) + +Qibocal documentation is available [here](https://qibo.science/qibocal/stable/). + ## Installation The package can be installed by source: @@ -72,3 +78,11 @@ In order to upload the report to a centralized server, send to the server admini Contributions, issues and feature requests are welcome! Feel free to check GitHub issues + +## Citation policy +[![arXiv](https://img.shields.io/badge/arXiv-2303.10397-b31b1b.svg)](https://arxiv.org/abs/2303.10397) +[![DOI](https://zenodo.org/badge/511836317.svg)](https://zenodo.org/badge/latestdoi/511836317) + + + +If you use the package please refer to [the documentation](https://qibo.science/qibo/stable/appendix/citing-qibo.html#publications) for citation instructions