A Rust library for common preprocessing tasks performed in the data pipeline of the Murchison Widefield Array (MWA), located on the land of the Wajarri Yamatji people in Murchison Shire, Western Australia.
Birl reads MWA correlator visibilities in the gpufits file format using mwalib, which supports the existing "legacy" MWA correlator, as well as the in-development "MWAX" correlator.
Birli is the Wajarri word for lightning, a common cause of outages at the MWA, and a great descriptor for the speed which this library intends to deliver.
for OS-specific instructions, check out the linux and macOS CI Scripts; the Makefile.toml; and the Dockerfile as these are tested regularly. The instructions below may be updated less frequently, but are better documented.
```bash
sudo apt install -y gcc libssl-dev pkg-config curl unzip wget
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs -sSf | sh -s -- -y
cargo install --force cargo-make
export MAKEFLAGS="-j $MAKEFLAGS"
cargo make install_deps
export LDLIBRARYPATH="/usr/local/lib/:/usr/lib/x86_64-linux-gnu/" ```
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs -sSf | sh -s -- -y
cargo install --force cargo-make
brew tap mwaTelescope/tap
brew cask install casacore-data casacore aoflagger erfa ```
Unfortunately most of the prerequisites aren't available on Windows. However, WSL is great, and there is a docker image! You could use VSCode remote for WSL or Docker. Your best best is Ubuntu LTS
bash
cargo install --path .
This creates a birli binary in $HOME/.cargo/bin
Having issues with Birli? run the test suite to narrow down your issue.
bash
cargo test
Experiencing segfaults? I can guarantee it's because of one of the C library dependencies. Make sure you have the right versions of all the libraries. These are specified in Prerequisites.
Get library versions with:
```bash apt show liberfa-dev aoflagger --version
```
If you have something like CASA installed from apt, it's going to put an
ancient cfitsio library version in /usr/lib/x86_64-linux-gnu/, to get around
this, you must export LD_LIBRARY_PATH=/usr/local/lib/:/usr/lib/x86_64-linux-gnu/ in the shell so that Birli can find the correct library version.
Couldn't get it working on your environment? You can always run Birli in Docker
bash
docker run mwatelescope/birli:latest -h
Want to open a shell within a fully provisioned Birli development environment? Easy!
bash
docker run -it --entrypoint /bin/bash --volume $PWD:/app mwatelescope/birli:latest
Note: This mounts the current directory to /app in the Docker image, meaning both of these systems share the same
target folder. so if your host system is a different
architecture than Docker, you may need to cargo clean each time you switch between these environments. You
may also want to temporarily disable any linters or language servers that use
birli -h
```txt USAGE: birli [SUBCOMMAND]
FLAGS: -h, --help Prints help information -V, --version Prints version information
SUBCOMMANDS: aoflagger flag visibilities with aoFlagger help Prints this message or the help of the given subcommand(s) ```
birli aoflagger -h
```txt flag visibilities with aoFlagger
USAGE:
birli aoflagger [FLAGS] [OPTIONS]
FLAGS: -h, --help Prints help information --no-cable-delay Do not perform cable length corrections. -V, --version Prints version information
OPTIONS:
-f
ARGS:
```
A direct comparison between Birli and Cotter might look like this.
bash
birli aoflagger \
-m tests/data/1247842824_flags/1247842824.metafits \
-f "tests/data/1247842824_flags/flags_birli/FlagfileBirliMWA%%.mwaf" \
tests/data/1247842824_flags/1247842824_20190722150008_gpubox01_00.fits
bash
cotter \
-m tests/data/1247842824_flags/1247842824cotter-friendly.metafits \
-o "tests/data/1247842824_flags/FlagfileCotterMWA%%.mwaf" \
-allowmissing \
-edgewidth 0 \
-endflag 0 \
-initflag 0 \
-noantennapruning \
-nocablelength \
-noflagautos \
-noflagdcchannels \
-nogeom \
-sbpassband tests/data/subband-passband-128ch-unitary.txt \
-nostats \
-sbcount 1 \
-sbstart 1 \
-flag-strategy /usr/local/share/aoflagger/strategies/mwa-default.lua \
tests/data/1247842824_flags/1247842824_20190722150008_gpubox01_00.fits
Pull requests are welcome! Please do your best to ensure that the high standards of test coverage are maintained.
Before each commit, use cargo make ci to ensure your code is formatted correctly.
This scientific work uses data obtained from the Murchison Radio-astronomy Observatory. We acknowledge the Wajarri Yamatji people as the traditional owners of the Observatory site.
This repo is approved by...
