Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
gonfeco committed Jan 17, 2024
1 parent 5b620ff commit 9aee31a
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,21 @@ The `LICENCE` file contains the default licence statement as specified in the pr

## Building and installing

The *environment.yml* file contains the python libraries for using the **TNBS**. You can build the environment using conda (new environment called tnbs_test will be created):
There are two ways for installing mandatory Python libraries for using the **TNBS** code: using the *environment.yml* file or the *requirements.txt* file.

* The *environment.yml*: this file contains all the mandatory libraries for executing the **TNBS** code including the different *jupyter-notebooks* presented in the TNBS repository. For installing them the following conda command (new environment called tnbs_test will be created):
conda env create -n tnbs_test -f environment.yml

* The *requirements.txt*: this file contains the mandatory libraries for executing the **TNBS** code except the *jupyter-notebooks* (jupyter notebooks libraries should be installed manually). For installing them the following command can be used:
pip install -r requirements.txt

## Repository organisation

The different **BTC** are located inside the **tnbs** 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**

1. *BTC_01_PL*: Software implementation for the **BTC** of the *Probability Loading kernel*. See **Annex C. T01: Benchmark for Probability Loading Algorithms** from deliverable D3.5.
2. *BTC_02_AE*: Software implementation for the **BTC** of the *Amplitude Estimation kernel*. See **Annex D. T02: Benchmark for Amplitude Estimation Algorithms** from deliverable D3.5.
3. *BTC_03_QPE*: Software implementation for the **BTC** of the *Quantum Amplitude Estimation kernel*. See **Annex E. T03: Benchmark for Phase Estimation Algorithms** from deliverable D3.5.
3. *BTC_04_PH*: Software implementation for the **BTC** of the *Parent Hamiltonian Kernel*. See **Annex F. **T04: Benchmark for Parent Hamiltonian** from deliverable D3.5.

## Acknowledgements

Expand All @@ -30,6 +31,8 @@ This work is supported by the [NEASQC](https://cordis.europa.eu/project/id/95182
## Documentation

The html documentation of the **TNBS** can be access at: https://neasqc.github.io/TNBS
The complete TNBS documentation can be found at the public project deliverable:
[D3.5 The NEASQC Benchmark Suite (TNBS)](https://www.neasqc.eu/wp-content/uploads/2023/10/NEASQC_D3.5_Benchmark_suite_R1.0.pdf)

## Test it

Expand Down

0 comments on commit 9aee31a

Please sign in to comment.