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

Commit dedd2a3

Browse files
qctrlrobotcfarrend
qctrlrobot
and
cfarrend
authored
misc: Separate README files (#17)
* misc: Separate README files * Update setup.py/README.rst to match pyproject.toml/README.md * Create README.md * Update setup.py/README.rst to match pyproject.toml/README.md Co-authored-by: Christopher Farrenden <[email protected]>
1 parent 2b1dba3 commit dedd2a3

File tree

3 files changed

+135
-279
lines changed

3 files changed

+135
-279
lines changed

‎.github/README.md‎

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

‎README.md‎

Lines changed: 0 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,135 +1,7 @@
11
# Q-CTRL Qiskit adapter
22

3-
[![Actions Status](https://github.com/qctrl/python-qiskit/workflows/Push%20workflow/badge.svg)](https://github.com/qctrl/python-qiskit/actions?query=workflow%3A"Push+workflow")
4-
[![Actions Status](https://github.com/qctrl/python-qiskit/workflows/Release%20workflow/badge.svg)](https://github.com/qctrl/python-qiskit/actions?query=workflow%3A"Release+workflow")
5-
63
The aim of the Q-CTRL Qiskit Adapter package is to provide export functions allowing
74
users to deploy established error-robust quantum control protocols from the
85
open literature and defined in Q-CTRL Open Controls on IBM Quantum hardware.
96

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

0 commit comments

Comments
 (0)