A tool for simulating images and spectral energy distributions (SEDs) of astrophysical jets, particularly the relativistic jets produced by spinning black holes. The underlying model assumes force-free electrodynamics and a nonthermal population of synchrotron-emitting electrons. Details are provided in Pesce et al. (TBD).
The code is only tested on Python 3.9 and higher, and it may break for earlier versions. It is recommended that you install ffjet using a virtual environment, e.g.:
$ git clone https://github.com/dpesce/ffjet
$ python -m venv .venv
$ source .venv/bin/activate
(.venv) $ cd ffjet
(.venv) $ pip install .
You can also install directly from GitHub:
pip install "git+https://github.com/dpesce/ffjet.git"
There is an optional progress bar functionality that uses tqdm; it can be installed using:
pip install "ffjet[progress] @ git+https://github.com/dpesce/ffjet.git"
There are a number of example scripts contained in the examples folder folder. You can check to make sure your installation is working by running one of these scripts, e.g.:
cd ./examples
python ./simulate_jet_image.py