artiq

mirror of https://github.com/m-labs/artiq.git synced 2024-12-25 03:08:27 +08:00

History

Sebastien Bourdeauducq 7f523e7e50 nix: add shell starter		2018-08-24 19:03:25 +08:00
..
artiq.nix	nix: update pythonparser	2018-08-19 21:18:40 +08:00
binutils-or1k.nix	nix: fix and update binutils-or1k	2018-08-16 10:05:07 +08:00
default.nix	nix: install binutils-or1k	2018-08-16 10:06:23 +08:00
fetch-llvm-clang.nix	nix: add Clang back	2018-08-16 13:03:55 +08:00
llvm-or1k.nix	nix: update LLVM and llvmlite, remove clang (not needed for running)	2018-08-16 00:33:52 +08:00
llvmlite.nix	nix: also use latest python3 for llvmlite	2018-08-16 10:01:48 +08:00
README.rst	nix: add warnings to README	2018-08-17 12:27:17 +08:00
shell.nix	nix: add shell starter	2018-08-24 19:03:25 +08:00

README.rst

Install 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.

ARTIQ firmware and gateware development tools (e.g. rustc, Migen) and ARTIQ core device flashing tools (OpenOCD, proxy bitstreams) are currently not available on Nix. Pull requests welcome!

* 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 and Clang, which uses a lot of CPU time and disk space.