mirror of https://github.com/m-labs/artiq.git
36 lines
1.6 KiB
ReStructuredText
36 lines
1.6 KiB
ReStructuredText
Use ARTIQ via the Nix Package Manager
|
|
=====================================
|
|
|
|
These instructions provide an alternative route to install ARTIQ for people who do not wish to use conda.
|
|
|
|
This sets up an environment suitable for using ARTIQ, including the ARTIQ-Python compiler, device drivers, and the graphical user interfaces. This works correctly on Linux, and partially works (but not to a level that we would consider usable) with WSL introduced in Windows 10.
|
|
|
|
* Install the Nix package manager
|
|
|
|
* many Linux distros already have a package for the `Nix package manager <http://nixos.org/nix/>`_
|
|
|
|
* for example: ``$ apt-get install nix``
|
|
|
|
* if you would like to install via sh
|
|
|
|
* $ ``wget https://nixos.org/nix/install``
|
|
|
|
* $ ``sh install``
|
|
|
|
* $ ``source ~/.nix-profile/etc/profile.d/nix.sh``
|
|
|
|
* $ ``git clone github.com/m-labs/artiq``
|
|
* $ ``cd artiq/nix``
|
|
* $ ``nix-env -i -f default.nix``
|
|
|
|
The above command will setup your entire environment. Note that it will compile LLVM, which uses a lot of CPU time and disk space.
|
|
|
|
ARTIQ development environment with Nix
|
|
======================================
|
|
|
|
Run ``nix-shell shell-dev.nix`` to obtain an environment containing Migen, MiSoC, Microscope, jesd204b, Clang, Rust, Cargo, and OpenOCD in addition to the user environment above.
|
|
|
|
This creates a FHS chroot environment in order to simplify the installation and patching of Xilinx Vivado (it needs to be installed manually e.g. in your home folder).
|
|
|
|
You can then build the firmware and gateware with a command such as ``python -m artiq.gateware.targets.kasli --gateware-toolchain-path ~/Xilinx/Vivado``.
|