Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@qiskit/cloud
Advanced tools
@qiskit/cloud - npm Package Compare versions
Comparing version 0.3.0 to 0.4.0
10
index.js
| /** | ||
| * @license | ||
| * | ||
| * Copyright (c) 2017-present, IBM Research. | ||
| * Copyright (c) 2017, IBM. | ||
| * | ||
| * This source code is licensed under the Apache license found in the | ||
| * LICENSE.txt file in the root directory of this source tree. | ||
| * This source code is licensed under the Apache License, Version 2.0 found in | ||
| * the LICENSE.txt file in the root directory of this source tree. | ||
| */ | ||
@@ -23,3 +23,3 @@ | ||
| class Qe { | ||
| class Cloud { | ||
| constructor(opts = {}) { | ||
@@ -350,2 +350,2 @@ dbg('Starting', opts); | ||
| module.exports = Qe; | ||
| module.exports = Cloud; |
| /** | ||
| * @license | ||
| * | ||
| * Copyright (c) 2017-present, IBM Research. | ||
| * Copyright (c) 2017, IBM. | ||
| * | ||
| * This source code is licensed under the Apache license found in the | ||
| * LICENSE.txt file in the root directory of this source tree. | ||
| * This source code is licensed under the Apache License, Version 2.0 found in | ||
| * the LICENSE.txt file in the root directory of this source tree. | ||
| */ | ||
@@ -9,0 +9,0 @@ |
| /** | ||
| * @license | ||
| * | ||
| * Copyright (c) 2017-present, IBM Research. | ||
| * Copyright (c) 2017, IBM. | ||
| * | ||
| * This source code is licensed under the Apache license found in the | ||
| * LICENSE.txt file in the root directory of this source tree. | ||
| * This source code is licensed under the Apache License, Version 2.0 found in | ||
| * the LICENSE.txt file in the root directory of this source tree. | ||
| */ | ||
@@ -9,0 +9,0 @@ |
| /** | ||
| * @license | ||
| * | ||
| * Copyright (c) 2017-present, IBM Research. | ||
| * Copyright (c) 2017, IBM. | ||
| * | ||
| * This source code is licensed under the Apache license found in the | ||
| * LICENSE.txt file in the root directory of this source tree. | ||
| * This source code is licensed under the Apache License, Version 2.0 found in | ||
| * the LICENSE.txt file in the root directory of this source tree. | ||
| */ | ||
@@ -9,0 +9,0 @@ |
| /** | ||
| * @license | ||
| * | ||
| * Copyright (c) 2017-present, IBM Research. | ||
| * Copyright (c) 2017, IBM. | ||
| * | ||
| * This source code is licensed under the Apache license found in the | ||
| * LICENSE.txt file in the root directory of this source tree. | ||
| * This source code is licensed under the Apache License, Version 2.0 found in | ||
| * the LICENSE.txt file in the root directory of this source tree. | ||
| */ | ||
@@ -9,0 +9,0 @@ |
| { | ||
| "name": "@qiskit/cloud", | ||
| "version": "0.3.0", | ||
| "description": "Quantum Information Software library to use the Quantum Experience", | ||
| "version": "0.4.0", | ||
| "description": "Quantum Information Science kit to connect to the Quantum Experience", | ||
| "author": { | ||
@@ -9,13 +9,13 @@ "name": "IBM RESEARCH", | ||
| }, | ||
| "homepage": "https://github.com/QISKit/qiskit-sdk-js", | ||
| "homepage": "https://github.com/Qiskit/qiskit-js", | ||
| "contributors": [ | ||
| "https://github.com/QISKit/qiskit-sdk-js/graphs/contributors" | ||
| "https://github.com/Qiskit/qiskit-js/graphs/contributors" | ||
| ], | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/QISKit/qiskit-sdk-js" | ||
| "url": "https://github.com/Qiskit/qiskit-js" | ||
| }, | ||
| "scripts": { | ||
| "dep-check": "depcheck", | ||
| "test": "mocha --recursive --timeout 8000 test" | ||
| "test": "mocha --recursive --timeout 20000 test --color" | ||
| }, | ||
@@ -33,6 +33,6 @@ "keywords": [ | ||
| "bugs": { | ||
| "url": "https://github.com/QISKit/qiskit-sdk-js/issues" | ||
| "url": "https://github.com/Qiskit/qiskit-js/issues" | ||
| }, | ||
| "dependencies": { | ||
| "@qiskit/utils": "^0.3.0", | ||
| "@qiskit/utils": "^0.4.0", | ||
| "request": "^2.83.0", | ||
@@ -39,0 +39,0 @@ "request-promise-native": "^1.0.5" |
184
README.md
@@ -1,6 +0,6 @@ | ||
| # QISKit.js Quantum Experience | ||
| # Qiskit.js cloud | ||
| :atom_symbol: Quantum Information Software Kit library to use the [Quamtum Experience](https://quantumexperience.ng.bluemix.net). | ||
| :atom_symbol: Quantum Information Science Kit library to use the [Quamtum Experience](https://quantumexperience.ng.bluemix.net). | ||
| Please visit the [main repository](https://github.com/QISKit/qiskit-sdk-js) of the project to know about the rest of the tools. | ||
| Please visit the [main repository](https://github.com/Qiskit/qiskit-js) of the project to know about the rest of the tools. | ||
@@ -43,4 +43,4 @@ ## Install | ||
| * `token` (string) - Long term access token, see next point. | ||
| * `cloud` (object) - New instance. | ||
| - `token` (string) - Long term access token, see next point. | ||
| - `cloud` (object) - New instance. | ||
@@ -51,3 +51,3 @@ ### `token` | ||
| * `token` (string) - Token. | ||
| - `token` (string) - Token. | ||
@@ -58,3 +58,3 @@ ### `userId` | ||
| * `userId` (string) - User identifier. | ||
| - `userId` (string) - User identifier. | ||
@@ -65,3 +65,3 @@ ### `version` | ||
| * `version` (string) - Version number. | ||
| - `version` (string) - Version number. | ||
@@ -72,7 +72,7 @@ ### `async calibration(name) -> info` | ||
| * `name` (string): Name of the backend to inspect. (default: `ibmqx4`) | ||
| * `info` (object): Including next fields: | ||
| * `lastUpdateDate` (string): Date of the last read. | ||
| * `qubits` ([object]): Error in each qubit. | ||
| * `multiQubitGates:` ([object]): Error in each gate. | ||
| - `name` (string): Name of the backend to inspect. (default: `ibmqx4`) | ||
| - `info` (object): Including next fields: | ||
| - `lastUpdateDate` (string): Date of the last read. | ||
| - `qubits` ([object]): Error in each qubit. | ||
| - `multiQubitGates:` ([object]): Error in each gate. | ||
@@ -83,7 +83,7 @@ ### `async parameters(name) -> info` | ||
| * `name` (string): Name of the backend to inspect. (default: `ibmqx4`) | ||
| * `info` (object): Including next fields: | ||
| * `lastUpdateDate` (string): Date of the last read. | ||
| * `fridgeParameters` (string): Information about the cooler. | ||
| * `qubits` ([object]): Error in each qubit. | ||
| - `name` (string): Name of the backend to inspect. (default: `ibmqx4`) | ||
| - `info` (object): Including next fields: | ||
| - `lastUpdateDate` (string): Date of the last read. | ||
| - `fridgeParameters` (string): Information about the cooler. | ||
| - `qubits` ([object]): Error in each qubit. | ||
@@ -94,18 +94,18 @@ ### `async queues(name) -> info` | ||
| * `name` (string): Name of the backend to inspect. (default: `ibmqx4`) | ||
| * `info` (object): Including next fields: | ||
| * `state` (boolean): If the queue is up or down. | ||
| * `status` (string): Actual status of the devices, ie: "busy", "calibration", etc. | ||
| * `lengthQueue` (number): Number of jobs in the queue. | ||
| - `name` (string): Name of the backend to inspect. (default: `ibmqx4`) | ||
| - `info` (object): Including next fields: | ||
| - `state` (boolean): If the queue is up or down. | ||
| - `status` (string): Actual status of the devices, ie: "busy", "calibration", etc. | ||
| - `lengthQueue` (number): Number of jobs in the queue. | ||
| ### `async login(apiToken) -> info` | ||
| ### `async login(apiKey) -> info` | ||
| To authenticate yourself. **This method should be called before the rest ones documented from this point**. | ||
| * `apiToken` (string): QE API token, you can get it [here](https://quantumexperience.ng.bluemix.net/qx/account). | ||
| * `info` (object): New token and its metadata: | ||
| * `token` (string) - New long term access token. | ||
| * `ttl` (number) - Time to live (in seconds). | ||
| * `created` (string) - When the account was created. | ||
| * `userId` (string). | ||
| - `apiKey` (string): QE API key, you can get it [here](https://quantumexperience.ng.bluemix.net/qx/account). | ||
| - `info` (object): New token and its metadata: | ||
| - `token` (string) - HTTP API authentication token. | ||
| - `ttl` (number) - Time to live (in seconds). | ||
| - `created` (string) - When the account was created. | ||
| - `userId` (string). | ||
@@ -116,13 +116,13 @@ ### `async backend(name) -> info` | ||
| * `name` (string): Name of the backend to inspect. (default: `ibmqx4`) | ||
| * `info` ([object]): An object with next fields: | ||
| * `name` (string) - Descriptive name of the device. | ||
| * `status` (string) - If it´s "on" or "off". | ||
| * `serialNumber` (string) | ||
| * `description` (string) | ||
| * `id` (string) | ||
| * `topologyId` (string) | ||
| * `simulator` (boolean): To mark the simulators. | ||
| * `nQubits` (number): Number of Qubits the device has. | ||
| * `couplingMap` ([[number]]): To show how the Qubits are connected in this device. | ||
| - `name` (string): Name of the backend to inspect. (default: `ibmqx4`) | ||
| - `info` ([object]): An object with next fields: | ||
| - `name` (string) - Descriptive name of the device. | ||
| - `status` (string) - If it´s "on" or "off". | ||
| - `serialNumber` (string) | ||
| - `description` (string) | ||
| - `id` (string) | ||
| - `topologyId` (string) | ||
| - `simulator` (boolean): To mark the simulators. | ||
| - `nQubits` (number): Number of Qubits the device has. | ||
| - `couplingMap` ([[number]]): To show how the Qubits are connected in this device. | ||
@@ -133,4 +133,4 @@ ### `async backends(onlySims) -> infos` | ||
| * `onlySims` (boolean): To get only info of the simulators. (default: false) | ||
| * `infos` ([object]): A list of "info" objects (see last method). | ||
| - `onlySims` (boolean): To get only info of the simulators. (default: false) | ||
| - `infos` ([object]): A list of "info" objects (see last method). | ||
@@ -141,13 +141,13 @@ ### `async run(circuit, opts) -> info` | ||
| * `circuit` (string): Circuit in OpenQASM. | ||
| * `opts` (object): With next fields: | ||
| * `backend` (string): Name of the backend to use. (default: simulator) | ||
| * `shots` (number): Number of times to run the circuit. (default: 1) | ||
| * `name` (string): Human friendly indetifier. | ||
| * `seed` (string): Noise entropy, only allowed if using the simulator. | ||
| * `maxCredits` (number): Max number of the credits to run this job. The task will be cancelled if it needs more. | ||
| * `info` (object): Including next fields: | ||
| * `id` (string): Unique identifier for the job created to run this circuit. | ||
| * `status` (string): To know if the complete job has finished. Supported: "RUNNING", "ERROR_CREATING_JOB", "ERROR_RUNNING_JOB" or "COMPLETED". | ||
| * `name` (string): Passed (or generated) human friendly indetifier. | ||
| - `circuit` (string): Circuit in OpenQASM. | ||
| - `opts` (object): With next fields: | ||
| - `backend` (string): Name of the backend to use. (default: simulator) | ||
| - `shots` (number): Number of times to run the circuit. (default: 1) | ||
| - `name` (string): Human friendly indetifier. | ||
| - `seed` (string): Noise entropy, only allowed if using the simulator. | ||
| - `maxCredits` (number): Max number of the credits to run this job. The task will be cancelled if it needs more. | ||
| - `info` (object): Including next fields: | ||
| - `id` (string): Unique identifier for the job created to run this circuit. | ||
| - `status` (string): To know if the complete job has finished. Supported: "RUNNING", "ERROR_CREATING_JOB", "ERROR_RUNNING_JOB" or "COMPLETED". | ||
| - `name` (string): Passed (or generated) human friendly indetifier. | ||
@@ -158,15 +158,15 @@ ### `async runBatch(circuits, opts) -> infos` | ||
| * `circuits` ([object]): Batch of circuits. Being "object": | ||
| * `qasm` (string): Circuit in OpenQASM. The unique mandatory field. | ||
| * `name` | ||
| * `shots`: Only to overwrite this parameter defined in "opts" for this piece of code. | ||
| * `seed`: Same than "shots". | ||
| * `opts` | ||
| * `backend` | ||
| * `shots` | ||
| * `seed` | ||
| * `maxCredits` | ||
| * `infos` ([object]): Including next fields: | ||
| * `id` | ||
| * `status` | ||
| - `circuits` ([object]): Batch of circuits. Being "object": | ||
| - `qasm` (string): Circuit in OpenQASM. The unique mandatory field. | ||
| - `name` | ||
| - `shots`: Only to overwrite this parameter defined in "opts" for this piece of code. | ||
| - `seed`: Same than "shots". | ||
| - `opts` | ||
| - `backend` | ||
| - `shots` | ||
| - `seed` | ||
| - `maxCredits` | ||
| - `infos` ([object]): Including next fields: | ||
| - `id` | ||
| - `status` | ||
@@ -177,24 +177,24 @@ ### `async job(id) -> info` | ||
| * `id` (string): Job identifier. | ||
| * `info` (object): Including next fields: | ||
| * `id` (string): Unique identifier for the job. | ||
| * `backend` (string): Passed name of the backend to use. | ||
| * `shots` (number): Passed number of times to run the circuit. | ||
| * `creationDate` (string): When the job has entered into the system. | ||
| * `usedCredits` (number): Number of consumed credits by the run. | ||
| * `status` (string): To know if the complete job has finished. Supported: "RUNNING", "ERROR_CREATING_JOB", "ERROR_RUNNING_JOB" or "COMPLETED". | ||
| * `maxCredits` (number): Max number passed of credits to use in this run before cancel it. | ||
| * `circuits` ([object]): Batch of circuits. Being "object": | ||
| * `qasm` (string): Passed circuit. | ||
| * `name` (string): Passed (or generated) human friendly indetifier. | ||
| * `shots` (number): If the parameter defined in "opts" was overwritten. | ||
| * `seed` (string): If the parameter defined in "opts" was overwritten. | ||
| * `execution` (object): Generated execution info, with these fields: | ||
| * `id` (string): Identifier of the execution of this program. | ||
| * `status` (string): Status of this execution of the program. Supported: "WORKING_IN_PROGRESS", "DONE", "ERROR", "NOT_APPROVED". | ||
| * `result` (object): Present only when the job has finished. | ||
| * `date` (string): When the job finished. | ||
| * `data` (object): | ||
| * `time` (number): How long it took, in seconds. | ||
| * `count` (object): For each shot (value/key pair) the keys represent the final state of the qubits, and the value their probability. ie: { "00000": 189, "00001": 10 } | ||
| - `id` (string): Job identifier. | ||
| - `info` (object): Including next fields: | ||
| - `id` (string): Unique identifier for the job. | ||
| - `backend` (string): Passed name of the backend to use. | ||
| - `shots` (number): Passed number of times to run the circuit. | ||
| - `creationDate` (string): When the job has entered into the system. | ||
| - `usedCredits` (number): Number of consumed credits by the run. | ||
| - `status` (string): To know if the complete job has finished. Supported: "RUNNING", "ERROR_CREATING_JOB", "ERROR_RUNNING_JOB" or "COMPLETED". | ||
| - `maxCredits` (number): Max number passed of credits to use in this run before cancel it. | ||
| - `circuits` ([object]): Batch of circuits. Being "object": | ||
| - `qasm` (string): Passed circuit. | ||
| - `name` (string): Passed (or generated) human friendly indetifier. | ||
| - `shots` (number): If the parameter defined in "opts" was overwritten. | ||
| - `seed` (string): If the parameter defined in "opts" was overwritten. | ||
| - `execution` (object): Generated execution info, with these fields: | ||
| - `id` (string): Identifier of the execution of this program. | ||
| - `status` (string): Status of this execution of the program. Supported: "WORKING_IN_PROGRESS", "DONE", "ERROR", "NOT_APPROVED". | ||
| - `result` (object): Present only when the job has finished. | ||
| - `date` (string): When the job finished. | ||
| - `data` (object): | ||
| - `time` (number): How long it took, in seconds. | ||
| - `count` (object): For each shot (value/key pair) the keys represent the final state of the qubits, and the value their probability. ie: { "00000": 189, "00001": 10 } | ||
@@ -205,4 +205,4 @@ ### `async jobs(limit, skip) -> infos` | ||
| * `limit` (number): Limit the number of instances to return. (default: 50) | ||
| * `offset` (number): Skip the specified number of instances. Use it with "limit" to implement result pagination. | ||
| * `infos` ([object]): The info for the required jobs. The object structure is like the one returned by the method `job`. | ||
| - `limit` (number): Limit the number of instances to return. (default: 50) | ||
| - `offset` (number): Skip the specified number of instances. Use it with "limit" to implement result pagination. | ||
| - `infos` ([object]): The info for the required jobs. The object structure is like the one returned by the method `job`. |
Fixed alerts
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
Improved metrics
- Number of low maintenance alerts
- decreased by-50%
1
- Number of low quality alerts
- decreased by-50%
1
Worsened metrics
- Total package byte prevSize
- decreased by-0.19%
21001
Dependency changes
+ Added@qiskit/utils@0.4.0(transitive)
- Removed@qiskit/utils@0.3.0(transitive)
Updated@qiskit/utils@^0.4.0