https://github.com/davidbkemp/animated-qubits
JavaScript library for creating graphical visualisations and animations
https://github.com/davidbkemp/animated-qubits
jsqubits quantum-computing
Last synced: 4 months ago
JSON representation
JavaScript library for creating graphical visualisations and animations
- Host: GitHub
- URL: https://github.com/davidbkemp/animated-qubits
- Owner: davidbkemp
- License: mit
- Created: 2013-12-22T03:03:08.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-03-01T04:53:43.000Z (over 1 year ago)
- Last Synced: 2026-01-23T11:58:36.136Z (5 months ago)
- Topics: jsqubits, quantum-computing
- Language: JavaScript
- Homepage: http://davidbkemp.github.io/animated-qubits/
- Size: 1.3 MB
- Stars: 13
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# animatedQubits.js
JavaScript library for animating quantum computations.
To see an example of it in use, see the [Quantum Gate Playground](https://davidbkemp.github.io/quantum-gate-playground/) and the [Animation of Grover's Quantum Search Algorithm](https://davidbkemp.github.io/animated-qubits/grover.html).
You may also be interested in [An Interactive Introduction To Quantum Computing](https://davidbkemp.github.io/QuantumComputingArticle/) where I use animatedQubits.js to illustrate quantum computing concepts.
Home page: https://davidbkemp.github.io/animated-qubits
Usage
-----
Include animatedQubits.min.js and its dependencies in your web page. Possibly the easiest way to do this is to use [bower](https://bower.io/):
$ bower install animated-qubits
You should find animatedQubits.min.js and its dependencies installed in bower_components, and so you can include them as follows:
Add an svg element to the page:
Create a jsqubits object, pass it to the animatedQubits function to create an animatedQubits object, and ask it to display itself in the svg element (see also https://davidbkemp.github.io/jsqubits/ )
var qstate = jsqubits("|101>").hadamard(0).t(0);
var animation = animatedQubits(qstate, {maxRadius: 50});
var svgElement = document.getElementById("mySvg");
animation.display(svgElement);
var naturalDimensions = animation.getNaturalDimensions();
svgElement.setAttribute("height", naturalDimensions.height);
svgElement.setAttribute("width", naturalDimensions.width);
Style the quantum state amplitude discs using css:
.animatedQubitsAmplitudeCircle {
fill: hsla(195, 53%, 60%, 0.5);
}
.animatedQubitsPhaseArrow {
stroke: red;
stroke-width: 2px;
}
.animatedQubitsPhaseArrowEnd {
fill: red;
}
Animate an operation
animation.applyOperation(function hadamardAll(qstate) {
return qstate.hadamard(jsqubits.ALL);
}).then(function onSuccess(newQState) {
// Invoked asynchronously when the animation successfully completes
}).fail(function (msg) {
// Invoked asynchronously if an error occurs.
alert(msg);
});
Measure qubits 0 and 2 (where qubit 0 is the least significant i.e. right-most qubit):
animation.measure([0, 2])
.then(function onSuccess(newQState) {
// Invoked asynchronously when the animation successfully completes
}).fail(function (msg) {
// Invoked asynchronously if an error occurs.
alert(msg);
});
The applyOperation() and measure() methods return "promise" objects
with then() and fail() methods that take callbacks that get invoked upon
completion of the animation
(See https://promises-aplus.github.io/promises-spec/ ).
These promises will pass on the resultant QState object.
See the examples to see how this can be used.
Development
-----------
To run specs and validate the JavaScript and create animatedQubits.min.js:
npm run build
License
-------
The MIT License (MIT)
Copyright (c) 2013-2014 David Kemp
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.