lyken
8f0084ac8a
It also checks for inconsistent dimensions if the input is a list. e.g., rejecting `[[1.0, 2.0], [3.0]]`. However, currently only `np_array(<input>, copy=False)` and `np_array(<input>, copy=True)` are supported. In NumPy, copy could be false, true, or None. Right now, NAC3's `np_array(<input>, copy=False)` behaves like NumPy's `np.array(<input>, copy=None)`. |
||
---|---|---|
nac3artiq | ||
nac3ast | ||
nac3core | ||
nac3ld | ||
nac3parser | ||
nac3standalone | ||
nix | ||
runkernel | ||
.clang-format | ||
.clippy.toml | ||
.gitignore | ||
.pre-commit-config.yaml | ||
Cargo.lock | ||
Cargo.toml | ||
flake.lock | ||
flake.nix | ||
nac3.svg | ||
README.md | ||
rustfmt.toml |
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
.
Pre-Commit Hooks
You are strongly recommended to use the provided pre-commit hooks to automatically reformat files and check for non-optimal Rust practices using Clippy. Run pre-commit install
to install the hook and pre-commit
will automatically run cargo fmt
and cargo clippy
for you.
Several things to note:
- If
cargo fmt
orcargo clippy
returns an error, the pre-commit hook will fail. You should fix all errors before trying to commit again. - If
cargo fmt
reformats some files, the pre-commit hook will also fail. You should review the changes and, if satisfied, try to commit again.