Skip to content

Commit

Permalink
Cherry pick #1465 and #1467 (#1468)
Browse files Browse the repository at this point in the history
Co-authored-by: Naoki Kanazawa <[email protected]>
  • Loading branch information
coruscating and nkanazawa1989 authored Aug 13, 2024
1 parent d888bdc commit 6837e4c
Show file tree
Hide file tree
Showing 25 changed files with 151 additions and 210 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/NEW_EXPERIMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ different qubits. Verify this also on a real device
experiment data is displayed correctly in the results DB webpage
- [ ] Add unit testing for the experiment and analysis classes. If needed implement a mock-backend for your experiment
Include in your testing running the experiment in the context of `ParallelExperiment`
- [ ] Write API docs for all your API methods. Follow the guideline [here](https://github.com/Qiskit-Extensions/qiskit-experiments/blob/main/CONTRIBUTING.md)
- [ ] Write a user guide for your experiment. Follow the guideline [here](https://github.com/Qiskit-Extensions/qiskit-experiments/blob/main/docs/GUIDELINES.md)
- [ ] Add a new release note. Follow the guideline [here](https://github.com/Qiskit-Extensions/qiskit-experiments/blob/main/CONTRIBUTING.md#adding-a-new-release-note)
- [ ] Write API docs for all your API methods. Follow the guideline [here](https://github.com/Qiskit-Community/qiskit-experiments/blob/main/CONTRIBUTING.md)
- [ ] Write a user guide for your experiment. Follow the guideline [here](https://github.com/Qiskit-Community/qiskit-experiments/blob/main/docs/GUIDELINES.md)
- [ ] Add a new release note. Follow the guideline [here](https://github.com/Qiskit-Community/qiskit-experiments/blob/main/CONTRIBUTING.md#adding-a-new-release-note)
- [ ] Ask for a final review for the implementation, documentation and testing
- [ ] Celebrate!

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/cron-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:

jobs:
qiskit-main-tests:
if: github.repository_owner == 'Qiskit-Extensions'
if: github.repository_owner == 'Qiskit-Community'
name: tests-python${{ matrix.python-version }}-${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down Expand Up @@ -46,7 +46,7 @@ jobs:
env:
TEST_TIMEOUT: 120
docs:
if: github.repository_owner == 'Qiskit-Extensions'
if: github.repository_owner == 'Qiskit-Community'
name: docs
runs-on: ubuntu-latest
steps:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs_dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:

jobs:
deploy:
if: github.repository_owner == 'Qiskit-Extensions'
if: github.repository_owner == 'Qiskit-Community'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:

jobs:
deploy:
if: github.repository_owner == 'Qiskit-Extensions'
if: github.repository_owner == 'Qiskit-Community'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs_stable.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:

jobs:
deploy:
if: github.repository_owner == 'Qiskit-Extensions'
if: github.repository_owner == 'Qiskit-Community'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ concurrency:
cancel-in-progress: true
jobs:
tests:
if: github.repository_owner == 'Qiskit-Extensions'
if: github.repository_owner == 'Qiskit-Community'
name: tests-python${{ matrix.python-version }}-${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down Expand Up @@ -62,7 +62,7 @@ jobs:
run: stestr history remove all

lint:
if: github.repository_owner == 'Qiskit-Extensions'
if: github.repository_owner == 'Qiskit-Community'
name: lint
runs-on: ubuntu-latest
steps:
Expand All @@ -81,7 +81,7 @@ jobs:
- name: Run lint
run: tox -elint
docs:
if: github.repository_owner == 'Qiskit-Extensions'
if: github.repository_owner == 'Qiskit-Community'
name: docs
runs-on: ubuntu-latest
steps:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/neko.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ concurrency:
cancel-in-progress: true
jobs:
neko:
if: github.repository_owner == 'Qiskit-Extensions'
if: github.repository_owner == 'Qiskit-Community'
name: Qiskit Neko Integration Tests
runs-on: ubuntu-latest
steps:
Expand Down
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ experimentalist community.

If there is an experiment you would like to see added, you can propose it by creating a
[new experiment proposal
issue](https://github.com/Qiskit-Extensions/qiskit-experiments/issues/new?assignees=&labels=enhancement&template=NEW_EXPERIMENT.md&title=)
issue](https://github.com/Qiskit-Community/qiskit-experiments/issues/new?assignees=&labels=enhancement&template=NEW_EXPERIMENT.md&title=)
in GitHub. The issue template will ask you to fill in details about the experiment type,
protocol, analysis, and implementation, which will give us the necessary information to
decide whether the experiment is feasible to implement and useful to include in our
Expand All @@ -49,12 +49,12 @@ We use the following labels to help non-maintainers find issues best suited to t
interests and experience level:

* [good first
issue](https://github.com/Qiskit-Extensions/qiskit-experiments/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
issue](https://github.com/Qiskit-Community/qiskit-experiments/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
- these issues are typically the simplest available to work on, perfect for newcomers.
They should already be fully scoped, with a clear approach outlined in the
descriptions.
* [help
wanted](https://github.com/Qiskit-Extensions/qiskit-experiments/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
wanted](https://github.com/Qiskit-Community/qiskit-experiments/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
- these issues are generally more complex than good first issues. They typically cover
work that core maintainers don't currently have capacity to implement and may require
more investigation/discussion. These are a great option for experienced contributors
Expand Down Expand Up @@ -275,7 +275,7 @@ deprecations:
Note that we are using subsections within the `features`, `upgrade`, and `fixes` sections to
organize the notes by functional area. We strongly encourage you to file your note under the most
appropriate category. You can see the current list of categories in
[release_notes/config.yaml](https://github.com/Qiskit-Extensions/qiskit-experiments/blob/main/releasenotes/config.yaml).
[release_notes/config.yaml](https://github.com/Qiskit-Community/qiskit-experiments/blob/main/releasenotes/config.yaml).

You can use any restructured text feature in them (code sections, tables, enumerated
lists, bulleted list, etc.) to express what is being changed as needed. In general, you
Expand All @@ -296,7 +296,7 @@ example you would write a release note with a link to issue 12345 as:
fixes:
- |
Fixed a race condition in the function ``foo()``. Refer to
`#12345 <https://github.com/Qiskit-Extensions/qiskit-experiments/issues/12345>` for more
`#12345 <https://github.com/Qiskit-Community/qiskit-experiments/issues/12345>` for more
details.
```

Expand All @@ -317,19 +317,19 @@ tagged):
At release time, ``reno report`` is used to generate the release notes for the release,
and the output will be submitted as a pull request to the documentation repository's
[release notes file](
https://github.com/Qiskit-Extensions/qiskit-experiments/blob/main/docs/release_notes.rst).
https://github.com/Qiskit-Community/qiskit-experiments/blob/main/docs/release_notes.rst).

### Documentation

The [Qiskit Experiments documentation](https://qiskit-extensions.github.io/qiskit-experiments) is
The [Qiskit Experiments documentation](https://qiskit-community.github.io/qiskit-experiments) is
rendered from `.rst` files as well as experiment and analysis class docstrings into HTML
files.

#### Updating the documentation

Any change that would affect existing documentation, or a new feature that requires a
documentation, should be updated correspondingly. Before updating, review the [existing
documentation](https://qiskit-extensions.github.io/qiskit-experiments) for their style and
documentation](https://qiskit-community.github.io/qiskit-experiments) for their style and
content, and read the [documentation guidelines](docs/GUIDELINES.md) for further
details.

Expand All @@ -355,7 +355,7 @@ will remove Sphinx's cache. If you are still having issues, try adding `-r` your
e.g. `tox -e docs -r`. `-r` tells Tox to reinstall the dependencies. If you encounter a build
error involving `config-inited`, you need to be in the root of
the qiskit-experiments git repository then run `git remote add upstream
https://github.com/Qiskit-Extensions/qiskit-experiments` and `git fetch upstream` before building.
https://github.com/Qiskit-Community/qiskit-experiments` and `git fetch upstream` before building.

There are a few other build options available:

Expand Down Expand Up @@ -440,7 +440,7 @@ policy](https://github.com/Qiskit/qiskit/blob/1.0.0rc1/DEPRECATION.md#issuing-de

The development cycle for Qiskit Experiments is all handled in the open using project
boards in GitHub for project management. We use
[milestones](https://github.com/Qiskit-Extensions/qiskit-experiments/milestones) in GitHub to track
[milestones](https://github.com/Qiskit-Community/qiskit-experiments/milestones) in GitHub to track
work for specific releases. Features or other changes that we want to include in a
release will be tagged and discussed in GitHub.

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Qiskit Experiments

[![License](https://img.shields.io/github/license/Qiskit-Extensions/qiskit-experiments.svg)](https://opensource.org/licenses/Apache-2.0)
[![Release](https://img.shields.io/github/release/Qiskit-Extensions/qiskit-experiments.svg)](https://github.com/Qiskit-Extensions/qiskit-experiments/releases)
[![License](https://img.shields.io/github/license/Qiskit-Community/qiskit-experiments.svg)](https://opensource.org/licenses/Apache-2.0)
[![Release](https://img.shields.io/github/release/Qiskit-Community/qiskit-experiments.svg)](https://github.com/Qiskit-Community/qiskit-experiments/releases)
![Python](https://img.shields.io/pypi/pyversions/qiskit-experiments.svg)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.05329/status.svg)](https://doi.org/10.21105/joss.05329)

**Qiskit Experiments** is a repository that builds tools for building, running,
and analyzing experiments on noisy quantum computers using Qiskit.

To learn more about the package, you can see the
[most up-to-date documentation](https://qiskit-extensions.github.io/qiskit-experiments/dev)
[most up-to-date documentation](https://qiskit-community.github.io/qiskit-experiments/dev)
corresponding to the main branch of this repository or the
[documentation for the latest stable release](https://qiskit-extensions.github.io/qiskit-experiments).
[documentation for the latest stable release](https://qiskit-community.github.io/qiskit-experiments).

## Contribution Guidelines

Expand All @@ -20,7 +20,7 @@ If you'd like to contribute to Qiskit Experiments, please take a look at our
[code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to
uphold this code.

We use [GitHub issues](https://github.com/Qiskit-Extensions/qiskit-experiments/issues) for
We use [GitHub issues](https://github.com/Qiskit-Community/qiskit-experiments/issues) for
tracking requests and bugs. Please
[join the Qiskit Slack community](https://qisk.it/join-slack)
and use the [#experiments](https://qiskit.slack.com/archives/CGZDF48EN) channel for discussion and
Expand All @@ -30,7 +30,7 @@ For questions that are more suited for a forum we use the Qiskit tag in

## Authors and Citation

Qiskit Experiments is the work of [many people](https://github.com/Qiskit-Extensions/qiskit-experiments/graphs/contributors) who contribute
Qiskit Experiments is the work of [many people](https://github.com/Qiskit-Community/qiskit-experiments/graphs/contributors) who contribute
to the project at different levels. If you use Qiskit Experiments, please cite our
[paper](https://doi.org/10.21105/joss.05329) as per the included [citation file](CITATION.cff).

Expand Down
8 changes: 4 additions & 4 deletions docs/GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ example and example outputs by printing relevant analysis results and plot figur
Required and common parameters, such as experiment and analysis options, should be
covered.

See the [Randomized Benchmarking](https://qiskit-extensions.github.io/qiskit-experiments/manuals/verification/randomized_benchmarking.html)
See the [Randomized Benchmarking](https://qiskit-community.github.io/qiskit-experiments/manuals/verification/randomized_benchmarking.html)
guide and its [source code](manuals/verification/randomized_benchmarking.rst) for an
example. Here is a simple template for a manual:

Expand Down Expand Up @@ -276,7 +276,7 @@ There are several predefined sections for the class docstring.
For referring to the website,
.. ref_website:: Qiskit Experiment GitHub, https://github.com/Qiskit-Extensions/qiskit-experiments
.. ref_website:: Qiskit Experiment GitHub, https://github.com/Qiskit-Community/qiskit-experiments
you can use the above macro, where you can provide a string for the hyperlink and
the destination location separated by single comma.
Expand Down Expand Up @@ -380,9 +380,9 @@ header should be named `Analysis Options` to be parsed correctly.
After you complete documentation of your classes, you must add documentation to the
toctree so that it can be rendered as the API documentation. In Qiskit Experiments, we
have a separate tables of contents for each experiment module (e.g. [characterization
experiments](https://qiskit-extensions.github.io/qiskit-experiments/apidocs/mod_characterization.html))
experiments](https://qiskit-community.github.io/qiskit-experiments/apidocs/mod_characterization.html))
and for the [entire
library](https://qiskit-extensions.github.io/qiskit-experiments/apidocs/library.html). Thus we
library](https://qiskit-community.github.io/qiskit-experiments/apidocs/library.html). Thus we
should add document to the tree of a particular module and then reference it to the
entire module.

Expand Down
2 changes: 1 addition & 1 deletion docs/_ext/autoref.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class WebSite(Directive):
.. code-block::
.. ref_website:: qiskit-experiments, https://github.com/Qiskit-Extensions/qiskit-experiments
.. ref_website:: qiskit-experiments, https://github.com/Qiskit-Community/qiskit-experiments
"""

Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
"uncertainties": ("https://pythonhosted.org/uncertainties", None),
"pandas": ("http://pandas.pydata.org/docs/", None),
"qiskit_aer": ("https://qiskit.github.io/qiskit-aer/", None),
"qiskit_dynamics": ("https://qiskit-extensions.github.io/qiskit-dynamics/", None),
"qiskit_dynamics": ("https://qiskit-community.github.io/qiskit-dynamics/", None),
"qiskit_ibm_runtime": ("https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/", None),
}

Expand All @@ -176,7 +176,7 @@
rst_prolog = """
.. note::
This is the documentation for the current state of the `development branch
<https://github.com/Qiskit-Extensions/qiskit-experiments/tree/main>`_
<https://github.com/Qiskit-Community/qiskit-experiments/tree/main>`_
of Qiskit Experiments. The documentation or APIs here can change prior to being
released.
"""
Expand Down
2 changes: 1 addition & 1 deletion docs/howtos/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ familiarize with :ref:`the basics <basics>` of the package before using these gu
|
If there are guides on solving specific problems that you'd like to see added, please
`file an issue on GitHub <https://github.com/Qiskit-Extensions/qiskit-experiments/issues/new?assignees=&labels=enhancement&template=FEATURE_REQUEST.md&title=>`_.
`file an issue on GitHub <https://github.com/Qiskit-Community/qiskit-experiments/issues/new?assignees=&labels=enhancement&template=FEATURE_REQUEST.md&title=>`_.

|
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ We've divided up the documentation into four sections with different purposes:
manuals/index
apidocs/index
release_notes
GitHub <https://github.com/Qiskit-Extensions/qiskit-experiments>
Development Branch Docs <https://qiskit-extensions.github.io/qiskit-experiments/dev/>
GitHub <https://github.com/Qiskit-Community/qiskit-experiments>
Development Branch Docs <https://qiskit-community.github.io/qiskit-experiments/dev/>

|
Expand Down
6 changes: 3 additions & 3 deletions docs/manuals/characterization/stark_experiment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,10 @@ by a variant of the Hahn-echo pulse sequence [5]_.

from qiskit_experiments.library import StarkRamseyXY
from qiskit import schedule, pulse
from qiskit_ibm_runtime.fake_provider import FakeHanoi
from qiskit_ibm_runtime.fake_provider import FakeHanoiV2
from qiskit.visualization.pulse_v2 import IQXSimple

backend = FakeHanoi()
backend = FakeHanoiV2()
exp = StarkRamseyXY(
physical_qubits=[0],
backend=backend,
Expand All @@ -169,7 +169,7 @@ by a variant of the Hahn-echo pulse sequence [5]_.
"formatter.label_offset.pulse_name": 0.1,
"formatter.text_size.annotate": 14,
}
ram_x_schedule.draw(time_range=(0, 1600), style=IQXSimple(**opt), backend=backend)
ram_x_schedule.draw(time_range=(0, 1600), style=IQXSimple(**opt))
The qubit is initialized in the :math:`Y`-eigenstate with the first half-pi pulse.
This state may be visualized by a Bloch vector located on the equator of the Bloch sphere,
Expand Down
Loading

0 comments on commit 6837e4c

Please sign in to comment.