Skip to content
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
966 changes: 765 additions & 201 deletions LICENSE

Large diffs are not rendered by default.

124 changes: 3 additions & 121 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,124 +1,6 @@

Q-CTRL Open Controls
====================

Q-CTRL Open Controls is an open-source Python package that makes it easy to
create and deploy established error-robust quantum control protocols from the
open literature. The aim of the package is to be the most comprehensive library
of published and tested quantum control techniques developed by the community,
with easy to use export functions allowing users to deploy these controls on:


* Custom quantum hardware
* Publicly available cloud quantum computers
* The `Q-CTRL product suite <https://q-ctrl.com/products/>`_

Anyone interested in quantum control is welcome to contribute to this project.

Installation
------------

Q-CTRL Open Controls can be install 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 Open Controls 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 Open Controls.

.. code-block:: shell

pip install qctrl-open-controls

From Source
^^^^^^^^^^^

The source code is hosted on
`Github <https://github.com/qctrl/python-open-controls>`_. The repository can be
cloned using

.. code-block:: shell

git clone git@github.com:qctrl/python-open-controls.git

Once the clone is complete, you have two options:


#.
Using setup.py

.. code-block:: shell

cd python-open-controls
python setup.py develop

**Note:** We recommend installing using ``develop`` to point your installation
at the source code in the directory where you cloned the repository.

#.
Using Poetry

.. code-block:: shell

cd python-open-controls
./setup-poetry.sh

**Note:** if you are on Windows, you'll need to install
`Poetry <https://poetry.eustace.io>`_ manually, and use:

.. code-block:: shell

cd python-open-controls
poetry install

Once installed via one of the above methods, test your installation by running
``pytest``
in the ``python-open-controls`` directory.

.. code-block:: shell

pytest

Usage
-----

See the `Jupyter notebooks <https://github.com/qctrl/notebooks/tree/master/qctrl-open-controls>`_.

Reference
---------
Q-CTRL Open Controls Python package
===================================

.. toctree::
:maxdepth: 2
:caption: Contents:

installation
qctrlopencontrols

Licence
-------

.. toctree::

licence

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
79 changes: 79 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
Installation
============

Q-CTRL Open Controls can be install 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 Open Controls 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.

From PyPi
---------

Use ``pip`` to install the latest version of the Q-CTRL ppen controls Python package.

.. code-block:: shell

pip install qctrl-open-controls

From Source
-----------

The source code is hosted on
`Github <https://github.com/qctrl/python-open-controls>`_. The repository can be
cloned using

.. code-block:: shell

git clone git@github.com:qctrl/python-open-controls.git

Once the clone is complete, you have two options:


#.
Using setup.py

.. code-block:: shell

cd python-open-controls
python setup.py develop

**Note:** We recommend installing using ``develop`` to point your installation
at the source code in the directory where you cloned the repository.

#.
Using Poetry

.. code-block:: shell

cd python-open-controls
./setup-poetry.sh

**Note:** if you are on Windows, you'll need to install
`Poetry <https://poetry.eustace.io>`_ manually, and use:

.. code-block:: shell

cd python-open-controls
poetry install

Once installed via one of the above methods, test your installation by running
``pytest``
in the ``python-open-controls`` directory.

.. code-block:: shell

pytest
16 changes: 0 additions & 16 deletions docs/licence.rst

This file was deleted.

22 changes: 0 additions & 22 deletions docs/qctrlopencontrols.base.rst

This file was deleted.

30 changes: 0 additions & 30 deletions docs/qctrlopencontrols.driven_controls.rst

This file was deleted.

38 changes: 0 additions & 38 deletions docs/qctrlopencontrols.dynamic_decoupling_sequences.rst

This file was deleted.

22 changes: 0 additions & 22 deletions docs/qctrlopencontrols.exceptions.rst

This file was deleted.

10 changes: 0 additions & 10 deletions docs/qctrlopencontrols.globals.rst

This file was deleted.

18 changes: 2 additions & 16 deletions docs/qctrlopencontrols.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,5 @@
qctrlopencontrols package
=========================

Subpackages
-----------

.. toctree::

qctrlopencontrols.base
qctrlopencontrols.driven_controls
qctrlopencontrols.dynamic_decoupling_sequences
qctrlopencontrols.exceptions
qctrlopencontrols.globals

Module contents
---------------
Q-CTRL Open Controls Python package
===================================

.. automodule:: qctrlopencontrols
:members:
Expand Down
17 changes: 8 additions & 9 deletions qctrlopencontrols/__init__.py
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# Copyright 2019 Q-CTRL Pty Ltd & Q-CTRL Inc
# Copyright 2020 Q-CTRL Pty Ltd & Q-CTRL Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
# copying or use of this file, via any medium, is strictly prohibited.
# Proprietary and confidential. You may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
# https://q-ctrl.com/terms
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# distributed under the License is distributed on an "AS IS" BASIS. See the
# License for the specific language.

"""
=================
Expand Down
Loading