# @qiskit/algo-ibm

> IBM Q engine for Qiskit algorithms

Latest version **0.9.0** (published 2019-05-13) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @qiskit/algo-ibm
pnpm add @qiskit/algo-ibm
yarn add @qiskit/algo-ibm
bun add @qiskit/algo-ibm
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.9.0 |
| Published | 2019-05-13 |
| First published | 2019-05-13 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 20.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 116 |
| Author | IBM RESEARCH |
| Maintainers | abdonrd, qiskit-team, jesusprubio, atilag, jelcaf |
| Keywords | quantum, experience, computing, information, algorithms, random, shor, factor, IBM |

## Links

- npm: https://www.npmjs.com/package/@qiskit/algo-ibm
- Repository: https://github.com/Qiskit/qiskit-js
- Issues: https://github.com/Qiskit/qiskit-js/issues
- npm.io page: https://npm.io/package/@qiskit/algo-ibm

## Dependencies (1)

- [@qiskit/utils](https://npm.io/package/@qiskit/utils.md) ^0.9.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.9.0 (latest) — 2019-05-13

## README

# 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.

---
_Source: https://npm.io/package/@qiskit/algo-ibm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._