From d2f168542526e1bcd375729c539621dc2d8a0c03 Mon Sep 17 00:00:00 2001 From: Leonardo Andreta de Castro Date: Fri, 9 Dec 2022 10:37:56 +1100 Subject: [PATCH 1/2] build: Bump certifi --- poetry.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/poetry.lock b/poetry.lock index 263f502..e3b28a0 100644 --- a/poetry.lock +++ b/poetry.lock @@ -123,7 +123,7 @@ python-versions = "*" [[package]] name = "certifi" -version = "2022.6.15" +version = "2022.12.7" description = "Python package for providing Mozilla's CA Bundle." category = "main" optional = false @@ -1480,8 +1480,8 @@ backcall = [ {file = "backcall-0.2.0.tar.gz", hash = "sha256:5cbdbf27be5e7cfadb448baf0aa95508f91f2bbc6c6437cd9cd06e2a4c215e1e"}, ] certifi = [ - {file = "certifi-2022.6.15-py3-none-any.whl", hash = "sha256:fe86415d55e84719d75f8b69414f6438ac3547d2078ab91b67e779ef69378412"}, - {file = "certifi-2022.6.15.tar.gz", hash = "sha256:84c85a9078b11105f04f3036a9482ae10e4621616db313fe045dd24743a0820d"}, + {file = "certifi-2022.12.7-py3-none-any.whl", hash = "sha256:4ad3232f5e926d6718ec31cfc1fcadfde020920e278684144551c91769c7bc18"}, + {file = "certifi-2022.12.7.tar.gz", hash = "sha256:35824b4c3a97115964b408844d64aa14db1cc518f6562e8d7261699d1350a9e3"}, ] cffi = [ {file = "cffi-1.15.1-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:a66d3508133af6e8548451b25058d5812812ec3798c886bf38ed24a98216fab2"}, From 8d37c9a7763b353e9609088d78e81032fc2a8743 Mon Sep 17 00:00:00 2001 From: Leonardo Andreta de Castro Date: Mon, 12 Dec 2022 17:08:58 +1100 Subject: [PATCH 2/2] chore: Add deprecation notices to READMEs --- .github/README.md | 125 +--------------------------------------------- README.md | 10 +--- 2 files changed, 4 insertions(+), 131 deletions(-) diff --git a/.github/README.md b/.github/README.md index c8dbec7..e3237e3 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,123 +1,2 @@ -# Q-CTRL Python PyQuil - -The aim of the Q-CTRL pyQuil Adapter package is to provide export functions allowing -users to deploy established error-robust quantum control protocols from the -open literature and defined in Q-CTRL Open Controls on Rigetti quantum hardware -and simulators. - -Anyone interested in quantum control is welcome to contribute to this project. - -## Installation - -Q-CTRL pyQuil Adapter can be installed through `pip` or from source. We recommend -the `pip` distribution to get the most recent stable release. If you want the -latest features then install from source. - -### Requirements - -To use Q-CTRL pyQuil Adapter you will need an installation of Python. We -recommend using the [Anaconda](https://www.anaconda.com/) distribution of -Python. Anaconda includes standard numerical and scientific Python packages -which are optimally compiled for your machine. Follow the [Anaconda -Installation](https://docs.anaconda.com/anaconda/install/) instructions and -consult the [Anaconda User -guide](https://docs.anaconda.com/anaconda/user-guide/) to get started. - -We use interactive jupyter notebooks for our usage examples. The Anaconda -python distribution comes with editors for these files, or you can [install the -jupyter notebook editor](https://jupyter.org/install) on its own. - -### Using PyPi - -Use `pip` to install the latest version of Q-CTRL pyQuil Adapter. - -```shell -pip install qctrl-pyquil -``` - -### From Source - -The source code is hosted on -[Github](https://github.com/qctrl/python-pyquil). The repository can be -cloned using - -```shell -git clone git@github.com:qctrl/python-pyquil.git -``` - -Once the clone is complete, you have two options: - -1. Using pip - - ```shell - cd python-pyquil - poetry export --dev -f requirements.txt --output requirements.txt --without-hashes - pip install -r requirements.txt - pip install -e . - ``` - -1. Using Poetry - - ```shell - cd python-pyquil - poetry install - ``` - - **Note:** if you are on Windows, you'll need to install - [Poetry](https://poetry.eustace.io) manually, and use: - - ```bash - cd python-pyquil - poetry install - ``` - -Once installed via one of the above methods, test your installation by running -`pytest` -in the `python-pyquil` directory. - -```shell -pytest -``` - -## Usage - -See the [Jupyter notebooks](../examples). - -## Contributing - -For general guidelines, see [Contributing](https://github.com/qctrl/.github/blob/master/CONTRIBUTING.md). - -### Building documentation - -Documentation generation relies on [Sphinx](http://www.sphinx-doc.org). - -To build locally: - -1. Ensure you have used one of the install options above. -1. Execute the make file from the docs directory: - - If using Poetry: - - ```bash - cd docs - poetry run make html - ``` - - If using setuptools: - - ```bash - cd docs - # Activate your virtual environment if required - make html - ``` - -The generated HTML will appear in the `docs/_build/html` directory. - -## Credits - -See -[Contributors](https://github.com/qctrl/python-pyquil/graphs/contributors). - -## License - -See [LICENSE](../LICENSE). +# ⚠️ (DEPRECATED) This package has been deprecated ⚠️ +Visit https://docs.q-ctrl.com for updated information about how to integrate Q-CTRL software with PyQuil. diff --git a/README.md b/README.md index cd285a9..e3237e3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,2 @@ -# Q-CTRL Python PyQuil - -The aim of the Q-CTRL pyQuil Adapter package is to provide export functions allowing -users to deploy established error-robust quantum control protocols from the -open literature and defined in Q-CTRL Open Controls on Rigetti quantum hardware -and simulators. - -Anyone interested in quantum control is welcome to contribute to this project. \ No newline at end of file +# ⚠️ (DEPRECATED) This package has been deprecated ⚠️ +Visit https://docs.q-ctrl.com for updated information about how to integrate Q-CTRL software with PyQuil.