mwojcik
/
nac3
forked from M-Labs/nac3
1
0
Fork 0
Code Pull Requests Activity
New ARTIQ compiler, third iteration
531 Commits 22 Branches 0 Tags 95 MiB
Rust 89.4%
Python 7.6%
Nix 2%
C++ 0.6%
Shell 0.2%
Other 0.2%
Go to file
Sebastien Bourdeauducq 9cc9a0284a nac3standalone: style 2021-12-28 10:59:17 +08:00
llvm LLVM PGO support 2021-12-26 21:11:14 +08:00
nac3artiq add file name to AST node location 2021-12-28 01:28:55 +08:00
nac3ast fix broken tests 2021-12-28 01:38:16 +08:00
nac3core nac3core: improve some type annotation error messages (#87) 2021-12-28 10:49:14 +08:00
nac3parser fix broken tests 2021-12-28 01:38:16 +08:00
nac3standalone nac3standalone: style 2021-12-28 10:59:17 +08:00
runkernel runkernel: improve print_int debug functions 2021-11-19 12:39:57 +08:00
.gitignore nac3embedded: basic source extraction 2020-12-18 23:45:09 +08:00
Cargo.lock remove num-traits 2021-12-26 00:32:08 +08:00
Cargo.toml update inkwell. Closes #67 2021-12-25 22:17:06 +08:00
README.md README: update 2021-12-13 19:02:46 +08:00
flake.lock flake: update nixpkgs 2021-12-25 21:10:19 +08:00
flake.nix LLVM PGO support 2021-12-26 21:11:14 +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

After setting up Nix as above, use nix shell github:m-labs/artiq/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.

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.