Skip to content
This repository was archived by the owner on Dec 12, 2022. It is now read-only.

Commit a94f8bd

Browse files
qctrlrobotqctrlrobot
authored
misc: Separate README files (#14)
* misc: Separate README files * Update setup.py/README.rst to match pyproject.toml/README.md
1 parent df0ff16 commit a94f8bd

File tree

5 files changed

+140
-130
lines changed

5 files changed

+140
-130
lines changed

‎.github/README.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
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+
11+
## Table of Contents
12+
13+
- [Installation](#installation)
14+
- [Usage](#usage)
15+
- [Contributing](#contributing)
16+
- [Credits](#credits)
17+
- [License](#license)
18+
19+
## Installation
20+
21+
Q-CTRL pyQuil Adapter can be installed through `pip` or from source. We recommend
22+
the `pip` distribution to get the most recent stable release. If you want the
23+
latest features then install from source.
24+
25+
### Requirements
26+
27+
To use Q-CTRL pyQuil Adapter you will need an installation of Python. We
28+
recommend using the [Anaconda](https://www.anaconda.com/) distribution of
29+
Python. Anaconda includes standard numerical and scientific Python packages
30+
which are optimally compiled for your machine. Follow the [Anaconda
31+
Installation](https://docs.anaconda.com/anaconda/install/) instructions and
32+
consult the [Anaconda User
33+
guide](https://docs.anaconda.com/anaconda/user-guide/) to get started.
34+
35+
We use interactive jupyter notebooks for our usage examples. The Anaconda
36+
python distribution comes with editors for these files, or you can [install the
37+
jupyter notebook editor](https://jupyter.org/install) on its own.
38+
39+
### Using PyPi
40+
41+
Use `pip` to install the latest version of Q-CTRL pyQuil Adapter.
42+
43+
```shell
44+
pip install qctrl-pyquil
45+
```
46+
47+
### From Source
48+
49+
The source code is hosted on
50+
[Github](https://github.com/qctrl/python-pyquil). The repository can be
51+
cloned using
52+
53+
```shell
54+
git clone [email protected]:qctrl/python-pyquil.git
55+
```
56+
57+
Once the clone is complete, you have two options:
58+
59+
1. Using setup.py
60+
61+
```shell
62+
cd python-pyquil
63+
python setup.py develop
64+
```
65+
66+
**Note:** We recommend installing using `develop` to point your installation
67+
at the source code in the directory where you cloned the repository.
68+
69+
1. Using Poetry
70+
71+
```shell
72+
cd python-pyquil
73+
./setup-poetry.sh
74+
```
75+
76+
**Note:** if you are on Windows, you'll need to install
77+
[Poetry](https://poetry.eustace.io) manually, and use:
78+
79+
```bash
80+
cd python-pyquil
81+
poetry install
82+
```
83+
84+
Once installed via one of the above methods, test your installation by running
85+
`pytest`
86+
in the `python-pyquil` directory.
87+
88+
```shell
89+
pytest
90+
```
91+
92+
## Usage
93+
94+
See the [Jupyter notebooks](examples).
95+
96+
## Contributing
97+
98+
For general guidelines, see [Contributing](https://github.com/qctrl/.github/blob/master/CONTRIBUTING.md).
99+
100+
### Building documentation
101+
102+
Documentation generation relies on [Sphinx](http://www.sphinx-doc.org).
103+
104+
To build locally:
105+
106+
1. Ensure you have used one of the install options above.
107+
1. Execute the make file from the docs directory:
108+
109+
If using Poetry:
110+
111+
```bash
112+
cd docs
113+
poetry run make html
114+
```
115+
116+
If using setuptools:
117+
118+
```bash
119+
cd docs
120+
# Activate your virtual environment if required
121+
make html
122+
```
123+
124+
The generated HTML will appear in the `docs/_build/html` directory.
125+
126+
## Credits
127+
128+
See
129+
[Contributors](https://github.com/qctrl/python-pyquil/graphs/contributors).
130+
131+
## License
132+
133+
See [LICENSE](LICENSE).

‎README.md‎

Lines changed: 1 addition & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -5,129 +5,4 @@ users to deploy established error-robust quantum control protocols from the
55
open literature and defined in Q-CTRL Open Controls on Rigetti quantum hardware
66
and simulators.
77

8-
Anyone interested in quantum control is welcome to contribute to this project.
9-
10-
11-
## Table of Contents
12-
13-
- [Installation](#installation)
14-
- [Usage](#usage)
15-
- [Contributing](#contributing)
16-
- [Credits](#credits)
17-
- [License](#license)
18-
19-
## Installation
20-
21-
Q-CTRL pyQuil Adapter can be installed through `pip` or from source. We recommend
22-
the `pip` distribution to get the most recent stable release. If you want the
23-
latest features then install from source.
24-
25-
### Requirements
26-
27-
To use Q-CTRL pyQuil Adapter you will need an installation of Python. We
28-
recommend using the [Anaconda](https://www.anaconda.com/) distribution of
29-
Python. Anaconda includes standard numerical and scientific Python packages
30-
which are optimally compiled for your machine. Follow the [Anaconda
31-
Installation](https://docs.anaconda.com/anaconda/install/) instructions and
32-
consult the [Anaconda User
33-
guide](https://docs.anaconda.com/anaconda/user-guide/) to get started.
34-
35-
We use interactive jupyter notebooks for our usage examples. The Anaconda
36-
python distribution comes with editors for these files, or you can [install the
37-
jupyter notebook editor](https://jupyter.org/install) on its own.
38-
39-
### Using PyPi
40-
41-
Use `pip` to install the latest version of Q-CTRL pyQuil Adapter.
42-
43-
```shell
44-
pip install qctrl-pyquil
45-
```
46-
47-
### From Source
48-
49-
The source code is hosted on
50-
[Github](https://github.com/qctrl/python-pyquil). The repository can be
51-
cloned using
52-
53-
```shell
54-
git clone [email protected]:qctrl/python-pyquil.git
55-
```
56-
57-
Once the clone is complete, you have two options:
58-
59-
1. Using setup.py
60-
61-
```shell
62-
cd python-pyquil
63-
python setup.py develop
64-
```
65-
66-
**Note:** We recommend installing using `develop` to point your installation
67-
at the source code in the directory where you cloned the repository.
68-
69-
1. Using Poetry
70-
71-
```shell
72-
cd python-pyquil
73-
./setup-poetry.sh
74-
```
75-
76-
**Note:** if you are on Windows, you'll need to install
77-
[Poetry](https://poetry.eustace.io) manually, and use:
78-
79-
```bash
80-
cd python-pyquil
81-
poetry install
82-
```
83-
84-
Once installed via one of the above methods, test your installation by running
85-
`pytest`
86-
in the `python-pyquil` directory.
87-
88-
```shell
89-
pytest
90-
```
91-
92-
## Usage
93-
94-
See the [Jupyter notebooks](examples).
95-
96-
## Contributing
97-
98-
For general guidelines, see [Contributing](https://github.com/qctrl/.github/blob/master/CONTRIBUTING.md).
99-
100-
### Building documentation
101-
102-
Documentation generation relies on [Sphinx](http://www.sphinx-doc.org).
103-
104-
To build locally:
105-
106-
1. Ensure you have used one of the install options above.
107-
1. Execute the make file from the docs directory:
108-
109-
If using Poetry:
110-
111-
```bash
112-
cd docs
113-
poetry run make html
114-
```
115-
116-
If using setuptools:
117-
118-
```bash
119-
cd docs
120-
# Activate your virtual environment if required
121-
make html
122-
```
123-
124-
The generated HTML will appear in the `docs/_build/html` directory.
125-
126-
## Credits
127-
128-
See
129-
[Contributors](https://github.com/qctrl/python-pyquil/graphs/contributors).
130-
131-
## License
132-
133-
See [LICENSE](LICENSE).
8+
Anyone interested in quantum control is welcome to contribute to this project.

DESCRIPTION.md renamed to README.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Q-CTRL Python PyQuil
1+
2+
Q-CTRL Python PyQuil
3+
====================
24

35
The aim of the Q-CTRL pyQuil Adapter package is to provide export functions allowing
46
users to deploy established error-robust quantum control protocols from the
57
open literature and defined in Q-CTRL Open Controls on Rigetti quantum hardware
68
and simulators.
79

8-
Anyone interested in quantum control is welcome to contribute to this project.
10+
Anyone interested in quantum control is welcome to contribute to this project.

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description = "Q-CTRL Python PyQuil"
55
license = "Apache-2.0"
66
authors = ["Q-CTRL <[email protected]>"]
77
maintainers = ["Q-CTRL <[email protected]>"]
8-
readme = "DESCRIPTION.md"
8+
readme = "README.md"
99
homepage = "https://q-ctrl.com"
1010
repository = "https://github.com/qctrl/python-pyquil"
1111
keywords = [

‎setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
readme = ''
1717
here = os.path.abspath(os.path.dirname(__file__))
18-
readme_path = os.path.join(here, 'DESCRIPTION.rst')
18+
readme_path = os.path.join(here, 'README.rst')
1919
if os.path.exists(readme_path):
2020
with open(readme_path, 'rb') as stream:
2121
readme = stream.read().decode('utf8')

0 commit comments

Comments
 (0)