Skip to content
This repository was archived by the owner on Dec 12, 2022. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 2 additions & 123 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
# ⚠️ (DEPRECATED) This package has been deprecated ⚠️
Visit https://docs.q-ctrl.com for updated information about how to integrate Q-CTRL software with PyQuil.