Skip to content

Commit

Permalink
Fix branding (#165)
Browse files Browse the repository at this point in the history
  • Loading branch information
rathishcholarajan authored Feb 28, 2022
1 parent 4706575 commit f10d088
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 41 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ assignees: ''

**Additional Information**

- **Qiskit IBM Runtime version**:
- **qiskit-ibm-runtime version**:
- **Python version**:
- **Operating system**:
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ assignees: ''

**Additional Information**

- **Qiskit IBM Runtime version**:
- **qiskit-ibm-runtime version**:
- **Python version**:
- **Operating system**:
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ included in the qiskit documentation:
https://qiskit.org/documentation/contributing_to_qiskit.html


Contributing to Qiskit IBM Runtime
---------------------------
Contributing to qiskit-ibm-runtime
-----------------------------------

In addition to the general guidelines there are specific details for
contributing to the Qiskit IBM Runtime, these are documented below.
contributing to qiskit-ibm-runtime, these are documented below.

### Pull request checklist

Expand Down Expand Up @@ -245,8 +245,8 @@ QISKIT_IBM_INSTANCE=crn:v1:bluemix:... # The CRN value
```


To enable test cases against external system in your private fork, make sure to set above values as
[encrypted environment secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-environment).
To enable test cases against external system in your private fork, make sure to set above values as
[encrypted environment secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-environment).
The names of the environments must match the ones that the [CI workflow](.github/workflows/ci.yml) relies
upon.

Expand Down
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Qiskit IBM Runtime
# Qiskit Runtime IBM Quantum Client
[![License](https://img.shields.io/github/license/Qiskit/qiskit-ibm-runtime.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)[![CI](https://github.com/Qiskit/qiskit-ibm-runtime/actions/workflows/ci.yml/badge.svg)](https://github.com/Qiskit/qiskit-ibm-runtime/actions/workflows/ci.yml)[![](https://img.shields.io/github/release/Qiskit/qiskit-ibm-runtime.svg?style=popout-square)](https://github.com/Qiskit/qiskit-ibm-runtime/releases)[![](https://img.shields.io/pypi/dm/qiskit-ibm-runtime.svg?style=popout-square)](https://pypi.org/project/qiskit-ibm-runtime/)[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)[![Coverage Status](https://coveralls.io/repos/github/Qiskit/qiskit-ibm-runtime/badge.svg?branch=main)](https://coveralls.io/github/Qiskit/qiskit-ibm-runtime?branch=main)


Expand All @@ -7,13 +7,13 @@
**Qiskit Runtime** is a new architecture offered by IBM Quantum that streamlines quantum computations.
It is designed to use classical compute resources to execute quantum circuits with more efficiency on quantum processors.

Using Qiskit Runtime, for example, a research team at IBM Quantum was able to achieve 120x speed
up in their lithium hydride simulation. For more information, see the
Using Qiskit Runtime, for example, a research team at IBM Quantum was able to achieve 120x speed
up in their lithium hydride simulation. For more information, see the
[IBM Research blog](https://research.ibm.com/blog/120x-quantum-speedup).

Qiskit Runtime allows authorized users to upload quantum programs. A quantum program, also called a
Qiskit Runtime allows authorized users to upload quantum programs. A quantum program, also called a
Qiskit runtime program, is a piece of Python code that takes certain inputs, performs
quantum and classical computation, and returns the processing results. The users can then
quantum and classical computation, and returns the processing results. The users can then
invoke these quantum programs by simply passing in the required input parameters.

This module provides the interface to access Qiskit Runtime.
Expand All @@ -26,19 +26,19 @@ You can install this package using pip:
pip install qiskit-ibm-runtime
```

## Account Setup
## Account Setup

### Qiskit Runtime on IBM Cloud

Qiskit Runtime is now part of the IBM Quantum Services on IBM Cloud. To use this service, you'll
need to create an IBM Cloud account and a quantum service instance.
[This guide](https://cloud.ibm.com/docs/quantum-computing?topic=quantum-computing-gettingstarted)
contains step-by-step instructions on setting this up, including directions to find your
Qiskit Runtime is now part of the IBM Quantum Services on IBM Cloud. To use this service, you'll
need to create an IBM Cloud account and a quantum service instance.
[This guide](https://cloud.ibm.com/docs/quantum-computing?topic=quantum-computing-gettingstarted)
contains step-by-step instructions on setting this up, including directions to find your
IBM Cloud API key and Cloud Resource Name (CRN), which you will need for authentication.

### Qiskit Runtime on IBM Quantum

Prior to becoming an IBM Cloud service, Qiskit Runtime was offered on IBM Quantum. If you have an
Prior to becoming an IBM Cloud service, Qiskit Runtime was offered on IBM Quantum. If you have an
existing IBM Quantum account, you can continue using Qiskit Runtime on IBM Quantum, which is referred to as legacy runtime.

You will need your IBM Quantum API token to authenticate with the Qiskit Runtime service:
Expand All @@ -47,8 +47,8 @@ You will need your IBM Quantum API token to authenticate with the Qiskit Runtime

1. Copy (and optionally regenerate) your API token from your
[IBM Quantum account page].
### Saving Account on Disk

### Saving Account on Disk

Once you have the account credentials, you can save them on disk, so you won't have to input
them each time. The credentials are saved in the `$HOME/.qiskit/qiskit-ibm.json` file, where `$HOME` is your home directory.
Expand All @@ -59,7 +59,7 @@ them each time. The credentials are saved in the `$HOME/.qiskit/qiskit-ibm.json`
```python
from qiskit_ibm_runtime import IBMRuntimeService

# Save an IBM Cloud account.
# Save an IBM Cloud account.
IBMRuntimeService.save_account(auth="cloud", token="MY_IBM_CLOUD_API_KEY", instance="MY_IBM_CLOUD_CRN")

# Save an IBM Quantum account.
Expand Down Expand Up @@ -89,7 +89,7 @@ service = IBMRuntimeService()

### Enabling Account for Current Session

As another alternative, you can also enable an account just for the current session by instantiating the
As another alternative, you can also enable an account just for the current session by instantiating the
service with your credentials.

```python
Expand All @@ -114,10 +114,10 @@ service = IBMRuntimeService()
service.pprint_programs()
```

`pprint_programs()` prints the summary metadata of the first 20 programs visible to you. A program's metadata
consists of its ID, name, description, input parameters, return values, interim results, and
`pprint_programs()` prints the summary metadata of the first 20 programs visible to you. A program's metadata
consists of its ID, name, description, input parameters, return values, interim results, and
other information that helps you to know more about the program. `pprint_programs(detailed=True, limit=None)`
will print all metadata for all programs visible to you.
will print all metadata for all programs visible to you.

### Executing a Program

Expand All @@ -144,8 +144,8 @@ result = job.result()

A **backend** is a quantum device or simulator capable of running quantum circuits or pulse schedules.

You can query for the backends you have access to. Attributes and methods of the returned instances
provide information, such as qubit counts, error rates, and statuses, of the backends.
You can query for the backends you have access to. Attributes and methods of the returned instances
provide information, such as qubit counts, error rates, and statuses, of the backends.

```python
from qiskit_ibm_runtime import IBMRuntimeService
Expand All @@ -164,7 +164,7 @@ Now you're set up and ready to check out some of the [tutorials].

## Contribution Guidelines

If you'd like to contribute to Qiskit IBM Runtime, please take a look at our
If you'd like to contribute to qiskit-ibm-runtime, please take a look at our
[contribution guidelines]. This project adheres to Qiskit's [code of conduct].
By participating, you are expected to uphold to this code.

Expand Down
2 changes: 1 addition & 1 deletion docs/apidocs/ibm-runtime.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
*****************************************
Qiskit IBM Runtime API Reference
qiskit-ibm-runtime API Reference
*****************************************

.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@
os.environ['QISKIT_DOCS'] = 'TRUE'

# -- Project information -----------------------------------------------------
project = 'Qiskit IBM Runtime'
copyright = '2021, Qiskit Development Team' # pylint: disable=redefined-builtin
project = 'Qiskit Runtime IBM Quantum Client'
copyright = '2022, Qiskit Development Team' # pylint: disable=redefined-builtin
author = 'Qiskit Development Team'

# The short X.Y version
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#########################################
Qiskit IBM Runtime documentation
Qiskit Runtime documentation
#########################################

Qiskit Runtime
Expand Down Expand Up @@ -35,8 +35,8 @@ Eventually, you will be able to call primitives from a generic program definitio
primitive program interface that best suits your output needs to run circuits seamlessly and efficiently
on IBM quantum systems.

Qiskit IBM Runtime
==================
Qiskit Runtime IBM Quantum Client
=================================

``qiskit-ibm-runtime`` provides the interface to interact with Qiskit Runtime. You can, for example,
use it to query and execute runtime programs:
Expand Down
6 changes: 3 additions & 3 deletions qiskit_ibm_runtime/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@
.. currentmodule:: qiskit_ibm_runtime
Modules related to Qiskit IBM Runtime Service.
Modules related to Qiskit Runtime IBM Quantum Client.
Qiskit Runtime is a new architecture that
streamlines computations requiring many iterations. These experiments will
execute significantly faster within its improved hybrid quantum/classical process.
The Qiskit Runtime Service allows authorized users to upload their Qiskit quantum programs.
Qiskit Runtime IBM Quantum Client allows authorized users to upload their Qiskit quantum programs.
A Qiskit quantum program, also called a runtime program, is a piece of Python
code and its metadata that takes certain inputs, performs
quantum and maybe classical processing, and returns the results. The same or other
Expand Down Expand Up @@ -192,7 +192,7 @@ def result_callback(job_id, result):
Logging
-------
Qiskit IBM Runtime Service uses the ``qiskit_ibm_runtime`` logger.
`qiskit-ibm-runtime` uses the ``qiskit_ibm_runtime`` logger.
Two environment variables can be used to control the logging:
Expand Down
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@
setuptools.setup(
name="qiskit-ibm-runtime",
version=VERSION,
description="Qiskit IBM Runtime service for accessing the quantum devices and "
"simulators at IBM",
description="IBM Quantum client for Qiskit Runtime.",
long_description=README,
long_description_content_type="text/markdown",
url="https://github.com/Qiskit/qiskit-ibm-runtime",
Expand Down
4 changes: 2 additions & 2 deletions test/ibm_test_case.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@


class IBMTestCase(unittest.TestCase):
"""Custom TestCase for use with the Qiskit IBM Runtime."""
"""Custom TestCase for use with qiskit-ibm-runtime."""

@classmethod
def setUpClass(cls):
Expand Down Expand Up @@ -64,7 +64,7 @@ def _set_logging_level(cls, logger: logging.Logger) -> None:


class IBMIntegrationTestCase(IBMTestCase):
"""Custom integration test case for use with the Qiskit IBM Runtime."""
"""Custom integration test case for use with qiskit-ibm-runtime."""

@classmethod
@integration_test_setup()
Expand Down

0 comments on commit f10d088

Please sign in to comment.