Skip to content

Commit a9971dc

Browse files
JMuff22JMuff22
authored
Add docs (#2)
* Add docs * Update README * Add changelog * Remove pull request trigger * Add test build workflow * Test fix docs * Test fix docsv2 * Revert deploy.yml change
1 parent a940780 commit a9971dc

17 files changed

+3102
-86
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ name: Build and deploy site to GitHub Pages
33
on:
44
push:
55
branches: [ "main" ]
6-
pull_request:
7-
branches: [ "main" ]
86
workflow_dispatch:
97

108
permissions:

‎.github/workflows/test-build.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Test build on pull requests
2+
on:
3+
pull_request:
4+
branches: [ "main" ]
5+
6+
permissions:
7+
contents: read
8+
9+
jobs:
10+
test-build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
16+
- name: Set up Node
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: 20
20+
cache: 'npm'
21+
22+
- name: Install dependencies
23+
run: npm install
24+
25+
- name: Build
26+
run: npm run build
27+

‎CHANGELOG.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22
Changelog
33
=========
44

5+
Version 0.2.0
6+
============
7+
8+
* Add documentation.
9+
`#2 <https://github.com/FiQCI/resource-estimator/pull/2>`_
10+
11+
512
Version 0.1.0
613
============
714

‎README.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Simple web app to estimate how many QPU seconds a job takes based on a model.
44

55
## Web Application
66

7-
The web application uses React and TailwindCSS. You can build the static files with
7+
The web application uses React, TailwindCSS and Vite. You can build the static files with
88

99
```bash
1010
npm run build
@@ -18,4 +18,12 @@ npm run dev
1818

1919
## Deployment
2020

21-
The app is deployed automatically with GitHub pages. The Github workflow [`deploy.yml`](./.github/workflows/deploy.yml) builds the static files and uploads the `dist` folder to the git branch `gh-pages` . Github pages is configured to deploy from `gh-pages` branch.
21+
The app is deployed automatically with GitHub pages. The Github workflow [`deploy.yml`](./.github/workflows/deploy.yml) builds the static files and uploads the `dist` folder to the git branch `gh-pages` . Github pages is configured to deploy from `gh-pages` branch.
22+
23+
## Data availability
24+
25+
Data used in the resource estimation can be found [here](./data_analysis/data/). It contains comma separated value data of varying qubits, circuit depth, number of circuits in a batch and shots with the real QPU seconds runtime calculated from [IQM Timestamps](https://docs.meetiqm.com/iqm-client/integration_guide.html#job-phases-and-related-timestamps) as `execution_end`-`execution_start`.
26+
27+
## Documentation
28+
29+
The documentation on the rendered webpage can be changed by editing the file [public/documentation.md](./public/documentation.md).

‎data_analysis/data/helmi.csv‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
num_qubits,depth,num_circuits,shots,qpu_seconds
2+
2,5,1,1000,2.981833
3+
2,5,12,1000,7.669428
4+
2,5,23,1000,12.542105
5+
2,5,34,1000,17.124343
6+
2,5,45,1000,21.952526
7+
2,5,56,1000,26.779989
8+
2,5,67,1000,31.49377
9+
2,5,78,1000,36.323195
10+
2,5,89,1000,41.090048
11+
2,5,100,1000,46.038944
12+
2,1,1,1000,3.017986
13+
2,6,1,1000,3.238903
14+
2,11,1,1000,3.027865
15+
2,16,1,1000,3.121345
16+
2,21,1,1000,2.955328
17+
2,26,1,1000,3.239296
18+
2,31,1,1000,2.975623
19+
2,36,1,1000,3.015543
20+
2,41,1,1000,3.008617
21+
2,46,1,1000,3.106363
22+
2,51,1,1000,3.00854
23+
2,56,1,1000,2.980254
24+
2,61,1,1000,3.1583
25+
2,66,1,1000,3.206648
26+
2,71,1,1000,2.944503
27+
2,76,1,1000,3.112113
28+
2,81,1,1000,2.977112
29+
2,86,1,1000,2.906232
30+
2,91,1,1000,3.250802
31+
2,96,1,1000,2.954498
32+
2,101,1,1000,3.219748
33+
2,106,1,1000,3.230491
34+
2,111,1,1000,3.026576
35+
2,116,1,1000,2.986265
36+
2,121,1,1000,3.111414
37+
2,127,1,1000,3.174185
38+
2,132,1,1000,2.951532
39+
2,137,1,1000,3.189878
40+
2,142,1,1000,2.973424
41+
2,147,1,1000,3.233269
42+
2,152,1,1000,2.970721
43+
2,157,1,1000,3.207216
44+
2,162,1,1000,3.105016
45+
2,167,1,1000,3.123819
46+
2,172,1,1000,3.10656
47+
2,177,1,1000,2.898026
48+
2,182,1,1000,3.048523
49+
2,187,1,1000,3.188759
50+
2,192,1,1000,2.94414
51+
2,197,1,1000,3.139161
52+
2,202,1,1000,3.478808
53+
2,207,1,1000,3.328256
54+
2,212,1,1000,2.987892
55+
2,217,1,1000,3.2237
56+
2,222,1,1000,3.238685
57+
2,227,1,1000,3.063648
58+
2,232,1,1000,3.15341
59+
2,237,1,1000,2.9221
60+
2,242,1,1000,3.235284
61+
2,247,1,1000,2.958195
62+
2,253,1,1000,3.219703
63+
2,258,1,1000,3.153148
64+
2,263,1,1000,3.19928
65+
2,268,1,1000,3.10848
66+
2,273,1,1000,2.901723
67+
2,278,1,1000,3.148538
68+
2,283,1,1000,2.998158
69+
2,288,1,1000,3.095113
70+
2,293,1,1000,2.964837
71+
2,298,1,1000,3.104059
72+
2,303,1,1000,3.183824
73+
2,308,1,1000,3.08526
74+
2,313,1,1000,3.200153
75+
2,318,1,1000,3.354913
76+
2,323,1,1000,3.016966
77+
2,328,1,1000,3.271434
78+
2,333,1,1000,2.997038
79+
2,338,1,1000,3.153575
80+
2,343,1,1000,3.160278
81+
2,348,1,1000,2.99376
82+
2,353,1,1000,3.059897
83+
2,358,1,1000,3.004696
84+
2,363,1,1000,2.98699
85+
2,368,1,1000,3.171522
86+
2,373,1,1000,3.193594
87+
2,379,1,1000,3.045711
88+
2,384,1,1000,3.141743
89+
2,389,1,1000,3.065208
90+
2,394,1,1000,2.900353
91+
2,399,1,1000,3.246499
92+
2,404,1,1000,2.896435
93+
2,409,1,1000,3.13687
94+
2,414,1,1000,3.183366
95+
2,419,1,1000,3.214246
96+
2,424,1,1000,3.137972
97+
2,429,1,1000,2.916481
98+
2,434,1,1000,3.046479
99+
2,439,1,1000,3.149449
100+
2,444,1,1000,2.918306
101+
2,449,1,1000,3.238494
102+
2,454,1,1000,2.99757
103+
2,459,1,1000,3.311676
104+
2,464,1,1000,3.203576
105+
2,469,1,1000,3.007434
106+
2,474,1,1000,3.582061
107+
2,479,1,1000,2.976728
108+
2,484,1,1000,2.913714
109+
2,489,1,1000,2.963039
110+
2,494,1,1000,3.081219
111+
2,500,1,1000,2.994679
112+
1,5,1,1000,2.945487
113+
2,5,1,1000,3.127768
114+
3,5,1,1000,3.204712
115+
4,5,1,1000,3.536795
116+
5,5,1,1000,3.739573
117+
2,5,1,1000,3.16178
118+
2,5,1,12000,7.840876
119+
2,5,1,23000,12.586953
120+
2,5,1,34000,17.217596
121+
2,5,1,45000,21.981468
122+
2,5,1,56000,26.749702
123+
2,5,1,67000,31.570187
124+
2,5,1,78000,36.680541
125+
2,5,1,89000,40.907746
126+
2,5,1,100000,45.866495
127+
2,5,1,500,2.813842
128+
2,5,12,500,5.129852
129+
2,5,23,500,7.607837
130+
2,5,34,500,9.940541
131+
2,5,45,500,12.470464
132+
2,5,56,500,14.817282
133+
2,5,67,500,17.248324
134+
2,5,78,500,19.611241
135+
2,5,89,500,21.795267
136+
2,5,100,500,24.097503
137+
2,1,1,500,3.019898
138+
2,56,1,500,3.005378
139+
2,111,1,500,2.953115
140+
2,167,1,500,3.027468
141+
2,222,1,500,2.973162
142+
2,278,1,500,2.821248
143+
2,333,1,500,2.786211
144+
2,389,1,500,2.767732
145+
2,444,1,500,2.766028
146+
2,500,1,500,3.034442
147+
1,5,1,500,2.613182
148+
2,5,1,1000,3.269438
149+
2,5,1,12000,7.676031
150+
2,5,1,23000,12.575999
151+
2,5,1,34000,17.398708
152+
2,5,1,45000,22.051263
153+
2,5,1,56000,27.000509
154+
2,5,1,67000,31.570888
155+
2,5,1,78000,36.263609
156+
2,5,1,89000,41.016442
157+
2,5,1,100000,45.908625

‎data_analysis/data/vtt-q50.csv‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
num_qubits,depth,num_circuits,shots,qpu_seconds
2+
2,5,1,1000,3.749052
3+
2,5,3,1000,4.54359
4+
2,5,6,1000,5.81263
5+
2,5,9,1000,7.025356
6+
2,5,11,1000,7.82311
7+
2,5,14,1000,9.368022
8+
2,5,17,1000,10.35538
9+
2,5,19,1000,11.139215
10+
2,5,22,1000,12.367176
11+
2,5,25,1000,13.547154
12+
1,5,1,1000,3.777627
13+
6,5,1,1000,3.762199
14+
12,5,1,1000,3.813401
15+
18,5,1,1000,3.902422
16+
24,5,1,1000,4.329625
17+
29,5,1,1000,4.036438
18+
35,5,1,1000,4.120896
19+
41,5,1,1000,4.130252
20+
47,5,1,1000,4.230616
21+
53,5,1,1000,4.568031
22+
2,1,1,1000,3.778269
23+
2,12,1,1000,3.725875
24+
2,23,1,1000,3.73441
25+
2,34,1,1000,3.751361
26+
2,45,1,1000,3.771756
27+
2,56,1,1000,3.700167
28+
2,67,1,1000,3.693037
29+
2,78,1,1000,3.743357
30+
2,89,1,1000,3.735767
31+
2,100,1,1000,4.025318
32+
2,5,1,1000,3.738875
33+
2,5,1,6444,5.946841
34+
2,5,1,11888,8.197089
35+
2,5,1,17333,10.432999
36+
2,5,1,22777,12.653333
37+
2,5,1,28222,15.037995
38+
2,5,1,33666,17.151397
39+
2,5,1,39111,19.467856
40+
2,5,1,44555,21.569139
41+
2,5,1,50000,24.125106
42+
10,20,16,38681,258.406905
43+
44,76,4,27698,50.042793
44+
34,43,19,10847,89.567902
45+
2,5,1,1000,3.750969
46+
2,5,3,1000,4.512175
47+
2,5,6,1000,6.113585
48+
2,5,9,1000,6.996136
49+
2,5,11,1000,7.860837
50+
2,5,14,1000,9.049461
51+
2,5,17,1000,10.284116
52+
2,5,19,1000,11.16592
53+
2,5,22,1000,12.478292
54+
2,5,25,1000,13.592108
55+
1,5,1,1000,4.079835
56+
6,5,1,1000,3.783372
57+
12,5,1,1000,3.867004
58+
18,5,1,1000,4.032186
59+
24,5,1,1000,4.092099
60+
29,5,1,1000,3.977336
61+
35,5,1,1000,4.111854
62+
41,5,1,1000,4.102101
63+
47,5,1,1000,4.519657
64+
53,5,1,1000,4.527094
65+
2,1,1,1000,3.700026
66+
2,12,1,1000,3.68914
67+
2,23,1,1000,3.704193
68+
2,34,1,1000,3.725117
69+
2,45,1,1000,3.70317
70+
2,56,1,1000,3.705689
71+
2,67,1,1000,4.05127
72+
2,78,1,1000,3.749195
73+
2,89,1,1000,3.729299
74+
2,100,1,1000,3.690523
75+
2,5,1,1000,3.716976
76+
2,5,1,6444,5.934433
77+
2,5,1,11888,8.277617
78+
2,5,1,17333,10.431098
79+
2,5,1,22777,12.729392
80+
2,5,1,28222,15.244026
81+
2,5,1,33666,17.151799
82+
2,5,1,39111,19.350351
83+
2,5,1,44555,21.549732
84+
2,5,1,50000,23.801997
85+
29,12,6,16644,44.941866
86+
44,16,9,37917,146.518783
87+
8,29,7,25402,76.528911
88+
24,3,4,27925,49.919876
89+
18,84,17,22299,160.377162
90+
42,27,3,13430,20.577245
91+
23,77,5,16953,38.72233
92+
38,81,15,41602,264.683836
93+
52,25,5,32346,71.90728
94+
2,5,1,1000,4.278022
95+
2,5,3,1000,4.563152
96+
2,5,6,1000,5.804623
97+
2,5,9,1000,7.057974
98+
2,5,11,1000,7.872928
99+
2,5,14,1000,9.071907
100+
2,5,17,1000,10.275761
101+
2,5,19,1000,11.262851
102+
2,5,22,1000,12.349918
103+
2,5,25,1000,13.638666
104+
1,5,1,1000,3.769797
105+
6,5,1,1000,3.810052
106+
12,5,1,1000,4.242799
107+
18,5,1,1000,3.970807
108+
24,5,1,1000,4.026493
109+
29,5,1,1000,4.050557
110+
35,5,1,1000,4.145035
111+
41,5,1,1000,4.213961
112+
47,5,1,1000,4.248147
113+
53,5,1,1000,4.67299
114+
2,1,1,1000,3.792097
115+
2,12,1,1000,3.788254
116+
2,23,1,1000,3.752711
117+
2,34,1,1000,3.794554
118+
2,45,1,1000,3.791628
119+
2,56,1,1000,3.728813
120+
2,67,1,1000,3.836733
121+
2,78,1,1000,3.81656
122+
2,89,1,1000,4.107503
123+
2,100,1,1000,3.746528
124+
2,5,1,1000,3.862396
125+
2,5,1,6444,6.042025
126+
2,5,1,11888,8.272025
127+
2,5,1,17333,10.500937
128+
2,5,1,22777,12.733557
129+
2,5,1,28222,14.97627
130+
2,5,1,33666,17.39442
131+
2,5,1,39111,19.413745
132+
2,5,1,44555,21.601033
133+
2,5,1,50000,23.8084
134+
39,3,15,38395,244.731708
135+
16,58,17,32680,232.965782
136+
19,54,7,33578,100.671711
137+
3,84,12,12526,64.954252
138+
5,27,3,34493,45.87461
139+
10,8,6,25847,67.301081
140+
4,57,7,36138,107.422085
141+
38,26,14,47410,281.003961
142+
45,79,11,36979,174.633181
143+
36,17,1,5271,5.938058
144+
20,63,18,30803,233.140031
145+
52,14,7,37744,114.792103
146+
42,71,19,40734,328.303842
147+
11,56,10,17565,76.05998
148+
7,42,4,49305,84.353251
149+
32,88,6,10536,29.879384
150+
2,74,22,47041,427.58139

0 commit comments

Comments
 (0)