From 56c176770604a9a76936f754fe6a00290ae0b115 Mon Sep 17 00:00:00 2001 From: Andrea Date: Thu, 8 Feb 2024 09:20:56 +0400 Subject: [PATCH 1/3] doc: refactor badges --- .github/workflows/publish.yml | 2 +- README.md | 20 +++++++++++++++----- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index fae0cd4..b1a2ebb 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 e146f28..cfed230 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,19 @@ # Qibosoq -![Tests](https://github.com/qiboteam/qibosoq/workflows/Tests/badge.svg) [![codecov](https://codecov.io/gh/qiboteam/qibosoq/branch/main/graph/badge.svg?token=1EKZKVEVX0)](https://codecov.io/gh/qiboteam/qibosoq) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8083285.svg)](https://doi.org/10.5281/zenodo.8083285) +![PyPI - Version](https://img.shields.io/pypi/v/qibosoq) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qibosoq) + Repository for developing server side of RFSoC fpga boards Qibosoq is a server for integrating [Qick](https://github.com/openquantumhardware/qick) in the [Qibolab](https://github.com/qiboteam/qibolab) ecosystem for executing arbitrary pulses sequences on QPUs. -The complete documentation for can be found at: +## Documentation + +[![docs](https://github.com/qiboteam/qibosoq/actions/workflows/publish.yml/badge.svg)](https://qibo.science/qibosoq/stable/) -* [qibo.science/qibosoq/stable](https://qibo.science/qibosoq/stable/) -* [qibo.science/qibosoq/latest](https://qibo.science/qibosoq/latest/) +Qibosoq documentation is available [here](https://qibo.science/qibosoq/stable/). ## Installation @@ -58,3 +60,11 @@ All these commands require sudo privileges. Contributions, issues and feature requests are welcome! Feel free to check GitHub issues + +## Citation policy +[![arXiv](https://img.shields.io/badge/arXiv-2310.05851-b31b1b.svg)](https://arxiv.org/abs/2310.05851) +[![DOI](https://zenodo.org/badge/567203263.svg)](https://zenodo.org/badge/latestdoi/567203263) + + + +If you use the package please refer to [the documentation](https://qibo.science/qibo/stable/appendix/citing-qibo.html#publications) for citation instructions From 5ad915dbec5851f35d28ada2617b51f98981ff8e Mon Sep 17 00:00:00 2001 From: Andrea Date: Thu, 8 Feb 2024 12:55:17 +0400 Subject: [PATCH 2/3] doc: Reintroduce latest doc --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cfed230..5d65f70 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,11 @@ Qibosoq is a server for integrating [Qick](https://github.com/openquantumhardwar for executing arbitrary pulses sequences on QPUs. ## Documentation - [![docs](https://github.com/qiboteam/qibosoq/actions/workflows/publish.yml/badge.svg)](https://qibo.science/qibosoq/stable/) +The complete documentation can be found at: -Qibosoq documentation is available [here](https://qibo.science/qibosoq/stable/). +* [qibo.science/qibosoq/stable](https://qibo.science/qibosoq/stable/) +* [qibo.science/qibosoq/latest](https://qibo.science/qibosoq/latest/) ## Installation From 764d568860d613bc04e81bbecf155b81ef731106 Mon Sep 17 00:00:00 2001 From: Rodolfo Carobene <74607088+rodolfocarobene@users.noreply.github.com> Date: Thu, 8 Feb 2024 10:12:23 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 5d65f70..b28869b 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ for executing arbitrary pulses sequences on QPUs. ## Documentation [![docs](https://github.com/qiboteam/qibosoq/actions/workflows/publish.yml/badge.svg)](https://qibo.science/qibosoq/stable/) + The complete documentation can be found at: * [qibo.science/qibosoq/stable](https://qibo.science/qibosoq/stable/)