M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

Add documentation about ARTIQ_GUI environment variable 

Also adds "python-gi" as Ubuntu dependency as this is needed
for the GUI.
This commit is contained in:
Yann Sionneau 2015-02-09 12:27:36 +01:00 committed by Sebastien Bourdeauducq
parent 542e047f5a
commit d2619eb78b
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/manual/installing.rst
View File

@ -149,12 +149,31 @@ Installing the host-side software
.. note:: .. note::
Compilation of LLVM can take more than 30 min on some machines. Compilation of LLVM can take more than 30 min on some machines.
* Install ARTIQ: :: * Install ARTIQ (without the GUI): ::
$ cd ~/artiq-dev $ cd ~/artiq-dev
$ git clone https://github.com/m-labs/artiq # if not already done $ git clone https://github.com/m-labs/artiq # if not already done
$ cd artiq
$ python3 setup.py develop --user $ python3 setup.py develop --user
* Install ARTIQ (with the GUI): ::
$ cd ~/artiq-dev
$ git clone https://github.com/m-labs/cairoplot3
$ cd cairoplot3
$ python3 setup.py install --user
$ cd -
$ git clone https://github.com/m-labs/gbulb
$ cd gbulb
$ python3 setup.py install --user
$ cd -
$ git clone https://github.com/m-labs/artiq # if not already done
$ cd artiq
$ ARTIQ_GUI=1 python3 setup.py develop --user
.. note::
Use ARTIQ_GUI=1 to install GUI dependencies which are only supported on Linux for now, to install ARTIQ on Windows do not set ARTIQ_GUI.
* Build the documentation: :: * Build the documentation: ::
$ cd ~/artiq-dev/artiq/doc/manual $ cd ~/artiq-dev/artiq/doc/manual
@ -165,7 +184,7 @@ Xubuntu 14.04 specific instructions
This command installs all the required packages: :: This command installs all the required packages: ::
$ sudo apt-get install build-essential autotools-dev file git patch perl xutils-devs python3-pip texinfo flex bison libmpc-dev python3-serial python3-dateutil python3-prettytable python3-setuptools python3-numpy python3-scipy python3-sphinx python3-h5py python3-dev python-dev subversion cmake libusb-dev libftdi-dev pkg-config $ sudo apt-get install build-essential autotools-dev file git patch perl xutils-devs python3-pip texinfo flex bison libmpc-dev python3-serial python3-dateutil python3-prettytable python3-setuptools python3-numpy python3-scipy python3-sphinx python3-h5py python3-gi python3-dev python-dev subversion cmake libusb-dev libftdi-dev pkg-config
Note that ARTIQ requires Python 3.4 or above. Note that ARTIQ requires Python 3.4 or above.