Commit c907dc67 authored by Adriaan's avatar Adriaan
Browse files

Merge branch 'docs_exp_flow' into 'develop' 

New user guide (experiment flow)

Closes #96

See merge request !161
parents 4dae224d 4a002a3e

.gitignore

+1 −0
Original line number Diff line number Diff line
@@ -53,6 +53,7 @@ coverage.xml 


# Sphinx documentation

docs/_build/

docs/build_errors.log



# PyBuilder

target/

.gitlab-ci.yml

+8 −0
Original line number Diff line number Diff line
@@ -98,9 +98,17 @@ services: 
  script:

    - cd docs

    - make html



  after_script:

    # Append the error log such that it's more convenient to read

    - echo "-------- Errors emitted during building of documentation --------"

    - cat docs/build_errors.log



  artifacts:

    paths:

      - frozen-requirements.txt

      - docs/_build/html

      - docs/build_errors.log



.docs-win-and-artifacts:

  needs: []  # allow running in parallel with previous stage

README.rst

+3 −1
Original line number Diff line number Diff line
@@ -31,7 +31,9 @@ Quantify currently consists of `quantify-core <https://pypi.org/project/quantify 


Take a look at the documentation for quantify-scheduler: `stable <https://quantify-quantify-scheduler.readthedocs-hosted.com/en/stable/>`_ (or `develop <https://quantify-quantify-scheduler.readthedocs-hosted.com/en/develop/>`_).



Quantify-scheduler is a module for writing quantum programs. It features a unique hybrid control model allowing quantum gate- and pulse-level descriptions to be combined in a clearly defined and hardware-agnostic way. Quantify-scheduler is designed to allow experimentalists to easily define complex experiments, and produces synchronized pulse schedules to be distributed to control hardware.

Quantify-scheduler is a python module for writing quantum programs featuring a hybrid gate-pulse control model with explicit timing control.

The control model allows quantum gate- and pulse-level descriptions to be combined in a clearly defined and hardware-agnostic way.

Quantify-scheduler is designed to allow experimentalists to easily define complex experiments, and produces synchronized pulse schedules to be distributed to control hardware.



.. caution::

docs/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
#



# You can set these variables from the command line.

SPHINXOPTS    = -W --keep-going -n

SPHINXOPTS    = -W --keep-going -n -w build_errors.log

SPHINXBUILD   = python -msphinx

SPHINXPROJ    = quantify

SOURCEDIR     = .

docs/api_reference.rst

+22 −7
Original line number Diff line number Diff line
@@ -2,7 +2,6 @@ quantify_scheduler 
==================



.. automodule:: quantify_scheduler

    :members:



types

-----
@@ -103,6 +102,14 @@ frontends 
.. automodule:: quantify_scheduler.frontends

    :members:



gettables

---------



.. automodule:: quantify_scheduler.gettables

    :members:







backends

--------
@@ -211,23 +218,31 @@ instrument_coordinator 


.. automodule:: quantify_scheduler.instrument_coordinator

    :members:

    :show-inheritance:



base

~~~~

instrument_coordinator

~~~~~~~~~~~~~~~~~~~~~~



.. automodule:: quantify_scheduler.instrument_coordinator.instrument_coordinator

    :members:

    :show-inheritance:



components.base

~~~~~~~~~~~~~~~



.. automodule:: quantify_scheduler.instrument_coordinator.components.base

    :members:

    :show-inheritance:



qblox

~~~~~

components.qblox

~~~~~~~~~~~~~~~~



.. automodule:: quantify_scheduler.instrument_coordinator.components.qblox

    :members:

    :show-inheritance:



zhinst

~~~~~~

components.zhinst

~~~~~~~~~~~~~~~~~



.. automodule:: quantify_scheduler.instrument_coordinator.components.zhinst

    :members: