diff --git a/README.rst b/README.rst index b26af0bebd3..8ee68609156 100644 --- a/README.rst +++ b/README.rst @@ -1,18 +1,17 @@ -QCoDeS |Build Status| -===================== +QCoDeS |Build Status| |DOCS| +============================ 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. +by computer. +To learn more about QCoDeS, browse our `homepage `_ . To get a feeling of qcodes browse the Jupyter notebooks in `docs/examples `__ . -If you <3 and want to use it straight after, jump to `here `__ ! - QCoDeS is compatible with Python 3.5+. It is primarily intended for use from Jupyter notebooks, but can be used from traditional terminal-based @@ -169,3 +168,6 @@ See `License `__. .. |Build Status| image:: https://travis-ci.org/QCoDeS/Qcodes.svg?branch=master :target: https://travis-ci.org/QCoDeS/Qcodes +.. |DOCS| image:: https://img.shields.io/badge/read%20-thedocs-ff66b4.svg + :target: http://qcodes.github.io/Qcodes + diff --git a/docs/index.rst b/docs/index.rst index 9650a22375d..f786a80f78c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,20 @@ -Welcome to QCoDeS's documentation! -================================== +.. figure:: ./logos/qcodes_logo.png + :scale: 50 % + :alt: qcodes logo + + +.. image:: https://badge.fury.io/py/qcodes.svg + :target: https://badge.fury.io/py/qcodes + +.. image:: https://img.shields.io/badge/source-github-ff69b4.svg + :target: https://github.com/QCoDeS/Qcodes + + -Release v\ |version| Qcodes is a Python-based data acquisition framework developed by the Copenhagen / Delft / Sydney / Microsoft quantum computing consortium. + The goal is a common framework for physics experiments, so: - new students don't need to spend a long time learning software in order to @@ -71,3 +81,9 @@ License ======= .. include:: ../LICENSE + + +Contributions +============= + +QCoDeS logo contributed by `Guenevere E D K Prawiroatmodjo `_ diff --git a/docs/logos/qcodes_logo.png b/docs/logos/qcodes_logo.png new file mode 100644 index 00000000000..eb576a51956 Binary files /dev/null and b/docs/logos/qcodes_logo.png differ diff --git a/docs/logos/qcodes_logo.svg b/docs/logos/qcodes_logo.svg new file mode 100644 index 00000000000..03d68c835ae --- /dev/null +++ b/docs/logos/qcodes_logo.svg @@ -0,0 +1,168 @@ + + + +image/svg+xmlQC +o +D +e +S + \ No newline at end of file diff --git a/docs/logos/qcodes_sticker.png b/docs/logos/qcodes_sticker.png new file mode 100644 index 00000000000..4419eaf3b64 Binary files /dev/null and b/docs/logos/qcodes_sticker.png differ diff --git a/docs/logos/qcodes_sticker.svg b/docs/logos/qcodes_sticker.svg new file mode 100644 index 00000000000..4186c9e7f46 --- /dev/null +++ b/docs/logos/qcodes_sticker.svg @@ -0,0 +1,154 @@ + + + +QCoDeS stickerimage/svg+xmlQCoDeS stickerGuen Prawiroatmodjo \ No newline at end of file