Skip to content

Commit c44bc98

Browse files
committed
Document how to add new circuit instances
1 parent 1212b2b commit c44bc98

File tree

5 files changed

+43
-0
lines changed

5 files changed

+43
-0
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Name
2+
3+
<!-- Small description -->
4+
5+
## Description
6+
7+
<!-- Full description -->
8+
9+
## QASM file
10+
11+
<!-- - [circuit_name.qasm](./circuit_name.qasm) -->
12+
13+
## Institutions
14+
15+
<!-- The institution(s) or organization(s) involved in the submission, separated by commas -->

data/_circuit_instance_template/circuit_name.qasm

Whitespace-only changes.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
11
# Classically verifiable circuit instances
2+
3+
- ...
4+
5+
## Adding a new circuit instance
6+
7+
Each circuit instance must have its own folder named after its unique identifier. Inside this folder, include a `README.md` file containing the following information: **Description**, **QASM file**, and **Institutions**.
8+
9+
You can use the provided [template](../../_circuit_instance_template/README.md) as a guide for creating the `README.md`.
10+
11+
The folder should also include the corresponding **QASM file** itself.

data/observable-estimations/circuit-instances/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,11 @@
33
- [Operator Loschmidt Echo 70x1872](./operator_loschmidt_echo_70x1872/)
44
- [Operator Loschmidt Echo 49x648](./operator_loschmidt_echo_49x648/)
55
- [Operator Loschmidt Echo 49x1296](./operator_loschmidt_echo_49x1296/)
6+
7+
## Adding a new circuit instance
8+
9+
Each circuit instance must have its own folder named after its unique identifier. Inside this folder, include a `README.md` file containing the following information: **Description**, **QASM file**, and **Institutions**.
10+
11+
You can use the [provided template](./_circuit_instance_template/README.md) as a guide for creating the `README.md`.
12+
13+
The folder should also include the corresponding **QASM file** itself.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
11
# Variational problems circuit instances
2+
3+
- ...
4+
5+
## Adding a new circuit instance
6+
7+
Each circuit instance must have its own folder named after its unique identifier. Inside this folder, include a `README.md` file containing the following information: **Description**, **QASM file**, and **Institutions**.
8+
9+
You can use the [provided template](./_circuit_instance_template/README.md) as a guide for creating the `README.md`.
10+
11+
The folder should also include the corresponding **QASM file** itself.

0 commit comments

Comments
 (0)