kamakiri01 / jsqubits

Quantum computation simulation JavaScript library

jsqubits

Quantum computation simulation JavaScript library

Website: http://davidbkemp.github.io/jsqubits/

The user manual: http://davidbkemp.github.io/jsqubits/jsqubitsManual.html

Try it out online using the jsqubits runner: http://davidbkemp.github.io/jsqubits/jsqubitsRunner.html

Wiki (with examples): https://github.com/davidbkemp/jsqubits/wiki

GitHub: https://github.com/davidbkemp/jsqubits

Node npm module: https://npmjs.org/package/jsqubits

You can use it to implement quantum algorithms using JavaScript like this:

jsqubits('|01>')
    .hadamard(jsqubits.ALL)
    .cnot(1, 0)
    .hadamard(jsqubits.ALL)
    .measure(1)
    .result

WARNING: jsqubits operators return new instances of the quantum state and they do NOT modify the existing object.

If you are new to quantum programming, then it is highly recommended that you try reading John Watrous' Quantum Information and Computation Lecture Notes. You may also wish to try reading the (work in progress) Introduction to Quantum Programming using jsqubits.

Usage

Try it out online using the jsqubits runner: http://davidbkemp.github.io/jsqubits/jsqubitsRunner.html

Use it in your own web application by including the JavaScript files available from GitHub: https://github.com/davidbkemp/jsqubits/tree/master/lib (jsqubits.js is the core library, while jsqubitsmath.js has some maths functions that are useful in some of the well known quantum algorithms). They have optional support for being loaded via require.js (see the simple web page examples in the examples directory).

Use it in a Node application (see http://nodejs.org) :

$ npm install jsqubits
$ node
> qubits = require('jsqubits').jsqubits
> qubits('|0101>').hadamard(qubits.ALL).toString()

REMEMBER: jsqubits operators return new instances of the quantum state and they do NOT modify the existing object.

NOTE: If you clone the github repository, or download a release, you will need to run npm install from within the root of the repository. e.g.

$ git clone https://github.com/davidbkemp/jsqubits.git
$ cd jsqubits
$ npm install
$ node
> qubits = require('./dist/es/index.js').jsqubits
> qubits('|0101>').hadamard(qubits.ALL).toString()

Development

To run the Jasmine specs, you will need to install Node.js (http://nodejs.org). Then use 'npm install' to install the testing dependencies (Jasmine) and 'npm test' to run the specs. NOTE: The Jasmine specs include an example of factoring using Shor's faction algorithm. This is non-deterministic and can take a fraction of a second or several seconds to complete.

License

(The MIT License)

Copyright (c) 2012-2019 David Kemp <[e-mail]>

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.