Python-based data acquisition framework developed by the Copenhagen / Delft / Sydney / Microsoft quantum computing consortium
Project description
QCoDeS |Build Status|
=====================
QCoDeS is a Python-based data acquisition framework developed by the
Copenhagen / Delft / Sydney / Microsoft quantum computing consortium.
While it has been developed to serve the needs of nanoelectronic device
experiments, it is not inherently limited to such experiments, and can
be used anywhere a system with many degrees of freedom is controllable
by computer.
To get a feeling of qcodes browse the Jupyter notebooks in `docs/examples
<docs/examples/Tutorial.ipynb>`__ .
QCoDeS is compatible with Python 3.5+. It is primarily intended for use
from Jupyter notebooks, but can be used from traditional terminal-based
shells and in stand-alone scripts as well. Although some feature at the
moment are b0rken outside the notebook.
Status
------
QCoDeS is still in development, more documentation and features will be coming!
The team behind this project just expanded. There are still rough edges, and
gray areas but QCoDeS has been running without major issue in two long running
experiments.
The most important features in the roadmap are:
- a robust architecture that uses the full potential of your harwdare
- a more flexible and faster data storage solution
Install
=======
PyPi
----
.. code:: bash
pip install qcodes
Plotting Requirements
^^^^^^^^^^^^^^^^^^^^^^
Because these can sometimes be tricky to install (and not everyone will
want all of them), the plotting packages are not set as required
dependencies, so setup.py will not automatically install them. You can
install them with ``pip``:
- For ``qcodes.MatPlot``: matplotlib version 1.5 or higher
- For ``qcodes.QtPlot``: pyqtgraph version 0.9.10 or higher
Developer-pyenv
---------------
Core developers use virtualenv and pyenv to make sure all the system are the same,
this rules out issues and the usual "it works on my machine". Install pyenv
on your OS `see this https://github.com/yyuu/pyenv`__ .
$QCODES_INSTALL_DIR is the folder where you want to have the source code.
.. code:: bash
git clone https://github.com/QCoDeS/Qcodes.git $QCODES_INSTALL_DIR
cd $QCODES_INSTALL_DIR
pyenv install 3.5.2
pyenv virtualenv 3.5.2 qcodes-dev
pip install -r develop_requirements.txt
pip install -e .
python qcodes/test.py -f
If the tests pass you are ready to hack!
This is the reference setup one needs to have to contribute, otherwise
too many non-reproducible environments will show up.
If all of this sounds too complicated, use anaconda!
Anaconda
--------
One can also use anaconda:
- First clone the repo
`` git clone https://github.com/QCoDeS/Qcodes.git $QCODES_INSTALL_DIR ``
- Open the 'navigator' app that was installed with anaconda.
- On the left side click on "Environments".
- Then on the "import" icon, on the bottom.
- Pick a name, and click on the folder icon next to file to import
from.
- Make sure you select "Pip requirement files" from the "Files of type"
dialog then navigate to the qcodes folder (QCODES_INSTALL_DIR) and select
``basic_requirements.txt``.
- Finally click import, and wait until done.
- The enviroment is now created, click on the green arrow to open a
terminal inside it.
- Navigate again with the terminal (or drag and drop the the folder on
OsX)
- Most likely you will want to plot stuff, so type:
``conda install matplotlib``
and after if you want qtplot
``conda install pyqtgraph``
- Then type ``pip install -e .``
Updating QCoDeS
===============
from PyPi
---------
.. code:: bash
pip install --upgrade qcodes
Developer-pyenv/anaconda
------------------------
.. code:: bash
cd $QCODES_INSTALL_DIR && git pull
or if using GUIs, just pull the repo!
Docs
====
Read it `here <http://qcodes.github.io/Qcodes>`__ .
Documentation is updated and deployed on every successful build in master.
We use sphinx for documentations, makefiles are provided both for
Windows, and \*nix.
Go to the directory ``docs`` and
.. code:: bash
make html
This generate a webpage, index.html, in ``docs/_build/html`` with the
rendered html.
Contributing
============
See `Contributing <CONTRIBUTING.rst>`__ for information about bug/issue
reports, contributing code, style, and testing
License
=======
See `License <LICENSE.md>`__.
.. |Build Status| image:: https://travis-ci.com/QCoDeS/Qcodes.svg?token=H7MjHi74teZgv8JHTYhx&branch=master
:target: https://travis-c
=====================
QCoDeS is a Python-based data acquisition framework developed by the
Copenhagen / Delft / Sydney / Microsoft quantum computing consortium.
While it has been developed to serve the needs of nanoelectronic device
experiments, it is not inherently limited to such experiments, and can
be used anywhere a system with many degrees of freedom is controllable
by computer.
To get a feeling of qcodes browse the Jupyter notebooks in `docs/examples
<docs/examples/Tutorial.ipynb>`__ .
QCoDeS is compatible with Python 3.5+. It is primarily intended for use
from Jupyter notebooks, but can be used from traditional terminal-based
shells and in stand-alone scripts as well. Although some feature at the
moment are b0rken outside the notebook.
Status
------
QCoDeS is still in development, more documentation and features will be coming!
The team behind this project just expanded. There are still rough edges, and
gray areas but QCoDeS has been running without major issue in two long running
experiments.
The most important features in the roadmap are:
- a robust architecture that uses the full potential of your harwdare
- a more flexible and faster data storage solution
Install
=======
PyPi
----
.. code:: bash
pip install qcodes
Plotting Requirements
^^^^^^^^^^^^^^^^^^^^^^
Because these can sometimes be tricky to install (and not everyone will
want all of them), the plotting packages are not set as required
dependencies, so setup.py will not automatically install them. You can
install them with ``pip``:
- For ``qcodes.MatPlot``: matplotlib version 1.5 or higher
- For ``qcodes.QtPlot``: pyqtgraph version 0.9.10 or higher
Developer-pyenv
---------------
Core developers use virtualenv and pyenv to make sure all the system are the same,
this rules out issues and the usual "it works on my machine". Install pyenv
on your OS `see this https://github.com/yyuu/pyenv`__ .
$QCODES_INSTALL_DIR is the folder where you want to have the source code.
.. code:: bash
git clone https://github.com/QCoDeS/Qcodes.git $QCODES_INSTALL_DIR
cd $QCODES_INSTALL_DIR
pyenv install 3.5.2
pyenv virtualenv 3.5.2 qcodes-dev
pip install -r develop_requirements.txt
pip install -e .
python qcodes/test.py -f
If the tests pass you are ready to hack!
This is the reference setup one needs to have to contribute, otherwise
too many non-reproducible environments will show up.
If all of this sounds too complicated, use anaconda!
Anaconda
--------
One can also use anaconda:
- First clone the repo
`` git clone https://github.com/QCoDeS/Qcodes.git $QCODES_INSTALL_DIR ``
- Open the 'navigator' app that was installed with anaconda.
- On the left side click on "Environments".
- Then on the "import" icon, on the bottom.
- Pick a name, and click on the folder icon next to file to import
from.
- Make sure you select "Pip requirement files" from the "Files of type"
dialog then navigate to the qcodes folder (QCODES_INSTALL_DIR) and select
``basic_requirements.txt``.
- Finally click import, and wait until done.
- The enviroment is now created, click on the green arrow to open a
terminal inside it.
- Navigate again with the terminal (or drag and drop the the folder on
OsX)
- Most likely you will want to plot stuff, so type:
``conda install matplotlib``
and after if you want qtplot
``conda install pyqtgraph``
- Then type ``pip install -e .``
Updating QCoDeS
===============
from PyPi
---------
.. code:: bash
pip install --upgrade qcodes
Developer-pyenv/anaconda
------------------------
.. code:: bash
cd $QCODES_INSTALL_DIR && git pull
or if using GUIs, just pull the repo!
Docs
====
Read it `here <http://qcodes.github.io/Qcodes>`__ .
Documentation is updated and deployed on every successful build in master.
We use sphinx for documentations, makefiles are provided both for
Windows, and \*nix.
Go to the directory ``docs`` and
.. code:: bash
make html
This generate a webpage, index.html, in ``docs/_build/html`` with the
rendered html.
Contributing
============
See `Contributing <CONTRIBUTING.rst>`__ for information about bug/issue
reports, contributing code, style, and testing
License
=======
See `License <LICENSE.md>`__.
.. |Build Status| image:: https://travis-ci.com/QCoDeS/Qcodes.svg?token=H7MjHi74teZgv8JHTYhx&branch=master
:target: https://travis-c
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
qcodes_-0.1.0-py3-none-any.whl
(294.1 kB
view hashes)
