diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 74497dcca..45906fc80 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -26,5 +26,5 @@ Before opening the PR, please ensure you have completed the following where appr - [ ] I added unit tests for new code. - [ ] I used [type hints](https://www.python.org/dev/peps/pep-0484/) in function signatures. - [ ] I used [Google-style](https://google.github.io/styleguide/pyguide.html#383-functions-and-methods) docstrings for functions. -- [ ] I [updated the documentation](../blob/master/docs/CONTRIBUTING_DOCS.md) where relevant. +- [ ] I [updated the documentation](../blob/main/docs/CONTRIBUTING_DOCS.md) where relevant. - [ ] Added myself / the copyright holder to the AUTHORS file diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 271e6ffc2..6b2912ecc 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -8,10 +8,10 @@ on: - synchronize - ready_for_review branches: - - master + - main push: branches: - - master + - main jobs: validate: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44b89a1c9..c6a700b8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -125,7 +125,7 @@ Mitiq development abides to the [Contributors' Covenant](https://mitiq.readthedo The basic development workflow for Mitiq is done in units of milestones which are usually one month periods where we focus our efforts on thrusts decided by the development team, alongside community members. Milestones are tracked using the [GitHub milestone feature](https://github.com/unitaryfund/mitiq/milestones) and all issues that are planned to be addressed should be tagged accordingly. -All releases for Mitiq are tagged on the `master` branch with tags for the version number of the release. +All releases for Mitiq are tagged on the `main` branch with tags for the version number of the release. Find all the previous releases [here](https://github.com/unitaryfund/mitiq/releases). ## Code of conduct diff --git a/README.md b/README.md index 4099a77aa..f000ecf04 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Mitiq logo +# Mitiq logo -[![build](https://github.com/unitaryfund/mitiq/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/unitaryfund/mitiq/actions) +[![build](https://github.com/unitaryfund/mitiq/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/unitaryfund/mitiq/actions) [![Documentation Status](https://readthedocs.org/projects/mitiq/badge/?version=stable)](https://mitiq.readthedocs.io/en/stable/) -[![codecov](https://codecov.io/gh/unitaryfund/mitiq/branch/master/graph/badge.svg)](https://codecov.io/gh/unitaryfund/mitiq) +[![codecov](https://codecov.io/gh/unitaryfund/mitiq/branch/main/graph/badge.svg)](https://codecov.io/gh/unitaryfund/mitiq) [![PyPI version](https://badge.fury.io/py/mitiq.svg)](https://badge.fury.io/py/mitiq) [![arXiv](https://img.shields.io/badge/arXiv-2009.04417-.svg)](https://arxiv.org/abs/2009.04417) [![Downloads](https://static.pepy.tech/personalized-badge/mitiq?period=total&units=international_system&left_color=black&right_color=green&left_text=Downloads)](https://pepy.tech/project/mitiq) @@ -82,11 +82,11 @@ See our [guides](https://mitiq.readthedocs.io/en/stable/guide/guide.html) and [e | Technique | Documentation | Mitiq module | Paper Reference(s) | | ----------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| Zero-noise extrapolation | [ZNE](https://mitiq.readthedocs.io/en/latest/guide/zne.html) | [`mitiq.zne`](https://github.com/unitaryfund/mitiq/tree/master/mitiq/zne) | [1611.09301](https://arxiv.org/abs/1611.09301)
[1612.02058](https://arxiv.org/abs/1612.02058)
[1805.04492](https://arxiv.org/abs/1805.04492) | -| Probabilistic error cancellation | [PEC](https://mitiq.readthedocs.io/en/latest/guide/pec.html) | [`mitiq.pec`](https://github.com/unitaryfund/mitiq/tree/master/mitiq/pec) | [1612.02058](https://arxiv.org/abs/1612.02058)
[1712.09271](https://arxiv.org/abs/1712.09271)
[1905.10135](https://arxiv.org/abs/1905.10135) | -| (Variable-noise) Clifford data regression | [CDR](https://mitiq.readthedocs.io/en/latest/guide/cdr.html) | [`mitiq.cdr`](https://github.com/unitaryfund/mitiq/tree/master/mitiq/cdr) | [2005.10189](https://arxiv.org/abs/2005.10189)
[2011.01157](https://arxiv.org/abs/2011.01157) | -| Digital dynamical decoupling | [DDD](https://mitiq.readthedocs.io/en/latest/guide/ddd.html) | [`mitiq.ddd`](https://github.com/unitaryfund/mitiq/tree/master/mitiq/ddd) | [9803057](https://arxiv.org/abs/quant-ph/9803057)
[1807.08768](https://arxiv.org/abs/1807.08768) | -| Readout-error mitigation | [REM](https://mitiq.readthedocs.io/en/latest/guide/rem.html) | [`mitiq.rem`](https://github.com/unitaryfund/mitiq/tree/master/mitiq/rem) | [1907.08518](https://arxiv.org/abs/1907.08518)
[2006.14044](https://arxiv.org/abs/2006.14044) | +| Zero-noise extrapolation | [ZNE](https://mitiq.readthedocs.io/en/latest/guide/zne.html) | [`mitiq.zne`](https://github.com/unitaryfund/mitiq/tree/main/mitiq/zne) | [1611.09301](https://arxiv.org/abs/1611.09301)
[1612.02058](https://arxiv.org/abs/1612.02058)
[1805.04492](https://arxiv.org/abs/1805.04492) | +| Probabilistic error cancellation | [PEC](https://mitiq.readthedocs.io/en/latest/guide/pec.html) | [`mitiq.pec`](https://github.com/unitaryfund/mitiq/tree/main/mitiq/pec) | [1612.02058](https://arxiv.org/abs/1612.02058)
[1712.09271](https://arxiv.org/abs/1712.09271)
[1905.10135](https://arxiv.org/abs/1905.10135) | +| (Variable-noise) Clifford data regression | [CDR](https://mitiq.readthedocs.io/en/latest/guide/cdr.html) | [`mitiq.cdr`](https://github.com/unitaryfund/mitiq/tree/main/mitiq/cdr) | [2005.10189](https://arxiv.org/abs/2005.10189)
[2011.01157](https://arxiv.org/abs/2011.01157) | +| Digital dynamical decoupling | [DDD](https://mitiq.readthedocs.io/en/latest/guide/ddd.html) | [`mitiq.ddd`](https://github.com/unitaryfund/mitiq/tree/main/mitiq/ddd) | [9803057](https://arxiv.org/abs/quant-ph/9803057)
[1807.08768](https://arxiv.org/abs/1807.08768) | +| Readout-error mitigation | [REM](https://mitiq.readthedocs.io/en/latest/guide/rem.html) | [`mitiq.rem`](https://github.com/unitaryfund/mitiq/tree/main/mitiq/rem) | [1907.08518](https://arxiv.org/abs/1907.08518)
[2006.14044](https://arxiv.org/abs/2006.14044) | See our [roadmap](https://github.com/unitaryfund/mitiq/wiki) for additional candidate techniques to implement. If there is a technique you are looking for, please file a [feature request](https://github.com/unitaryfund/mitiq/issues/new?assignees=&labels=feature-request&template=feature_request.md&title=). @@ -98,7 +98,7 @@ We refer to any programming language you can write quantum circuits in as a _fro | [Cirq](https://quantumai.google/cirq) | [Qiskit](https://qiskit.org/) | [pyQuil](https://github.com/rigetti/pyquil) | [Braket](https://github.com/aws/amazon-braket-sdk-python) | [PennyLane](https://pennylane.ai/) |[Qibo](https://qibo.science/) | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| Cirq logo | Qiskit logo | Rigetti logo | AWS logo |    PennyLane logo |    Qibo logo | +| Cirq logo | Qiskit logo | Rigetti logo | AWS logo |    PennyLane logo |    Qibo logo | Note: Cirq is a core requirement of Mitiq and is installed when you `pip install mitiq`. @@ -108,13 +108,13 @@ You can use Mitiq with any backend you have access to that can interface with su ### Citing Mitiq -If you use Mitiq in your research, please reference the [Mitiq whitepaper](https://quantum-journal.org/papers/q-2022-08-11-774/) using the bibtex entry found in [`CITATION.bib`](https://github.com/unitaryfund/mitiq/blob/master/CITATION.bib). +If you use Mitiq in your research, please reference the [Mitiq whitepaper](https://quantum-journal.org/papers/q-2022-08-11-774/) using the bibtex entry found in [`CITATION.bib`](https://github.com/unitaryfund/mitiq/blob/main/CITATION.bib). A list of papers citing Mitiq can be found on [Google Scholar](https://scholar.google.com/scholar?cites=12810395086731011605) / [Semantic Scholar](https://api.semanticscholar.org/CorpusID:221555755?). ## License -[GNU GPL v.3.0.](https://github.com/unitaryfund/mitiq/blob/master/LICENSE) +[GNU GPL v.3.0.](https://github.com/unitaryfund/mitiq/blob/main/LICENSE) ## Contributing diff --git a/docs/source/release.md b/docs/source/release.md index f3f58fa4d..bd75b7420 100644 --- a/docs/source/release.md +++ b/docs/source/release.md @@ -13,7 +13,7 @@ instructions of this document to go through all the steps below: :depth: 3 ``` -## Prepare the master branch +## Prepare the main branch The start of any release is drafting the changelog and bumping the version number. Ensure the commit where these changes are made include authorship for all contributors for the given milestone (code, or not). @@ -44,14 +44,14 @@ SemVer, so typically a release will involve changing the version from ## Do the release -Once the above changes in the `CHANGELOG.md` and `VERSION.txt` are merged into master, you are ready to do the release. +Once the above changes in the `CHANGELOG.md` and `VERSION.txt` are merged into main, you are ready to do the release. ### Create a new tag Once the above changes (new changelog and new version) are merged into -the master branch, checkout and pull the latest on the master branch +the main branch, checkout and pull the latest on the main branch from your local machine. Then once you are up to date, tag the most -recent commit on master (using `git tag`) with a tag that matches the +recent commit on main (using `git tag`) with a tag that matches the number `VERSION.txt` (with a preceding "v", so `0.1.0` is `v0.1.0`) and push this tag to the Github repository. @@ -68,7 +68,7 @@ new release. ``` There should be a new draft release on GitHub created by the -[gh-release](https://github.com/unitaryfund/mitiq/blob/master/.github/workflows/gh-release.yml) action, triggered by the tag you made in the +[gh-release](https://github.com/unitaryfund/mitiq/blob/main/.github/workflows/gh-release.yml) action, triggered by the tag you made in the previous step [here](https://github.com/unitaryfund/mitiq/releases). You will need to review it and publish the release. @@ -88,7 +88,7 @@ significant amount of time. You can check the build status ### Release the new version on PyPI Once the GitHub release is published, the release is also published on -PyPI by the [publish-pypi](https://github.com/unitaryfund/mitiq/blob/master/.github/workflows/publish-pypi.yml) action. This may require a few +PyPI by the [publish-pypi](https://github.com/unitaryfund/mitiq/blob/main/.github/workflows/publish-pypi.yml) action. This may require a few minutes. If it seems like it didn't push a new version to PyPI, you can trigger it manually. Go to diff --git a/mitiq/benchmarks/randomized_benchmarking.py b/mitiq/benchmarks/randomized_benchmarking.py index 59f217d7b..39c4707ff 100644 --- a/mitiq/benchmarks/randomized_benchmarking.py +++ b/mitiq/benchmarks/randomized_benchmarking.py @@ -3,7 +3,7 @@ # module. # Original authors: Cirq developers: Xiao Mi, Dave Bacon, Craig Gidney, # Ping Yeh, Matthew Neely. -# Code URL = ('https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/ +# Code URL = ('https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/ # experiments/qubit_characterizations.py'). # # This source code is licensed under the GPL license (v3) found in the