.. _relatedprojects :

Related Projects
================

On this page we list a number of projects that are
affiliated with or makes use of QCoDeS in some way or another.

If you would like to get your project featured here please submit a
pull request adding your project to this page.
The page is located at ``docs\community\related_projects.rst`` within the QCoDeS
repository.


QCoDeS contrib drivers
----------------------

QCoDeS contrib drivers is a collection of drivers for many
different instruments developed by the community. If you have
developed a driver that your wish to share with the community
this is the ideal place for it.

Broadbean can be installed with pip from PyPi
with ``pip install qcodes_contrib_drivers``
The source code is hosted on Github
`here <https://github.com/qcodes/qcodes_contrib_drivers>`__
and the documentation can be found
`here <https://microsoft.github.io/Qcodes_contrib_drivers/>`__


Broadbean
---------

Broadbean is a library for making pulses. Intended to be used
with QCoDeS (and in particular its Tektronix AWG 5014 driver)

Broadbean can be installed with pip from PyPi
with ``pip install broadbean``
The source code is hosted on Github
`here <https://github.com/qcodes/broadbean>`__
and the documentation can be found
`here <https://qcodes.github.io/broadbean/>`__


Plottr
------

Plottr is a framework for inspecting data, based on flowcharts from pyqtgraph.
plottr's main aim is to allow the user to define custom data processing
flows and plotting. A particular use case is data filtering and plotting.
Plottr has dedicated support for plotting QCoDeS datasets.


Plottr can be installed with pip from PyPi
with ``pip install plottr``
The source code is hosted on Github
`here <https://github.com/toolsforexperiments/plottr/>`__
and the documentation can be found
`here <https://plottr.readthedocs.io/en/latest/>`__

zhinst-qcodes
-------------

The Zurich Instruments drivers for QCoDeS (zhinst-qcodes) is a package of
instrument drivers for devices produced by Zurich Instruments for QCoDeS.
The QCoDeS instrument drivers are based on the Zurich Instruments Toolkit.

zhinst-qcodes can be installed with pip from PyPi
with ``pip install zhinst-qcodes``
The source code is hosted on Github
`here <https://docs.zhinst.com/zhinst-qcodes/en/latest/>`__
and the documentation can be found
`here <https://github.com/zhinst/zhinst-qcodes/>`__


PycQED
------

A Python-based measurement environment for circuit-QED experiments
by the DiCarlo group at QuTech, Delft University of Technology.
This module is build on top of QCoDeS and is not intended as a stand-alone package.

`GitHub page with the repository <https://github.com/DiCarloLab-Delft/PycQED_py3>`__


qtt (Quantum Technology Toolbox)
--------------------------------

Quantum Technology Toolbox (QTT) is a Python-based framework
for the tuning and calibration of quantum dots and spin qubits.
QTT is the framework on which you can base your measurement
and analysis scripts. QTT is based on Qcodes and the SciPy ecosystem.

`GitHub page with the repository <https://github.com/QuTech-Delft/qtt>`__

`Docs <https://qtt.readthedocs.io>`__


Quantify
--------
Quantify is a Python-based framework that enables quantum computing users to program hybrid gate-level / pulse-level physics experiments, in a hardware-agnostic manner through `quantify-scheduler <https://quantify-os.org/docs/quantify-scheduler>`__, and to automate data acquisition and execution of these experiments with `quantify-core <https://quantify-os.org/docs/quantify-core>`__.

GitLab: `quantify-core <https://gitlab.com/quantify-os/quantify-core>`__ |  `quantify-scheduler <https://gitlab.com/quantify-os/quantify-scheduler>`__

Website: `quantify-os.org <https://quantify-os.org>`__