Skip to content

Commit

Permalink
Fix readme and docs (#332)
Browse files Browse the repository at this point in the history
  • Loading branch information
rathishcholarajan committed Apr 22, 2022
1 parent 73e66fb commit f072fd0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@
This project contains a provider that allows accessing the **[IBM Quantum]**
systems and simulators.

## Migrating
If you are migrating from `qiskit-ibmq-provider` please follow the instructions in the [migration guide].

## Installation

You can install the provider using pip:
Expand All @@ -37,7 +34,7 @@ pip install qiskit-ibm-provider
IBMProvider.save_account(token='MY_API_TOKEN')
```

The command above stores your credentials locally in a configuration file called `qiskitrc`. By default, this file is located in `$HOME/.qiskit`, where `$HOME` is your home directory.
The command above stores your credentials locally in a configuration file called `qiskit-ibm.json`. By default, this file is located in `$HOME/.qiskit`, where `$HOME` is your home directory.
Once saved you can then instantiate the provider like below and access the backends:

```python
Expand All @@ -54,7 +51,7 @@ pip install qiskit-ibm-provider
### Load Account from Environment Variables
Alternatively, the IBM Provider can discover credentials from environment variables:
```bash
export QISKIT_IBM_API_TOKEN='MY_API_TOKEN'
export QISKIT_IBM_TOKEN='MY_API_TOKEN'
```

Then instantiate the provider without any arguments and access the backends:
Expand Down Expand Up @@ -114,4 +111,3 @@ project at different levels. If you use Qiskit, please cite as per the included
[Qiskit]: https://github.com/Qiskit/qiskit-tutorial
[BibTeX file]: https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib
[Apache License 2.0]: https://github.com/Qiskit/qiskit-ibm-provider/blob/main/LICENSE.txt
[migration guide]: https://github.com/Qiskit/qiskit-ibm-provider/blob/main/MIGRATING.md
4 changes: 2 additions & 2 deletions qiskit_ibm_provider/ibm_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ class IBMProvider(Provider):
provider = IBMProvider()
Instead of saving credentials to disk, you can also set the environment
variables QISKIT_IBM_API_TOKEN, QISKIT_IBM_API_URL, QISKIT_IBM_HUB, QISKIT_IBM_GROUP
and QISKIT_IBM_PROJECT and then instantiate the provider like below::
variables QISKIT_IBM_TOKEN, QISKIT_IBM_URL and QISKIT_IBM_INSTANCE
and then instantiate the provider like below::
from qiskit_ibm_provider import IBMProvider
provider = IBMProvider()
Expand Down

0 comments on commit f072fd0

Please sign in to comment.