open-index/open-npm huggingface dataset:
npm package: @qiskit/algo-anu
Description: Australia National University engine for Qiskit algorithms
Author: IBM RESEARCH
Latest version: 0.9.0
Deprecated: Archived project

# Qiskit.js algo (ANU)

The [Australian National University](http://www.anu.edu.au) [Quantum Random Numbers Server](https://qrng.anu.edu.au) engine (chip) for the [Qiskit algorithms package](https://github.com/Qiskit/qiskit-js/tree/master/packages/qiskit-algo).

## Install

:coffee: Install lastest [Node.js](https://nodejs.org/download) stable version (or LTS) and then:

```sh
npm i @qiskit/algo-anu
```

## Use

:pencil: You can visit the complete example [in this test](./test/functional.js).

```js
const qiskit = require('@qiskit/algo-anu');

console.log('Version');
console.log(qiskit.version);
```

## API

:eyes: Please check the [main doc](../../README.md#API). The methods signature is the same but:

* As expected, the `engine` parameter is omitted here.
* Only the `random` method is supported.
npm package: @qiskit/algo-ibm
Description: IBM Q engine for Qiskit algorithms
Author: IBM RESEARCH
Latest version: 0.9.0
Deprecated: Archived project

# Qiskit.js algo (IBM Q)

[IBM Q](https://www.research.ibm.com/ibm-q) engine (chip and remote simulator) for the [Qiskit algorithms package](https://github.com/Qiskit/qiskit-js/tree/master/packages/qiskit-algo).

## Install

:coffee: Install lastest [Node.js](https://nodejs.org/download) stable version (or LTS) and then:

```sh
npm i @qiskit/algo-ibm
```

## Use

:pencil: You can visit the complete example [in this test](./test/functional.js).

```js
const Cloud = require('qiskit/cloud');
const qiskit = require('qiskit/algo-ibm');

const cloud = new Cloud();
cloud.login('YOUR_PERSONAL_TOKEN_HERE')
  .then(() => {
    cloud.backends()
      .then(data => {
        console.log('Backends:');
        console.log(data);
      });

    qiskit.random({
      custom: cloud,
      // default: simulator
      // engine: "ibmqx4"
    })
      .then(rand => console.log(`Random: ${rand}`))
  });
```

## API

:eyes: Please check the [main doc](../../README.md#API). The method signature is the same but:

- As expected, the `engine` parameter is omitted here.
- All algorithms need a background job, so a `jobId` is returned.
- About the options:
  - `custom` (object): Mandatory here, it should be a logged [qiskit-cloud](../qiskit-cloud) instance.
  - `backend` (string): Name of the backend to use. (default: simulator)
  - `shots` (number): Number of times to run the circuit. (default: 1)
  - `maxCredits` (number): Max number of the credits to run this job. The task will be cancelled if it needs more.
npm package: @qiskit/algo-js
Description: Pure JavaScript engine for Qiskit algorithms
Author: IBM RESEARCH
Latest version: 0.9.0
Deprecated: Archived project

# Qiskit.js algo (pure JavaScript)

Pure JS engine ([jsqubits](https://www.npmjs.com/package/jsqubits) based) engine (simulator) for the [Qiskit algorithms package](https://github.com/Qiskit/qiskit-js/tree/master/packages/qiskit-algo).

## Install

:coffee: Install lastest [Node.js](https://nodejs.org/download) stable version (or LTS) and then:

```sh
npm i @qiskit/algo-js
```

## Use

:pencil: You can visit the complete example [in this test](test/functional.js).

```js
const qiskit = require('@qiskit/algo-js');

console.log('Version');
console.log(qiskit.version);
```

## API

:eyes: Please check the [main doc](../../README.md#API). The methods signature is the same but:

* As expected, the `engine` parameter is omitted here.
* All algorithms doesn't need a background job, so a result is returned (vs a `jobId`).
npm package: @qiskit/algos
Description: Quantum Information algorithms for humans
Author: IBM RESEARCH
Latest version: 0.2.0
Deprecated: Please, use @qiskit/devs package instead

# QISKit.js algorithms

:atom_symbol: Quantum Information Software Kit Quantum Information algorithms for humans.

Please visit the [main repository](https://github.com/QISKit/qiskit-sdk-js) of the project to know about the rest of the tools.

## Install

:coffee: Install [Node.js](https://nodejs.org/download) v8 and then:

```sh
npm i @qiskit/algos
```

## Use

:pencil: You can visit the complete example [in this test](./test/functional/index.js).

```js
const algos = require('@qiskit/algos');

console.log('Version');
console.log(algos.version);

const token = 'YOUR_LONG_TERM_TOKEN';
const userId = 'YOUR_USER_ID';

// With the default backend and length.
const jobId = await algos.random(token, userId)
console.log(`JobId: ${jobId}`)

// ... later
console.log(await algos.result(token, userId, jobId))
```

## API

:eyes: Full specification.

### `version`

The actual version of the library.

* `version` (string) - Version number.

### `async random(token, userId, opts) -> jobId`

Generate a true random number among 0 and 1.

* `token` (string) - QX long term access token (provided by the `login` method of the [qisqit-cloud](../qiskit-cloud) package).
* `userId` (string) - User identifier, same that for the last option.
* `opts` (object) - Optional parameters:
  * `backend` (string) - Where to run the operation. Supported: "simulator", "ibmqx2", "ibmqx4", "ibmqx5", "qs1_1". (default: "simulator")
  * `length` (number) - Number of random hex characters to ask for, used as entropy. (default: 16)
* `jobId` (string) - Identifier for the generated background job (see next method).

### `async result(token, userId, jobId) -> result`

Get the result of a background job generated by an algorithm method.

* `token`
* `userId`
* `jobId` (string) - Job identifier got as initial response.
* `result` (?) - Depending on the used agorithm:
  * "random": (object) - With nex fields:
    * `status` (string) - To know if the job has finished correctly. Supported: "running", "completed", TODO.
    * `data` (number) - Generated random number. Only present if "status" is "completed".