artistools

artistools

Artistools is collection of plotting, analysis, and file format conversion tools for the ARTIS radiative transfer code.

Installation

Requires Python >= 3.11

The artistools command be invoked with uvx artistools or pipx artistools.

For development, you will need the rust compiler and a clone of the repository:

git clone https://github.com/artis-mcrt/artistools.git
cd artistools

To create a uv virtual environment with locked dependency versions, run:

uv sync --frozen
uv pip install --group dev --editable .[extras]
pre-commit install

The artistools command from the project environment can be available by activating the environment (source artistools/.venv/bin/activate) or by adding the following alias to your startup script:

alias artistools="~/PATH/TO/artistools/.venv/bin/artistools"

Alternatively, to avoid uv and install into the system environment with pip:

pip install --group dev --editable .[extras]
pre-commit install

To learn how to enable command-line autocompletions, run:

artistools completions

Citing artistools

If you artistools for a paper or presentation, please cite it. For details, see https://zenodo.org/badge/latestdoi/53433932.

Usage

Run "artistools" at the command-line to get a full list of subcommands. Some common commands are:

• artistools plotspectra
• artistools plotlightcurve
• artistools plotestimators
• artistools plotnltepops
• artistools describeinputmodel

Use the -h option to get a list of command-line arguments for each subcommand. Most of these commands should be run either within an ARTIS simulation folder or by passing the folder path as the last argument.

Example output

License

Distributed under the MIT license. See LICENSE for more information.

https://github.com/artis-mcrt/artistools