Notices

Mirrors

Repository:

• Codeberg
• GitHub
• GitLab

Prerequisites

Make sure you have installed:

• Julia
• Zig (v0.10.0)
• Zigmod

Optionally, you might also want to install Tracy Profiler.

Build

First, fetch the dependencies with zigmod fetch.

To build and install the library, run zig build install.

To run unit tests, run zig build test.

See zig build --help for more build options.

Example

To run the example which simulates the convection process, run one of the following:

# Run with the default allocator
zig build run -- -o res.bin -j $(nproc)
zig build run -Drelease-fast -- -o res.bin -j $(nproc)

# Run with the Tracy integration
zig build run -Dtracy -Drelease-fast -- -o res.bin
zig build run -Dtracy -Dtracy-depth=10 -Drelease-fast -- -o res.bin

# Run with the testing allocator
zig build test-run

# Run the benchmark
zig build bench
zig build bench -Drelease-fast

See zig build --help for more build options.

See zig build run -- --help for CLI arguments.

To animate the results, first, instantiate the project with

julia --project=. -e "using Pkg; Pkg.instantiate()"

Then, run one of the following

# Run without a daemon
julia --project=. scripts/animate.jl res.bin
julia --project=. scripts/animate.jl --postfix "'Custom postfix'" res.bin

# Run with a daemon
./julia.bash scripts/animate.jl res.bin
./julia.bash scripts/animate.jl --postfix "'Custom postfix'" res.bin

Use the --help flag to get help information.

To kill the daemon, run ./julia.bash kill.