Skip to content
This repository was archived by the owner on Jul 28, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,15 @@ sudo: false
stage_generic: &stage_generic
install:
# Install step for jobs that require compilation and qa.
# TODO: until the split is complete, install a terra branch.
# TODO: until terra 0.8 is released, install a terra branch and this
# package dependencies manually.
# - pip install -U -r requirements.txt
- pip install "requests>=2.19"
- pip install "requests-ntlm>=1.1.0"
- pip install "websockets>=7,<8"
- git clone https://github.com/Qiskit/qiskit-terra.git
- pip install cython
- pip install -e qiskit-terra
- pip install -r requirements.txt
- pip install -U -r requirements-dev.txt
script:
# Run the tests.
Expand Down
8 changes: 4 additions & 4 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ The format is based on `Keep a Changelog`_.
^^^^^^^^^^^^^


`0.1rc3`_
^^^^^^^^^
`0.1`_
^^^^^^


Added
Expand Down Expand Up @@ -54,7 +54,7 @@ Removed



.. _UNRELEASED: https://github.com/Qiskit/qiskit-ibmq-provider/compare/104d524...HEAD
.. _0.1rc3: https://github.com/Qiskit/qiskit-ibmq-provider/compare/104d524...0.1rc3
.. _UNRELEASED: https://github.com/Qiskit/qiskit-ibmq-provider/compare/0.1...HEAD
.. _0.1rc3: https://github.com/Qiskit/qiskit-ibmq-provider/compare/104d524...0.1

.. _Keep a Changelog: http://keepachangelog.com/en/1.0.0/
39 changes: 29 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
Qiskit is an open-source framework for working with noisy intermediate-scale
quantum computers (NISQ) at the level of pulses, circuits, and algorithms.

This module contains a provider that allows accessing the [**IBM Q**](https://www.research.ibm.com/ibm-q/) quantum devices and
simulators.
This module contains a provider that allows accessing the **[IBM Q]** quantum
devices and simulators.

## Installation

Expand All @@ -21,16 +21,15 @@ PIP will handle all dependencies automatically for us and you will always
install the latest (and well-tested) version.

To install from source, follow the instructions in the
[contribution guidelines](.github/CONTRIBUTING.rst).
[contribution guidelines].

## Setting up the IBMQ provider

Once the package is installed, you can access the provider from Qiskit.

### Configure your IBMQ credentials

1. Create an _[IBM Q](https://quantumexperience.ng.bluemix.net) > Account_ if
you haven't already done so.
1. Create an [IBM Q account] if you haven't already done so.

2. Get an API token from the IBM Q website under
_My Account > Advanced > API Token_.
Expand Down Expand Up @@ -64,19 +63,39 @@ For those who do not want to save there credentials to disk please use
## Contribution Guidelines

If you'd like to contribute to IBM Q provider, please take a look at our
[contribution guidelines](.github/CONTRIBUTING.rst). This project adheres to Qiskit's [code of conduct](.github/CODE_OF_CONDUCT.rst). By participating, you are expect to uphold to this code.
[contribution guidelines]. This project adheres to Qiskit's [code of conduct].
By participating, you are expect to uphold to this code.

We use [GitHub issues](https://github.com/Qiskit/qiskit-ibmq-provider/issues) for tracking requests and bugs. Please use our [slack](https://qiskit.slack.com) for discussion and simple questions. To join our Slack community use the [link](https://join.slack.com/t/qiskit/shared_invite/enQtNDc2NjUzMjE4Mzc0LTMwZmE0YTM4ZThiNGJmODkzN2Y2NTNlMDIwYWNjYzA2ZmM1YTRlZGQ3OGM0NjcwMjZkZGE0MTA4MGQ1ZTVmYzk). For questions that are more suited for a forum we use the Qiskit tag in the [Stack Overflow](https://stackoverflow.com/questions/tagged/qiskit).
We use [GitHub issues] for tracking requests and bugs. Please use our [slack]
for discussion and simple questions. To join our Slack community use the
[invite link]. For questions that are more suited for a forum we use the
`Qiskit` tag in [Stack Exchange].

## Next Steps

Now you're set up and ready to check out some of the other examples from our
[Qiskit Tutorial](https://github.com/Qiskit/qiskit-tutorial) repository.
[Qiskit Tutorial] repository.

## Authors and Citation

The Qiskit IBM Q provider is the work of [many people](https://github.com/Qiskit/qiskit-terra/graphs/contributors) who contribute to the project at different levels. If you use Qiskit, please cite as per the included [BibTeX file](https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib).
The Qiskit IBM Q provider is the work of [many people] who contribute to the
project at different levels. If you use Qiskit, please cite as per the included
[BibTeX file].

## License

[Apache License 2.0](LICENSE.txt)
[Apache License 2.0].


[IBM Q]: https://www.research.ibm.com/ibm-q/
[IBM Q account]: https://quantumexperience.ng.bluemix.net
[contribution guidelines]: https://github.com/Qiskit/qiskit-ibmq-provider/blob/master/.github/CONTRIBUTING.rst
[code of conduct]: https://github.com/Qiskit/qiskit-ibmq-provider/blob/master/.github/CODE_OF_CONDUCT.rst
[GitHub issues]: https://github.com/Qiskit/qiskit-ibmq-provider/issues
[slack]: https://qiskit.slack.com
[invite link]: https://join.slack.com/t/qiskit/shared_invite/enQtNDc2NjUzMjE4Mzc0LTMwZmE0YTM4ZThiNGJmODkzN2Y2NTNlMDIwYWNjYzA2ZmM1YTRlZGQ3OGM0NjcwMjZkZGE0MTA4MGQ1ZTVmYzk
[Stack Exchange]: https://quantumcomputing.stackexchange.com/questions/tagged/qiskit
[Qiskit Tutorial]: https://github.com/Qiskit/qiskit-tutorial
[many people]: https://github.com/Qiskit/qiskit-terra/graphs/contributors
[BibTeX file]: https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib
[Apache License 2.0]: https://github.com/Qiskit/qiskit-ibmq-provider/blob/master/LICENSE.txt
2 changes: 1 addition & 1 deletion qiskit/providers/ibmq/VERSION.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1rc3
0.1
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
from setuptools import setup

requirements = [
#"qiskit-terra>=0.8", # TODO: disabled for developers convenience
"qiskit-terra>=0.8",
"requests>=2.19",
"requests-ntlm>=1.1.0",
"websockets>=7,<8"
Expand All @@ -32,7 +32,8 @@
setup(
name="qiskit-ibmq-provider",
version=VERSION,
description="Qiskit provider for IBM Q quantum devices and simulators",
description="Qiskit provider for accesing the quantum devices and "
"simulators at IBMQ",
long_description=README,
long_description_content_type='text/markdown',
url="https://github.com/Qiskit/qiskit-ibmq-provider",
Expand Down