Add links for documentation and reference papers to website (#628)

### Summary Many projects mention papers in their descriptions. These links look a bit ugly as we don't support markdown, but I understand the papers are important to the project maintainers. To resolve this, I've added a "paper" link to the card. While I was there, I also added a specific "documentation" link, since most projects' "websites" are just their docs. <img width="1109" alt="Screenshot 2023-12-06 at 10 13 36" src="https://github.com/Qiskit/ecosystem/assets/36071638/7c759ce6-c6a3-4058-8a4d-fd6d395326a9">
Qiskit · Dec 6, 2023 · 0c5215f · 0c5215f
1 parent 5c5da84
commit 0c5215f
Show file tree

Hide file tree

Showing 28 changed files with 45 additions and 28 deletions.
diff --git a/ecosystem/cli/website.py b/ecosystem/cli/website.py
@@ -57,9 +57,15 @@ def build_website(self):
                 tags += templates["tag"].render(color="purple", title=label, text=label)
 
             # Card links
-            links = templates["link"].render(url=repo.url, place="repository")
-            if repo.website:
-                links += templates["link"].render(url=repo.website, place="website")
+            links = ""
+            for url, link_text in (
+                (repo.url, "repository"),
+                (repo.website, "website"),
+                (repo.reference_paper, "paper"),
+                (repo.documentation, "documentation"),
+            ):
+                if url:
+                    links += templates["link"].render(url=url, place=link_text)
 
             # Card description
             if (

diff --git a/ecosystem/models/repository.py b/ecosystem/models/repository.py
@@ -36,6 +36,8 @@ class Repository(JsonSerializable):
     historical_test_results: list[TestResult] = new_list()
     stars: int | None = None
     group: str | None = None
+    reference_paper: str | None = None
+    documentation: str | None = None
 
     def __post_init__(self):
         self.__dict__.setdefault("created_at", datetime.now().timestamp())

diff --git a/ecosystem/resources/members/SSVQE.toml b/ecosystem/resources/members/SSVQE.toml
@@ -1,6 +1,6 @@
 name = "SSVQE"
 url = "https://github.com/JoelHBierman/SSVQE"
-description = "The SSVQE algorithm (arXiv:1810.09434) is a generalization of VQE to find low-lying eigenstates of a Hermitian operator. This specific implementation of SSVQE carries out one optimization procedure using weights."
+description = "The SSVQE algorithm is a generalization of VQE to find low-lying eigenstates of a Hermitian operator. This specific implementation of SSVQE carries out one optimization procedure using weights."
 licence = "Apache License 2.0"
 contact_info = "[email protected]"
 alternatives = "_No response_"
@@ -12,6 +12,7 @@ coverages_results = []
 skip_tests = false
 stars = 0
 group = "applications"
+reference_paper = "https://arxiv.org/abs/1810.09434"
 [[tests_results]]
 passed = false
 test_type = "development"

diff --git a/ecosystem/resources/members/dense-ev.toml b/ecosystem/resources/members/dense-ev.toml
@@ -1,18 +1,18 @@
 name = "dense-ev"
 url = "https://github.com/atlytle/dense-ev"
-description = "Implements expectation value measurements in Qiskit using optimal dense grouping. Dense-ev provides an improvement of ~2^m over naive grouping and (3/2)^m over qubit-wise commuting groups. Based on arXiv:2305.11847."
+description = "Implements expectation value measurements in Qiskit using optimal dense grouping. Dense-ev provides an improvement of ~2^m over naive grouping and (3/2)^m over qubit-wise commuting groups."
 licence = "Apache License 2.0"
 contact_info = "[email protected]"
 alternatives = "_No response_"
 affiliations = "University of Illinois at Urbana-Champaign"
 labels = [ "Paper implementation",]
 tier = "Community"
-website = "https://github.com/atlytle/dense-ev"
 styles_results = []
 coverages_results = []
 skip_tests = false
 stars = 5
 group = "other"
+reference_paper = "https://arxiv.org/abs/2305.11847"
 [[tests_results]]
 passed = true
 test_type = "development"

diff --git a/ecosystem/resources/members/mirror-gates.toml b/ecosystem/resources/members/mirror-gates.toml
@@ -7,12 +7,12 @@ alternatives = "_No response_"
 affiliations = "University of Pittsburgh"
 labels = [ "Paper implementation",]
 tier = "Community"
-website = "https://arxiv.org/abs/2308.03874"
 styles_results = []
 coverages_results = []
 skip_tests = false
 stars = 3
 group = "transpiler_plugin"
+reference_paper = "https://arxiv.org/abs/2308.03874"
 [[tests_results]]
 passed = true
 test_type = "development"

diff --git a/ecosystem/resources/members/purplecaffeine.toml b/ecosystem/resources/members/purplecaffeine.toml
@@ -9,12 +9,12 @@ labels = [ "Productivity", "Jupyter notebook",]
 created_at = 1688661859.080258
 updated_at = 1688661859.080264
 tier = "Community"
-website = "https://icekhan13.github.io/purplecaffeine/index.html"
 styles_results = []
 coverages_results = []
 skip_tests = false
 stars = 6
 group = "other"
+documentation = "https://icekhan13.github.io/purplecaffeine/index.html"
 [[tests_results]]
 passed = false
 test_type = "development"

diff --git a/ecosystem/resources/members/q-kernel-ops.toml b/ecosystem/resources/members/q-kernel-ops.toml
@@ -1,6 +1,6 @@
 name = "q-kernel-ops"
 url = "https://github.com/Travis-S-IBM/q-kernel-ops"
-description = "Code based on the paper \"Kernel Matrix Completion for Offline Quantum-Enhanced Machine Learning\" (arXiv:2112.08449)."
+description = "Code based on the paper \"Kernel Matrix Completion for Offline Quantum-Enhanced Machine Learning\"."
 licence = "Apache 2.0"
 contact_info = "### Email"
 alternatives = "### Alternatives"
@@ -13,6 +13,7 @@ coverages_results = []
 skip_tests = false
 stars = 3
 group = "other"
+reference_paper = "https://arxiv.org/abs/2112.08449"
 [[tests_results]]
 passed = false
 test_type = "development"

diff --git a/ecosystem/resources/members/qiskit-aer.toml b/ecosystem/resources/members/qiskit-aer.toml
@@ -6,11 +6,11 @@ labels = [ "Circuit simulator",]
 created_at = 1636403010.377695
 updated_at = 1636403010.377697
 tier = "Main"
-website = "https://qiskit.org/ecosystem/aer"
 tests_results = []
 styles_results = []
 coverages_results = []
 skip_tests = true
 historical_test_results = []
 stars = 407
 group = "other"
+documentation = "https://qiskit.org/ecosystem/aer"
diff --git a/ecosystem/resources/members/qiskit-algorithms.toml b/ecosystem/resources/members/qiskit-algorithms.toml
@@ -7,12 +7,12 @@ alternatives = "_No response_"
 affiliations = "IBM Quantum"
 labels = [ "Algorithms",]
 tier = "Community"
-website = "https://qiskit.org/ecosystem/algorithms"
 styles_results = []
 coverages_results = []
 skip_tests = false
 stars = 41
 group = "applications"
+documentation = "https://qiskit.org/ecosystem/algorithms"
 [[tests_results]]
 passed = false
 test_type = "development"

diff --git a/ecosystem/resources/members/qiskit-aqt-provider.toml b/ecosystem/resources/members/qiskit-aqt-provider.toml
@@ -1,18 +1,19 @@
 name = "Qiskit AQT Provider"
 url = "https://github.com/qiskit-community/qiskit-aqt-provider"
-description = "Qiskit provider for ion-trap quantum computers from Alpine Quantum Technologies (AQT). https://www.aqt.eu/qc-systems/"
+description = "Qiskit provider for ion-trap quantum computers from Alpine Quantum Technologies (AQT)."
 licence = "Apache License 2.0"
 contact_info = "[email protected]"
 alternatives = "_No response_"
 affiliations = "Alpine Quantum Technologies GmbH"
 labels = [ "Provider",]
 tier = "Community"
-website = "https://qiskit-community.github.io/qiskit-aqt-provider/"
+website = "https://www.aqt.eu/qc-systems/"
 styles_results = []
 coverages_results = []
 skip_tests = false
 stars = 26
 group = "provider"
+documentation = "https://qiskit-community.github.io/qiskit-aqt-provider/"
 [[tests_results]]
 passed = true
 test_type = "development"

diff --git a/ecosystem/resources/members/qiskit-bip-mapper.toml b/ecosystem/resources/members/qiskit-bip-mapper.toml
@@ -1,6 +1,6 @@
 name = "Qiskit BIP Mapper"
 url = "https://github.com/qiskit-community/qiskit-bip-mapper"
-description = "This plugin solves the routing and layout problems as a binary integer programming (BIP) problem. This is an implementation of G. Nannicini et al. \"Optimal qubit assignment and routing via integer programming.\" (arXiv:2106.06446)."
+description = "This plugin solves the routing and layout problems as a binary integer programming (BIP) problem. This is an implementation of G. Nannicini et al. \"Optimal qubit assignment and routing via integer programming.\"."
 licence = "Apache License 2.0"
 contact_info = "[email protected]"
 alternatives = "_No response_"
@@ -16,3 +16,4 @@ skip_tests = true
 historical_test_results = []
 stars = 4
 group = "transpiler_plugin"
+reference_paper = "https://arxiv.org/abs/2106.06446"
diff --git a/ecosystem/resources/members/qiskit-cold-atom.toml b/ecosystem/resources/members/qiskit-cold-atom.toml
@@ -8,12 +8,12 @@ labels = [ "Provider", "Physics",]
 created_at = 1678827878.507531
 updated_at = 1678827878.507532
 tier = "Community"
-website = "https://qiskit-community.github.io/qiskit-cold-atom/"
 styles_results = []
 coverages_results = []
 skip_tests = false
 stars = 25
 group = "provider"
+documentation = "https://qiskit-community.github.io/qiskit-cold-atom/"
 [[tests_results]]
 passed = false
 test_type = "development"

diff --git a/ecosystem/resources/members/qiskit-dynamics.toml b/ecosystem/resources/members/qiskit-dynamics.toml
@@ -6,11 +6,11 @@ labels = [ "Physics",]
 created_at = 1628883441.121108
 updated_at = 1628883441.121111
 tier = "Extensions"
-website = "https://qiskit.org/ecosystem/dynamics/"
 tests_results = []
 styles_results = []
 coverages_results = []
 skip_tests = true
 historical_test_results = []
 stars = 79
 group = "applications"
+documentation = "https://qiskit.org/ecosystem/dynamics/"
diff --git a/ecosystem/resources/members/qiskit-experiments.toml b/ecosystem/resources/members/qiskit-experiments.toml
@@ -6,11 +6,11 @@ labels = [ "Algorithms", "Hardware",]
 created_at = 1661785302.25299
 updated_at = 1661785302.25299
 tier = "Extensions"
-website = "https://qiskit.org/ecosystem/experiments/"
 tests_results = []
 styles_results = []
 coverages_results = []
 skip_tests = true
 historical_test_results = []
 stars = 124
 group = "other"
+documentation = "https://qiskit.org/ecosystem/experiments/"
diff --git a/ecosystem/resources/members/qiskit-finance.toml b/ecosystem/resources/members/qiskit-finance.toml
@@ -6,11 +6,11 @@ labels = [ "Algorithms", "Finance",]
 created_at = 1636403009.368607
 updated_at = 1636403009.368609
 tier = "Community"
-website = "https://qiskit.org/ecosystem/finance/"
 tests_results = []
 styles_results = []
 coverages_results = []
 skip_tests = true
 historical_test_results = []
 stars = 191
 group = "applications"
+documentation = "https://qiskit.org/ecosystem/finance/"
diff --git a/ecosystem/resources/members/qiskit-ibm-provider.toml b/ecosystem/resources/members/qiskit-ibm-provider.toml
@@ -16,6 +16,7 @@ skip_tests = true
 historical_test_results = []
 stars = 69
 group = "provider"
+documentation = "https://docs.quantum.ibm.com/api/qiskit-ibm-provider"
 
 [configuration]
 dependencies_files = [ "requirements.txt", "requirements-dev.txt",]

diff --git a/ecosystem/resources/members/qiskit-ibm-runtime.toml b/ecosystem/resources/members/qiskit-ibm-runtime.toml
@@ -16,3 +16,4 @@ skip_tests = true
 historical_test_results = []
 stars = 108
 group = "provider"
+documentation = "https://docs.quantum.ibm.com/api/qiskit-ibm-runtime"
diff --git a/ecosystem/resources/members/qiskit-machine-learning.toml b/ecosystem/resources/members/qiskit-machine-learning.toml
@@ -6,11 +6,11 @@ labels = [ "Algorithms", "Machine learning",]
 created_at = 1636403010.012954
 updated_at = 1636403010.012956
 tier = "Community"
-website = "https://qiskit.org/ecosystem/machine-learning"
 tests_results = []
 styles_results = []
 coverages_results = []
 skip_tests = true
 historical_test_results = []
 stars = 521
 group = "applications"
+documentation = "https://qiskit.org/ecosystem/machine-learning"
diff --git a/ecosystem/resources/members/qiskit-metal.toml b/ecosystem/resources/members/qiskit-metal.toml
@@ -6,11 +6,11 @@ labels = [ "Hardware",]
 created_at = 1628883441.119202
 updated_at = 1628883441.119205
 tier = "Community"
-website = "https://qiskit.org/ecosystem/metal/"
 tests_results = []
 styles_results = []
 coverages_results = []
 skip_tests = true
 historical_test_results = []
 stars = 251
 group = "other"
+documentation = "https://qiskit.org/ecosystem/metal/"
diff --git a/ecosystem/resources/members/qiskit-nature-pyscf-dft-embedding.toml b/ecosystem/resources/members/qiskit-nature-pyscf-dft-embedding.toml
@@ -1,6 +1,6 @@
 name = "Qiskit Nature PySCF DFT Embedding"
 url = "https://github.com/mrossinek/qiskit-nature-pyscf-dft-embedding"
-description = "This repository contains the latest prototype implementation of the Qiskit Nature + PySCF DFT Embedding. It is based on \"Quantum HF/DFT-embedding algorithms for electronic structure calculations: Scaling up to complex molecular systems\" (J. Chem. Phys. 154, 114105)"
+description = "This repository contains the latest prototype implementation of the Qiskit Nature + PySCF DFT Embedding. It is based on \"Quantum HF/DFT-embedding algorithms for electronic structure calculations: Scaling up to complex molecular systems\"."
 licence = "Apache License 2.0"
 contact_info = "[email protected]"
 alternatives = "_No response_"
@@ -14,6 +14,7 @@ coverages_results = []
 skip_tests = false
 stars = 4
 group = "applications"
+reference_paper = "https://pubs.aip.org/aip/jcp/article-abstract/154/11/114105/315377/Quantum-HF-DFT-embedding-algorithms-for-electronic"
 [[tests_results]]
 passed = false
 test_type = "development"

diff --git a/ecosystem/resources/members/qiskit-nature.toml b/ecosystem/resources/members/qiskit-nature.toml
@@ -6,11 +6,11 @@ labels = [ "Algorithms", "Physics", "Chemistry",]
 created_at = 1636403009.16708
 updated_at = 1636403009.167082
 tier = "Community"
-website = "https://qiskit.org/ecosystem/nature"
 tests_results = []
 styles_results = []
 coverages_results = []
 skip_tests = true
 historical_test_results = []
 stars = 255
 group = "applications"
+documentation = "https://qiskit.org/ecosystem/nature"
diff --git a/ecosystem/resources/members/qiskit-optimization.toml b/ecosystem/resources/members/qiskit-optimization.toml
@@ -6,11 +6,11 @@ labels = [ "Algorithms", "Optimization",]
 created_at = 1636403009.538761
 updated_at = 1636403009.538763
 tier = "Community"
-website = "https://qiskit.org/ecosystem/optimization"
 tests_results = []
 styles_results = []
 coverages_results = []
 skip_tests = true
 historical_test_results = []
 stars = 184
 group = "applications"
+documentation = "https://qiskit.org/ecosystem/optimization"
diff --git a/ecosystem/resources/members/qiskit-qulacs.toml b/ecosystem/resources/members/qiskit-qulacs.toml
@@ -6,11 +6,11 @@ contact_info = "[email protected]"
 alternatives = "_No response_"
 affiliations = "Supported by the Unitary Fund microgrant program: https://unitary.fund/grants/"
 labels = [ "Circuit simulator", "Converter", "Provider",]
-group = "provider"
 tier = "Community"
-website = "https://qiskit-qulacs.netlify.app/"
 tests_results = []
 styles_results = []
 coverages_results = []
 skip_tests = false
 historical_test_results = []
+group = "provider"
+documentation = "https://qiskit-qulacs.netlify.app/"
diff --git a/ecosystem/resources/members/qiskit-toqm.toml b/ecosystem/resources/members/qiskit-toqm.toml
@@ -1,6 +1,6 @@
 name = "Qiskit TOQM"
 url = "https://github.com/qiskit-toqm/qiskit-toqm"
-description = "Qiskit transpiler routing method using the Time-Optimal Qubit Mapping (TOQM) algorithm, described in https://doi.org/10.1145/3445814.3446706"
+description = "Qiskit transpiler routing method using the Time-Optimal Qubit Mapping (TOQM) algorithm."
 licence = "Apache License 2.0"
 contact_info = "_No response_"
 alternatives = "_No response_"
@@ -13,6 +13,7 @@ coverages_results = []
 skip_tests = false
 stars = 6
 group = "transpiler_plugin"
+reference_paper = "https://doi.org/10.1145/3445814.3446706"
 [[tests_results]]
 passed = false
 test_type = "development"

diff --git a/ecosystem/resources/members/qlasskit.toml b/ecosystem/resources/members/qlasskit.toml
@@ -7,7 +7,7 @@ alternatives = "_No response_"
 affiliations = "The project is partially funded by the UnitaryFund microgrant."
 labels = [ "Converter",]
 tier = "Community"
-website = "https://dakk.github.com/qlasskit"
+website = "https://dakk.github.io/qlasskit/"
 tests_results = []
 styles_results = []
 coverages_results = []

diff --git a/ecosystem/resources/members/quantum-prototype-template.toml b/ecosystem/resources/members/quantum-prototype-template.toml
@@ -7,7 +7,6 @@ alternatives = "_No response_"
 affiliations = "Qiskit Community"
 labels = [ "Productivity",]
 tier = "Community"
-website = "https://github.com/qiskit-community/quantum-prototype-template"
 styles_results = []
 coverages_results = []
 skip_tests = false

diff --git a/ecosystem/resources/members/quantum-tetris.toml b/ecosystem/resources/members/quantum-tetris.toml
@@ -9,6 +9,7 @@ labels = [ "Game",]
 created_at = 1679712086.990215
 updated_at = 1679712086.99022
 tier = "Community"
+website = "https://olivierbrcknr.github.io/quantum-tetris/"
 tests_results = []
 styles_results = []
 coverages_results = []

diff --git a/ecosystem/resources/members/spinoza.toml b/ecosystem/resources/members/spinoza.toml
@@ -16,3 +16,4 @@ skip_tests = true
 historical_test_results = []
 stars = 17
 group = "other"
+reference_paper = "https://arxiv.org/abs/2303.01493"