README.md

The Kilonova Code (KNC)

Simulates relativistic jets, winds, and explosions in 2D axisymmety.

Quick Start

Copy + paste these lines at your terminal to clone and build the code:

git clone https://github.com/clemson-cal/app-kilonova
cd app-kilonova
cargo build --release

To load and plot the code's output files in Python, you also have to build the knc_loader Python module:

source build_loader.sh

You can also install the code to your system path by running cargo install --path . from the project root directory. This will place executable called kilonova in the ~/.cargo/bin directory. To run the code and generate a plot, you can use one of the preset configurations. For example, to run the jet_in_cloud problem for 0.1 seconds, type the following:

kilonova jet_in_cloud control.final_time=1.1

This will write two "checkpoint" files to the current working directory, chkpt.0000.cbor_ and chkpt.0001.cbor_, and then exit. The first one is the solution at the simulation start time (1 second for this setup) and at the end time at 1.1 seconds. To plot either of these files, you can use the included plotting script:

tools/plot chkpt.0001.cbor --field=ur

This will show a relief plot of the gas radial four-velocity. To see more plotting options, run python3 knc_tools/plot.py --help.

Developers

KNC is written and maintained by the Computational Astrophysics Lab at the Clemson University Department of Physics and Astronomy. The core developer/maintainer is presently Jonathan Zrake.