|
1 | | -# Q-CTRL Python PyQuil |
2 | | - |
3 | | -The aim of the Q-CTRL pyQuil Adapter package is to provide export functions allowing |
4 | | -users to deploy established error-robust quantum control protocols from the |
5 | | -open literature and defined in Q-CTRL Open Controls on Rigetti quantum hardware |
6 | | -and simulators. |
7 | | - |
8 | | -Anyone interested in quantum control is welcome to contribute to this project. |
9 | | - |
10 | | -## Installation |
11 | | - |
12 | | -Q-CTRL pyQuil Adapter can be installed through `pip` or from source. We recommend |
13 | | -the `pip` distribution to get the most recent stable release. If you want the |
14 | | -latest features then install from source. |
15 | | - |
16 | | -### Requirements |
17 | | - |
18 | | -To use Q-CTRL pyQuil Adapter you will need an installation of Python. We |
19 | | -recommend using the [Anaconda](https://www.anaconda.com/) distribution of |
20 | | -Python. Anaconda includes standard numerical and scientific Python packages |
21 | | -which are optimally compiled for your machine. Follow the [Anaconda |
22 | | -Installation](https://docs.anaconda.com/anaconda/install/) instructions and |
23 | | -consult the [Anaconda User |
24 | | -guide](https://docs.anaconda.com/anaconda/user-guide/) to get started. |
25 | | - |
26 | | -We use interactive jupyter notebooks for our usage examples. The Anaconda |
27 | | -python distribution comes with editors for these files, or you can [install the |
28 | | -jupyter notebook editor](https://jupyter.org/install) on its own. |
29 | | - |
30 | | -### Using PyPi |
31 | | - |
32 | | -Use `pip` to install the latest version of Q-CTRL pyQuil Adapter. |
33 | | - |
34 | | -```shell |
35 | | -pip install qctrl-pyquil |
36 | | -``` |
37 | | - |
38 | | -### From Source |
39 | | - |
40 | | -The source code is hosted on |
41 | | -[Github](https://github.com/qctrl/python-pyquil). The repository can be |
42 | | -cloned using |
43 | | - |
44 | | -```shell |
45 | | -git clone [email protected]:qctrl/python-pyquil.git |
46 | | -``` |
47 | | - |
48 | | -Once the clone is complete, you have two options: |
49 | | - |
50 | | -1. Using pip |
51 | | - |
52 | | - ```shell |
53 | | - cd python-pyquil |
54 | | - poetry export --dev -f requirements.txt --output requirements.txt --without-hashes |
55 | | - pip install -r requirements.txt |
56 | | - pip install -e . |
57 | | - ``` |
58 | | - |
59 | | -1. Using Poetry |
60 | | - |
61 | | - ```shell |
62 | | - cd python-pyquil |
63 | | - poetry install |
64 | | - ``` |
65 | | - |
66 | | - **Note:** if you are on Windows, you'll need to install |
67 | | - [Poetry](https://poetry.eustace.io) manually, and use: |
68 | | - |
69 | | - ```bash |
70 | | - cd python-pyquil |
71 | | - poetry install |
72 | | - ``` |
73 | | - |
74 | | -Once installed via one of the above methods, test your installation by running |
75 | | -`pytest` |
76 | | -in the `python-pyquil` directory. |
77 | | - |
78 | | -```shell |
79 | | -pytest |
80 | | -``` |
81 | | - |
82 | | -## Usage |
83 | | - |
84 | | -See the [Jupyter notebooks](../examples). |
85 | | - |
86 | | -## Contributing |
87 | | - |
88 | | -For general guidelines, see [Contributing](https://github.com/qctrl/.github/blob/master/CONTRIBUTING.md). |
89 | | - |
90 | | -### Building documentation |
91 | | - |
92 | | -Documentation generation relies on [Sphinx](http://www.sphinx-doc.org). |
93 | | - |
94 | | -To build locally: |
95 | | - |
96 | | -1. Ensure you have used one of the install options above. |
97 | | -1. Execute the make file from the docs directory: |
98 | | - |
99 | | - If using Poetry: |
100 | | - |
101 | | - ```bash |
102 | | - cd docs |
103 | | - poetry run make html |
104 | | - ``` |
105 | | - |
106 | | - If using setuptools: |
107 | | - |
108 | | - ```bash |
109 | | - cd docs |
110 | | - # Activate your virtual environment if required |
111 | | - make html |
112 | | - ``` |
113 | | - |
114 | | -The generated HTML will appear in the `docs/_build/html` directory. |
115 | | - |
116 | | -## Credits |
117 | | - |
118 | | -See |
119 | | -[Contributors](https://github.com/qctrl/python-pyquil/graphs/contributors). |
120 | | - |
121 | | -## License |
122 | | - |
123 | | -See [LICENSE](../LICENSE). |
| 1 | +# ⚠️ (DEPRECATED) This package has been deprecated ⚠️ |
| 2 | +Visit https://docs.q-ctrl.com for updated information about how to integrate Q-CTRL software with PyQuil. |
0 commit comments