lyken/nac3

New ARTIQ compiler, third iteration

Go to file

ychenfo 86ce513cb5 nac3standalone: fix broken test previously this test unexpectedly passed because it is a slice assignment to extend the list, which is valid in CPython and hence in interpret_demo, and which also happened to give the same output in nac3 by memmove the elements in the list of bool		2022-04-05 18:21:46 +08:00
nac3artiq	nac3artiq: resolve unsigned int host variable as defautl param	2022-03-30 04:05:47 +08:00
nac3ast	nac3ast/parser/core: use i128 for u64 constants	2022-03-08 18:21:14 +08:00
nac3core	nac3core: add bound check for list slice	2022-04-05 18:21:46 +08:00
nac3parser	fix warnings	2022-03-26 18:52:08 +08:00
nac3standalone	nac3standalone: fix broken test	2022-04-05 18:21:46 +08:00
nix	windows: add wine-msys2-build	2022-04-05 10:06:36 +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-31 10:40:18 +08:00
Cargo.toml	update inkwell. Closes #67	2021-12-25 22:17:06 +08:00
flake.lock	flake: update nixpkgs	2022-04-05 10:10:08 +08:00
flake.nix	windows: create MSYS2 package	2022-04-04 14:24:47 +08:00
README.md	README: update Windows instructions	2022-04-05 18:07:38 +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

Install MSYS2, and open "MSYS2 MinGW x64". Edit /etc/pacman.conf to add:

[artiq]
SigLevel = Optional TrustAll
Server = https://lab.m-labs.hk/msys2

Then run the following commands:

pacman -Syu
pacman -S mingw-w64-x86_64-artiq

Install lld-msys2 manually:

wget https://nixbld.m-labs.hk/build/115527/download/1/ld.lld.exe
mv ld.lld.exe C:/msys64/mingw64/bin

Note: This build of NAC3 cannot be used with Anaconda Python nor the python.org binaries for Windows. Those Python versions are compiled with Visual Studio (MSVC) and their ABI is incompatible with the GNU ABI used in this build. We have no plans to support Visual Studio nor the MSVC ABI. If you need a MSVC build, please install the requisite bloated spyware from Microsoft and compile NAC3 yourself.

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.