QISKit.js

⚛️ Quantum Information Software Kit for JavaScript.

💡 This project born as a clone (in JS) of its big brother.

Philosophy

📙 The basic concept of our quantum program is an array of quantum circuits. The program workflow consists of three stages: Build, Compile, and Run. Build allows you to make different quantum circuits that represent the problem you are solving. Compile allows you to rewrite them to run on different backends (simulators/real chips of different quantum volumes, sizes, fidelity, etc); and Run launches the jobs. After the jobs have been run, the data is collected. There are methods for putting this data together, depending on the program. This either gives you the answer you wanted or allows you to make a better program for the next instance.

If you want to learn more about Quantum Computing, you're invited to visit our Quamtum Experience project.

Structure

👜 The components of this repository are exposed as these libraries:

@qiskit/sdk: Meta-package, documented in this file. It also includes a command line client, which is your friend if you want to play with some OpenQASM circuits (in the Quantum Experience or the local simulator) without having to use any other programming language.
@qiskit/qasm: OpenQASM stuff, including the parser.
@qiskit/cloud: To send circuits to the Quantum Experience.
@qiskit/sim: Local simulator for OpenQASM circuits.
@qiskit/algos: High level algorithms for easy use.
@qiskit/utils: Helpers shared among all packages.

QISKit for the browser

You can find a bundled version with the same stuff ready to be used in the browser in the dist folder.

Install

☕ Install last Node.js stable version (or LTS) and then:

npm i -g @qiskit/sdk

Use

CLI

🚀 The command line client allows to play with the circuits without having to use any programming language API.

qiskitjs --help

Programatically

📝 As you can see in the next section, we have to use it like in the rest of independent modules. The only difference is we need to select the proper field of the main object before.

const qiskit = require('@qiskit/sdk');

console.log('Simulator version');
console.log(qiskit.sim.version);

API

👀 Full specification.

`version`

The actual version of the library.

version (string) - Version number.

`qasm`

A wrapper fot the qiskit-qasm project.

qasm (object) - The same object provided in the original library.

`sim`

A wrapper fot the qiskit-sim project.

sim (object) - The same object provided in the original library.

`Cloud`

A wrapper fot the qiskit-cloud project.

Cloud (object) - The same constructor provided in the original library.

`utils`

A wrapper fot the qiskit-utils project.

utils (object) - The same object provided in the original library.

`algos`

A wrapper fot the qiskit-algos project.

algos (object) - The same object provided in the original library.

Authors

👽 https://github.com/QISKit/qiskit-sdk-js/graphs/contributors

Original code (Python) authors here.

Other QISKit projects

🎒

Python QISKit
ibmqx backend information: Information about the different IBM Q experience backends.
ibmqx user guide: The users guides for the IBM Q experience.
OpenQasm: Examples and tools for the OpenQASM intermediate representation.
Python API: API Client to use IBM Q experience in Python.
Tutorials: Jupyter notebooks for using QISKit.

License

🐧 QISKit is released under the Apache license, v2.0.

Do you want to help?

😎 If you'd like to help please take a look to our contribution guidelines.

cbjuan/qiskit-sdk-js