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

29 lines
1.2 KiB
ReStructuredText
Raw Normal View History

Problem: ARTIQ setup via conda or src is complex Solution: Provide a single command to download, compile and install dependencies.
2016-03-06 23:54:07 +08:00
Install ARTIQ via the Nix Package Manager
nix: update README
2018-08-17 12:19:16 +08:00
=========================================
Problem: ARTIQ setup via conda or src is complex Solution: Provide a single command to download, compile and install dependencies.
2016-03-06 23:54:07 +08:00
nix: update README
2018-08-17 12:19:16 +08:00
These instructions provide an alternative route to install ARTIQ for people who do not wish to use conda.
Problem: ARTIQ setup via conda or src is complex Solution: Provide a single command to download, compile and install dependencies.
2016-03-06 23:54:07 +08:00
nix: add warnings to README
2018-08-17 12:27:17 +08:00
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.
Problem: ARTIQ setup via conda or src is complex Solution: Provide a single command to download, compile and install dependencies.
2016-03-06 23:54:07 +08:00
nix: update README
2018-08-17 12:19:16 +08:00
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!
Problem: ARTIQ setup via conda or src is complex Solution: Provide a single command to download, compile and install dependencies.
2016-03-06 23:54:07 +08:00
nix: update README
2018-08-17 12:19:16 +08:00
* Install the Nix package manager
Problem: ARTIQ setup via conda or src is complex Solution: Provide a single command to download, compile and install dependencies.
2016-03-06 23:54:07 +08:00
nix: update README
2018-08-17 12:19:16 +08:00
* many Linux distros already have a package for the `Nix package manager <http://nixos.org/nix/>`_
Problem: ARTIQ setup via conda or src is complex Solution: Provide a single command to download, compile and install dependencies.
2016-03-06 23:54:07 +08:00
nix: update README
2018-08-17 12:19:16 +08:00
* for example: ``$ apt-get install nix``
Problem: ARTIQ setup via conda or src is complex Solution: Provide a single command to download, compile and install dependencies.
2016-03-06 23:54:07 +08:00
nix: update README
2018-08-17 12:19:16 +08:00
* if you would like to install via sh
Problem: ARTIQ setup via conda or src is complex Solution: Provide a single command to download, compile and install dependencies.
2016-03-06 23:54:07 +08:00
nix: update README
2018-08-17 12:19:16 +08:00
* $ ``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``
Problem: ARTIQ setup via conda or src is complex Solution: Provide a single command to download, compile and install dependencies.
2016-03-06 23:54:07 +08:00
nix: add warnings to README
2018-08-17 12:27:17 +08:00
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.