Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mapmeld/jsquil
Quantum computer instructions for JavaScript developers
https://github.com/mapmeld/jsquil
quantum-computing
Last synced: about 2 months ago
JSON representation
Quantum computer instructions for JavaScript developers
- Host: GitHub
- URL: https://github.com/mapmeld/jsquil
- Owner: mapmeld
- License: apache-2.0
- Created: 2017-03-06T21:30:32.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-06-24T23:24:11.000Z (over 4 years ago)
- Last Synced: 2024-06-11T18:07:45.975Z (7 months ago)
- Topics: quantum-computing
- Language: JavaScript
- Size: 37.1 KB
- Stars: 50
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-quantum-software - jsquil - JavaScript interface for writing [Quil](https://en.wikipedia.org/wiki/Quil_(instruction_set_architecture)) programs. (Quantum simulators)
README
# jsquil
[](https://greenkeeper.io/)
JavaScript interface for writing Quil programs, based on Rigetti Computing's
pyQuil package.
Make a list of instructions to run on a hybrid computer with both qubits and classical registers, and then use the
measure instruction to store a qubit value onto a classical register.
You can then return the value of these classical registers on each run of your program.
# Want more JS and Quantum Computers?
## Upgrade to Quantum Peep
Multi-platform, async quantum computing library written in TypeScript
## Sample code
Tests based on the example code in pyQuil
```javascript
import { gates, inits, operations, Program, QVM, Connection } from 'jsquil'
// request API credentials from http://rigetti.com/forest
let c = new Connection({
user_id: 'USER_ID',
api_key: 'API_KEY'
});
// connection for QVM Docker container (which I host)
let c2 = new Connection({
user_id: 'USER_ID',
api_key: 'API_KEY'
}, 'http://165.227.62.245:5000');
let q = new QVM(c2);
let p = new Program();
// put an X gate on the zeroth qubit
p.inst(gates.X(0));
// store the zeroth qubit's value in the first classical register
p.measure(0, 1);
// p now contains Quil instructions, which look like this:
// p.code()
// > DECLARE ro BIT[2]
// > X 0
// > MEASURE 0 ro[1]
// run the program twice, returning classical registers from each iteration
q.run(p, 2, (err, returns) => {
// err = null
// returns = [[1], [1]]
});
```
Changing the run command to execute a program ten times:
```javascript
q.run(p, 10, (err, returns) => { });
```
Two ways to write a series of gate commands:
```javascript
p.inst(gates.X(0), gates.Y(1), gates.Z(0));
// same as
p.inst(gates.X(0));
p.inst(gates.Y(1));
p.inst(gates.Z(0));
p.code();
> "X 0\nY 1\nZ 0\n"
```
```javascript
p.inst(
gates.H(2),
gates.CPHASE(Math.PI / 2, 1, 2),
gates.H(1),
gates.CPHASE(Math.PI / 4, 0, 2),
gates.CPHASE(Math.PI / 2, 0, 1),
gates.H(0),
gates.SWAP(0, 2)
);
```
Initializing a classical register value
```javascript
p.inst( inits.TRUE(0) );
```
Operations on classical registers
```javascript
p.inst(operations.EXCHANGE(0, 1));
// others: NOT, AND, OR, MOVE
```
Reset, wait, and halt commands:
```javascript
p.reset();
p.wait();
p.halt();
```
Looping some instructions while a classical register value is TRUE
```javascript
let classical_register = 2;
let loop_program = new Program();
loop_program.inst(gates.X(0), gates.H(0));
loop_program.measure(0, classical_register);
p.while_do(classical_register, loop_program);
```
An if-then-else statement combines multiple program objects and chooses one based on a classical register bit value
```javascript
let then_branch = new Program();
...
let else_branch = new Program();
...
p.if_then(test_register, then_branch, else_branch);
```
Adding gate and measurement noise to the QVM, to simulate a quantum computer
```javascript
let gate_noise = [x, y, z];
let measure_noise = [0.2, 0, 0];
let q = new QVM(connection, gate_noise, measure_noise);
```
### Endpoints
If the endpoint changes:
```javascript
let c = new Connection({
user_id: 'USER_ID',
api_key: 'API_KEY'
}, 'https://endpoint.example.com');
```
## Tests
```bash
npm install mocha -g
npm test
```
## License
Apache license (same as pyQuil)