M-Labs/nac3
M-Labs/nac3
8
1
Fork 11
Code Issues 97 Pull Requests 19 Releases Wiki Activity
New ARTIQ compiler, third iteration
1,043 Commits 32 Branches 0 Tags 67 MiB
Rust 89.6%
Python 7.2%
Nix 1.9%
C++ 0.9%
Shell 0.2%
Other 0.2%
e980f19c93
Go to file
David Mak e980f19c93 core: Simplify typed value assertions
2024-03-22 15:07:28 +08:00
nac3artiq core: Use BTreeMap for type variable mapping 2024-03-04 23:56:04 +08:00
nac3ast core: Update cargo dependencies 2024-02-23 15:41:04 +08:00
nac3core core: Simplify typed value assertions 2024-03-22 15:07:28 +08:00
nac3ld meta: Apply clippy suggested changes 2023-12-11 15:16:23 +08:00
nac3parser core: Update cargo dependencies 2024-02-23 15:41:04 +08:00
nac3standalone core: Apply clippy suggestions 2024-03-22 15:07:23 +08:00
nix update dependencies 2024-02-20 13:33:20 +08:00
runkernel meta: Update to Rust Edition 2021 2023-09-15 10:25:50 +08:00
.gitignore gitignore: fix msys2 path 2023-11-24 17:18:17 +08:00
Cargo.lock meta: Update cargo dependencies 2024-03-21 15:45:26 +08:00
Cargo.toml meta: Update to Rust Edition 2021 2023-09-15 10:25:50 +08:00
flake.lock flake: switch to nixpkgs unstable for newer rustc 2024-02-20 15:46:51 +08:00
flake.nix flake: switch to nixpkgs unstable for newer rustc 2024-02-20 15:46:51 +08:00
nac3.svg add icon 2022-04-18 15:07:53 +08:00
README.md windows: switch to CLANG64 MSYS2 2023-11-24 18:10:00 +08:00
rustfmt.toml move rustfmt.toml upper 2022-01-09 11:31:06 +08:00

README.md

icon

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.8+ 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 CLANG64". Edit /etc/pacman.conf to add:

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

Then run the following commands:

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

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).
  • nac3ld: Minimalist RISC-V and ARM linker.
  • 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.