Skip to content

Commit

Permalink
Update documentation from github actions
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 22, 2024
1 parent 94ab675 commit 61847da
Show file tree
Hide file tree
Showing 67 changed files with 5,385 additions and 16,570 deletions.
12 changes: 12 additions & 0 deletions TNBS/_sources/tnbs.BTC_01_PL.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
BTC\_01\_PL: Probability Loading
================================

This part of the repository is associated with the Benchmark Test Case (BTC) 01: **Probability Loading**.

Configure the **kernel_configuration** dictionary at the end of the **my_benchmark_execution.py** file. The files will be saved in the **Results** folder (you can change the folder in key argument **saving_folder** of the **benchmark_arguments** dictionary). Then you should execute the following command line:

python my_benchmark_execution.py

If you want a complete execution and create the complete **JSON** file with the complete information of the benchmark results following the **NEASQC JSON Schema** you can instead execute the script **benchmark_exe.sh**:

bash benchmark_exe.sh

All the results files and the corresponding JSON will be stored in the **Results** folder.

my\_benchmark\_execution
------------------------

Expand Down
13 changes: 13 additions & 0 deletions TNBS/_sources/tnbs.BTC_02_AE.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
BTC\_02\_AE Amplitude Estimation
================================

This part of the repository is associated with the Benchmark Test Case (BTC) 02: **Amplitude Estimation**.

Select and configure the **Amplitude Estimation** algorithm using the JSON files inside the jsons folder. Configure the **kernel_configuration** dictionary in final part of the **my_benchmark_execution.py** file. The files will be saved in the **Results** folder (you can change the folder in key argument **saving_folder** of the **benchmark_arguments** dictionary). Then you should execute the following command line:

python my_benchmark_execution.py

If you want a complete execution and create the complete **JSON** file with the complete information of the benchmark results following the **NEASQC JSON Schema** you can instead execute the script **benchmark_exe.sh**:

bash benchmark_exe.sh

All the results files and the corresponding JSON will be stored in the **Results** folder.


my\_benchmark\_execution
------------------------

Expand Down
12 changes: 12 additions & 0 deletions TNBS/_sources/tnbs.BTC_03_QPE.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
BTC\_03\_QPE: Quantum Phase Estimation
======================================

This part of the repository is associated with the Benchmark Test Case (BTC) 03: **Quantum Phase Estimation** (QPE).

Configure the **kernel_configuration** dictionary in final part of the **my_benchmark_execution.py** file. The files will be saved in the **Results** folder (you can change the folder in key argument **saving_folder** of the **benchmark_arguments** dictionary). Then you should execute the following command line:

python my_benchmark_execution.py

If you want a complete execution and create the complete **JSON** file with the complete information of the benchmark results following the **NEASQC JSON Schema** you can instead execute the script **benchmark_exe.sh**:

bash benchmark_exe.sh

All the results files and the corresponding JSON will be stored in the **Results** folder.

my\_benchmark\_execution
------------------------

Expand Down
16 changes: 15 additions & 1 deletion TNBS/_sources/tnbs.BTC_04_PH.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
BTC\_04\_PH: Parent Hamiltonian
===============================

Implementation of the **BTC** for the **PH kernel** of **TNBS**.
This part of the repository is associated with the Benchmark Test Case (BTC) 04: **Parent Hamiltonian**.
Configure the **kernel_configuration** dictionary in final part of the **my_benchmark_execution.py** file. The number of qubits for executing should be provided as a python list to the variable: *list_of_qbits*. The different depths for executing should be provided as a python list to the key *depth* of the **kernel_configuration** dictionary.

* The mandatory configuration files for the ansatz (they have the word *parameters* in their names) and for the different Pauli decomposition (they have the word *Pauli* in their names) can be found under the **configuration_files** folder.
* The number of qubits for the ansatz could be from 3 to 30 qubits.
* The depth of the ansatz can be from 1 to 4.

The files will be saved in the **Results** folder (you can change the folder in key argument **saving_folder** of the **benchmark_arguments** dictionary). Then you should execute the following command line:

python my_benchmark_execution.py

If you want a complete execution and create the complete **JSON** file with the complete information of the benchmark results following the **NEASQC JSON Schema** you can instead execute the script **benchmark_exe.sh**:

bash benchmark_exe.sh

All the results files and the corresponding JSON will be stored in the **Results** folder.

my\_benchmark\_execution
------------------------
Expand Down
123 changes: 123 additions & 0 deletions TNBS/_static/_sphinx_javascript_frameworks_compat.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/* Compatability shim for jQuery and underscores.js.
*
* Copyright Sphinx contributors
* Released under the two clause BSD licence
*/

/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};

/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;

/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};

/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
Loading

0 comments on commit 61847da

Please sign in to comment.