From c858d44c733935c2571700145ac01b1fe68eaadd Mon Sep 17 00:00:00 2001 From: Robert Jordens Date: Sat, 9 Apr 2016 23:55:27 +0800 Subject: [PATCH] README: rewrite, summarizing more aspects of ARTIQ --- README.rst | 32 +++++++++++++++++++++----------- doc/manual/introduction.rst | 33 +++++++++++++++++++++------------ 2 files changed, 42 insertions(+), 23 deletions(-) diff --git a/README.rst b/README.rst index 9b26568b4..eb6260f31 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,29 @@ -.. Always keep doc/manual/introduction.rst synchronized with this file except the logo. +.. Always keep doc/manual/introduction.rst synchronized with this file, with the exception of the logo. .. image:: doc/logo/artiq.png -ARTIQ (Advanced Real-Time Infrastructure for Quantum physics) is a -next-generation control system for quantum information experiments. It is -developed in partnership with the Ion Storage Group at NIST, and its -applicability reaches beyond ion trapping. +ARTIQ (Advanced Real-Time Infrastructure for Quantum physics) is the next-generation control system for quantum information experiments. +It is developed by `M-Labs `_ for and in partnership with the `Ion Storage Group at NIST `_ as free software. +It is offered to the entire research community as a solution equally applicable to other challenging control tasks outside the field of ion trapping. -The system features a high-level programming language that helps describing -complex experiments, which is compiled and executed on dedicated hardware with -nanosecond timing resolution and sub-microsecond latency. +The system features a high-level programming language that helps describing complex experiments, which is compiled and executed on dedicated hardware with nanosecond timing resolution and sub-microsecond latency. It includes graphical user interfaces to parametrize and schedule experiments and to visualize and explore the results. -Technologies employed include Python, Migen, MiSoC/mor1kx, LLVM and llvmlite. +ARTIQ uses FPGA hardware to perform its time-critical tasks. +It is designed to be portable to hardware platforms from different vendors and FPGA manufacturers. +Currently, one configuration of a `low-cost open hardware FPGA board `_ and several different configurations of a `high-end FPGA evaluation kit `_ are used and supported. +Any of these FPGA platforms can be combined with any number of additional peripherals, either already accessible from ARTIQ or made accessible with little effort. -Website: -https://m-labs.hk/artiq +Custom hardware components with widely extended capabilities and advanced support for scalable and fully distributed real-time control of experiments `are being designed `_. + +ARTIQ and its dependencies are available in the form of `conda packages `_ for both Linux and Windows. +Packages containing pre-compiled binary images to be loaded onto the hardware platforms are supplied for each configuration. +Like any open source software ARTIQ can equally be built and installed directly from `source `_. + +ARTIQ is supported by M-Labs and developed openly. +Components, features, fixes, improvements, and extensions are funded by and developed for the partnering research groups. + +Technologies employed include `Python `_, `Migen `_, `MiSoC `_/`mor1kx `_, `LLVM `_/`llvmlite `_, and `Qt5 `_. + +Website: https://m-labs.hk/artiq Copyright (C) 2014-2016 M-Labs Limited. Licensed under GNU GPL version 3. diff --git a/doc/manual/introduction.rst b/doc/manual/introduction.rst index 6e2cdcc1b..e6217f023 100644 --- a/doc/manual/introduction.rst +++ b/doc/manual/introduction.rst @@ -3,21 +3,30 @@ Introduction .. this does not work because of relative paths for the logo: .. include:: ../../README.rst - and including in README.rst does not work on github - therefore just keep this content synchronized with README.rst + and including in README.rst does not work on github therefore just keep this content synchronized with README.rst -ARTIQ (Advanced Real-Time Infrastructure for Quantum physics) is a -next-generation control system for quantum information experiments. It is -developed in partnership with the Ion Storage Group at NIST, and its -applicability reaches beyond ion trapping. +ARTIQ (Advanced Real-Time Infrastructure for Quantum physics) is the next-generation control system for quantum information experiments. +It is developed by `M-Labs `_ for and in partnership with the `Ion Storage Group at NIST `_ as free software. +It is offered to the entire research community as a solution equally applicable to other challenging control tasks outside the field of ion trapping. -The system features a high-level programming language that helps describing -complex experiments, which is compiled and executed on dedicated hardware with -nanosecond timing resolution and sub-microsecond latency. +The system features a high-level programming language that helps describing complex experiments, which is compiled and executed on dedicated hardware with nanosecond timing resolution and sub-microsecond latency. It includes graphical user interfaces to parametrize and schedule experiments and to visualize and explore the results. -Technologies employed include Python, Migen, MiSoC/mor1kx, LLVM and llvmlite. +ARTIQ uses FPGA hardware to perform its time-critical tasks. +It is designed to be portable to hardware platforms from different vendors and FPGA manufacturers. +Currently, one configuration of a `low-cost open hardware FPGA board `_ and several different configurations of a `high-end FPGA evaluation kit `_ are used and supported. +Any of these FPGA platforms can be combined with any number of additional peripherals, either already accessible from ARTIQ or made accessible with little effort. -Website: -https://m-labs.hk/artiq +Custom hardware components with widely extended capabilities and advanced support for scalable and fully distributed real-time control of experiments `are being designed `_. + +ARTIQ and its dependencies are available in the form of `conda packages `_ for both Linux and Windows. +Packages containing pre-compiled binary images to be loaded onto the hardware platforms are supplied for each configuration. +Like any open source software ARTIQ can equally be built and installed directly from `source `_. + +ARTIQ is supported by M-Labs and developed openly. +Components, features, fixes, improvements, and extensions are funded by and developed for the partnering research groups. + +Technologies employed include `Python `_, `Migen `_, `MiSoC `_/`mor1kx `_, `LLVM `_/`llvmlite `_, and `Qt5 `_. + +Website: https://m-labs.hk/artiq Copyright (C) 2014-2016 M-Labs Limited. Licensed under GNU GPL version 3.