srenblad
/
artiq
forked from M-Labs/artiq
1
0
Fork 0
Code Pull Requests Activity

manual: clarify and expand nix-shell file

This commit is contained in:
Sebastien Bourdeauducq 2020-10-15 14:31:25 +08:00
parent 57ee57e7ea
commit e66d2a6408
1 changed files with 31 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
doc/manual/installing.rst
View File

@ -48,8 +48,8 @@ Installing multiple packages and making them visible to the ARTIQ commands requi
:: ::
let let
# Contains the NixOS package collection. ARTIQ depends on some of them, and # pkgs contains the NixOS package collection. ARTIQ depends on some of them, and
# you may also want certain packages from there. # you may want some additional packages from there.
pkgs = import <nixpkgs> {}; pkgs = import <nixpkgs> {};
artiq-full = import <artiq-full> { inherit pkgs; }; artiq-full = import <artiq-full> { inherit pkgs; };
in in
@ -57,25 +57,39 @@ Installing multiple packages and making them visible to the ARTIQ commands requi
buildInputs = [ buildInputs = [
(pkgs.python3.withPackages(ps: [ (pkgs.python3.withPackages(ps: [
# List desired Python packages here. # List desired Python packages here.
# You probably want these two.
artiq-full.artiq artiq-full.artiq
artiq-full.artiq-comtools artiq-full.artiq-comtools
# The board packages are also "Python" packages. You only need a board
# package if you intend to reflash that board (those packages contain # You need a board support package if and only if you intend to flash
# only board firmware). # a board (those packages contain only board firmware).
artiq-full.artiq-board-kc705-nist_clock # The lines below are only examples, you need to select appropriate
artiq-full.artiq-board-kasli-wipm # packages for your boards.
# from the NixOS package collection: #artiq-full.artiq-board-kc705-nist_clock
ps.paramiko # needed for flashing boards remotely (artiq_flash -H) #artiq-full.artiq-board-kasli-wipm
ps.pandas #ps.paramiko # needed if and only if flashing boards remotely (artiq_flash -H)
ps.numpy
ps.scipy # The NixOS package collection contains many other packages that you may find
ps.numba # interesting for your research. Here are some examples:
(ps.matplotlib.override { enableQt = true; }) #ps.pandas
ps.bokeh #ps.numpy
#ps.scipy
#ps.numba
#(ps.matplotlib.override { enableQt = true; })
#ps.bokeh
#ps.cirq
#ps.qiskit
#ps.qutip
])) ]))
# List desired non-Python packages here # List desired non-Python packages here
artiq-full.openocd # needed for flashing boards, also provides proxy bitstreams #artiq-full.openocd # needed if and only if flashing boards
pkgs.spyder # Other potentially interesting packages from the NixOS package collection:
#pkgs.gtkwave
#pkgs.spyder
#pkgs.R
#pkgs.julia
]; ];
} }