From a8ee0958f4074aa0064fbb81f8e68f63dc10aa17 Mon Sep 17 00:00:00 2001 From: gonfeco Date: Mon, 11 Sep 2023 10:43:45 +0200 Subject: [PATCH] Update the README --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3f77754..ffecf98 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# NEASQC lib template +# The NEASQC BENCHMARK SUITE (TNBS) Library -This repository is associated to **The NEASQC BENCHMARK SUITE**, **TNBS**, of Work Package 3 of the NEASQC European project. The main idea is adding the different QLM-compatible implementation of the different **Benchmark Test Cases** of the different proposed **kernels**. +This repository is associated to **The NEASQC BENCHMARK SUITE**, **TNBS**, of Work Package 3 of the NEASQC European project. As pointed out in deliverable **D3.5 The NEASQC Benchmark Suite**, each proposed Benchmark Test Case, **BTC**, must have an Atos myqlm compatible software implementation. This Github repository gathers all this code. ## Licence @@ -12,14 +12,12 @@ The *requirements.txt* file contains the mandatory python libraries for using pr ## Respository organisation -The different **Benchmark Test Cases** are located inside the **tnbs** folder: +The different **BTC** are located inside the **tnbs** folder: -1. *templates*: this folder have different tmeplate scripts for helping in the development of the implementation of new **Benchmark Test Cases** -2. *AmplitudeEstimation*: folder with the complete implementation of the **Benchmark Test Cases** for the **Amplitude Estimation kernel* -3. *ProbabilityLoading*: folder with the complete implementation of the **Benchmark Test Cases** for the **Probability Loading kernel** - -## Jupyter Notebooks -Any jupyter notebook will be located under the misc/notebooks folder +1. *BTC_01_PL*: Software implementation for the **BTC** of the *Probability Loading kernel*. See deliverable: **T01: Benchmark for Probability Loading Algorithms** +2. *BTC_02_AE*: Software implementation for the **BTC** of the *Amplitude Estimation kernel*. See deliverable: **T02: Benchmark for Amplitude Estimation Algorithms** +3. *BTC_03_QPE*: Software implementation for the **BTC** of the *Quantum Amplitude Estimation kernel*. See deliverable: **T03: Benchmark for Phase Estimation Algorithms** +3. *BTC_04_PH*: Software implementation for the **BTC** of the *Parent Hamiltonian Kernel*. See deliverable: **T04: Benchmark for Parent Hamiltonian** ## Acknowledgements