Skip to content

Commit 718879e

Browse files
authored
Update readme and add placeholder for arxiv ID
1 parent 3659145 commit 718879e

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Simply put, filter functions characterize a quantum system's susceptibility to n
99

1010
Initially, filter functions have been introduced to model dynamical decoupling sequences [1, 2]. With this project we aim to provide a toolkit for calculating and inspecting filter functions for arbitrary pulses including pulses without analytic form such as one might get from numerical pulse optimization algorithms. These filter functions can be used to compute process descriptions, fidelities and other quantities of interest from arbitrary classical noise spectral densities. For the efficient and convenient treatment of gate sequences, concatenation rules that allow the filter function of a sequence to be computed from those of its constituents are implemented.
1111

12-
The `filter_functions` package is built to interface with [QuTiP](http://qutip.org/), a widely-used quantum toolbox for Python, and comes with extensive documentation and a test suite. Note that the project is still in pre-release and thus liable to breaking API changes.
12+
The `filter_functions` package is built to interface with [QuTiP](http://qutip.org/), a widely-used quantum toolbox for Python, as well as [qopt](https://github.com/qutech/qopt) and comes with extensive documentation and a test suite.
1313

1414
As a very brief introduction, consider a Hadamard gate implemented by a pi/2 Y-gate followed by a NOT-gate using simple square pulses. We can calculate and plot the dephasing filter function of the gate with the following code:
1515

@@ -54,9 +54,9 @@ hadamard.is_cached('filter function')
5454
To compute, for example, the infidelity of the gate in the presence of an arbitrary classical noise spectrum, we can simply call `infidelity()`:
5555

5656
```python
57-
spectrum = 1e-2/abs(omega)
57+
spectrum = 1e-2/omega
5858
infidelity = ff.infidelity(hadamard, spectrum, omega)
59-
# array([0.006037]) (one contribution per noise operator)
59+
# array([0.0025]) (one contribution per noise operator)
6060
```
6161

6262
## Installation
@@ -71,6 +71,11 @@ The documentation including the example notebooks and an automatically generated
7171

7272
Interactively using the documentation requires `jupyter`, and building a static version additionally requires `nbsphinx`, `numpydoc`, `sphinx_rtd_theme`, as well as `pandoc`. The last can be installed via conda (`conda install pandoc`) or downloaded from [Github](https://github.com/jgm/pandoc/releases/) and the rest automatically by running `pip install -e .[doc]`.
7373

74+
## Citing
75+
If this software has benefited your research, please consider citing:
76+
77+
arXiv ID for now.
78+
7479
## References
7580
[1]: Cywinski, L., Lutchyn, R. M., Nave, C. P., & Das Sarma, S. (2008). How to enhance dephasing time in superconducting qubits. Physical Review B - Condensed Matter and Materials Physics, 77(17), 1–11. [https://doi.org/10.1103/PhysRevB.77.174509](https://doi.org/10.1103/PhysRevB.77.174509)
7681

0 commit comments

Comments
 (0)