New ARTIQ compiler, third iteration

Go to file

Sebastien Bourdeauducq 1ad4b0227c windows: fix src location		2022-03-26 15:46:21 +08:00
nac3artiq	Option type support (#224 )	2022-03-26 15:09:15 +08:00
nac3ast	nac3ast/parser/core: use i128 for u64 constants	2022-03-08 18:21:14 +08:00
nac3core	Option type support (#224 )	2022-03-26 15:09:15 +08:00
nac3parser	nac3parser: modify to handle UAdd in front of int constant	2022-03-09 10:46:58 +08:00
nac3standalone	Option type support (#224 )	2022-03-26 15:09:15 +08:00
nix	windows: fix src location	2022-03-26 15:46:21 +08:00
runkernel	indentation	2022-03-23 10:45:28 +08:00
.gitignore	build LLVM with Wine + MSYS2	2022-03-22 18:03:25 +08:00
Cargo.lock	update dependencies	2022-03-24 22:30:15 +08:00
Cargo.toml	update inkwell. Closes #67	2021-12-25 22:17:06 +08:00
README.md	README: fix build name	2022-03-22 22:12:23 +08:00
flake.lock	update dependencies	2022-03-24 22:30:15 +08:00
flake.nix	improve package names	2022-03-26 15:15:59 +08:00
rustfmt.toml	move rustfmt.toml upper	2022-01-09 11:31:06 +08:00

README.md

NAC3

NAC3 is a major, backward-incompatible rewrite of the compiler for the ARTIQ physics experiment control and data acquisition system. It features greatly improved compilation speeds, a much better type system, and more predictable and transparent operation.

NAC3 has a modular design and its applicability reaches beyond ARTIQ. The nac3core module does not contain anything specific to ARTIQ, and can be used in any project that requires compiling Python to machine code.

WARNING: NAC3 is currently experimental software and several important features are not implemented yet.

Packaging

NAC3 is packaged using the Nix Flakes system. Install Nix 2.4+ and enable flakes by adding experimental-features = nix-command flakes to nix.conf (e.g. ~/.config/nix/nix.conf).

Try NAC3

Linux

After setting up Nix as above, use nix shell git+https://github.com/m-labs/artiq.git?ref=nac3 to get a shell with the NAC3 version of ARTIQ. See the examples directory in ARTIQ (nac3 Git branch) for some samples of NAC3 kernel code.

Windows (work in progress)

NAC3 ARTIQ packaging for MSYS2/Windows is not yet complete so installation involves many manual steps. It is also less tested and you may encounter problems.

Install MSYS2 and run the following commands:

pacman -S mingw-w64-x86_64-python-h5py mingw-w64-x86_64-python-pyqt5 mingw-w64-x86_64-python-scipy mingw-w64-x86_64-python-prettytable mingw-w64-x86_64-python-pygit2
pacman -S mingw-w64-x86_64-python-pip
pip install qasync
pip install pyqtgraph
pacman -S patch git
git clone https://github.com/m-labs/sipyco
cd sipyco
git show 20c946aad78872fe60b78d9b57a624d69f3eea47 | patch -p1 -R
python setup.py install
cd ..
git clone -b nac3 https://github.com/m-labs/artiq
cd artiq
python setup.py install

Locate a recent build of nac3artiq-msys2 from Hydra and download nac3artiq.zip. Then extract the contents in the appropriate location:

pacman -S unzip
wget https://nixbld.m-labs.hk/build/97899/download/1/nac3artiq.zip  # edit the build number
unzip nac3artiq.zip -d C:/msys64/mingw64/lib/python3.9/site-packages

Install additional NAC3 dependencies:

pacman -S mingw-w64-x86_64-lld

And you should be good to go.

For developers

This repository contains:

nac3ast: Python abstract syntax tree definition (based on RustPython).
nac3parser: Python parser (based on RustPython).
nac3core: Core compiler library, containing type-checking and code generation.
nac3standalone: Standalone compiler tool (core language only).
nac3artiq: Integration with ARTIQ and implementation of ARTIQ-specific extensions to the core language.
runkernel: Simple program that runs compiled ARTIQ kernels on the host and displays RTIO operations. Useful for testing without hardware.

Use nix develop in this repository to enter a development shell. If you are using a different shell than bash you can use e.g. nix develop --command fish.

Build NAC3 with cargo build --release. See the demonstrations in nac3artiq and nac3standalone.