Skip to content

Commit 71617c8

Browse files
authored
Add badges to README (#11)
* Add badges to README * tweak * More tweaks * More tweaks * More tweaks * More tweaks * More tweaks
1 parent e06880c commit 71617c8

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
[![C++17](https://img.shields.io/badge/C++17%20or%20later-%2300599C.svg?logo=c%2B%2B&logoColor=white)](#)
2+
![Compilers](https://img.shields.io/badge/%F0%9F%94%A8%20Compilers-GCC%20%7C%20Clang%20%7C%20MSVC-informational)
3+
![Architectures](https://img.shields.io/badge/%E2%9A%99%EF%B8%8F%20Architectures-x86__64%20%7C%20ARMv8-informational)
4+
![Operating systems](https://img.shields.io/badge/%F0%9F%92%BB%20Operating_systems-Linux%20%7C%20macOS%20%7C%20Windows-informational)
5+
<br/>
6+
[![Docs (dev)](https://img.shields.io/badge/%F0%9F%93%84%20Docs-stable-blue.svg)](https://qiskit.github.io/qiskit-addon-sqd-hpc/)
7+
[![License](https://img.shields.io/github/license/Qiskit/qiskit-addon-sqd-hpc?label=License)](LICENSE.txt)
8+
[![Tests](https://github.com/Qiskit/qiskit-addon-sqd-hpc/actions/workflows/test_latest_versions.yml/badge.svg)](https://github.com/Qiskit/qiskit-addon-sqd-hpc/actions/workflows/test_latest_versions.yml)
9+
[![Coverage](https://coveralls.io/repos/github/Qiskit/qiskit-addon-sqd-hpc/badge.svg?branch=main)](https://coveralls.io/github/Qiskit/qiskit-addon-sqd-hpc?branch=main)
10+
111
# qiskit-addon-sqd-hpc
212

313
This repository contains an HPC-ready implementation of the [Qiskit addon for Sample-based Quantum Diagonalization (SQD)](https://github.com/Qiskit/qiskit-addon-sqd).
@@ -6,12 +16,12 @@ This repository contains an HPC-ready implementation of the [Qiskit addon for Sa
616

717
- Modern C++17 template library, compatible with standard (STL) interfaces.
818
- Provides low-level functions for performing postselection, subsampling, and configuration recovery.
9-
- Able to integrate with the [sbd eigensolver](https://github.com/r-ccs-cms/sbd), which was developed at RIKEN to enable large-scale SQD calculations. See the [Qiskit 2.2 C API demo repository], in which a single binary harnessing both OpenMP and MPI-level parallelism is compiled for an HPC cluster.
10-
- Cross-architecture, tested on x86_64 and ARMv8. Cross-platform, tested on Linux, macOS, and Windows.
19+
- Able to integrate with the [sbd eigensolver](https://github.com/r-ccs-cms/sbd), which was developed at RIKEN to enable large-scale SQD calculations.
20+
- Cross-architecture, tested on x86_64 and ARMv8. Cross-platform, tested on Linux, macOS, and Windows, using GCC, Clang, and MSVC.
1121
- Compile with exceptions enabled or disabled -- your choice. [RTTI](https://en.wikipedia.org/wiki/Run-time_type_information) is optional, too.
12-
- Complete API documentation.
13-
- Fully tested, with a test suite based on [doctest](https://github.com/doctest/doctest).
14-
- Performant, with a micro-benchmark suite based on [nanobench](https://github.com/martinus/nanobench).
22+
- Complete [API documentation](https://qiskit.github.io/qiskit-addon-sqd-hpc/).
23+
- Fully tested, with a [test suite](test/) based on [doctest](https://github.com/doctest/doctest).
24+
- Performant, with a [micro-benchmark suite](benchmark/) based on [nanobench](https://github.com/martinus/nanobench).
1525

1626
## Documentation
1727

0 commit comments

Comments
 (0)