artistools

Artistools

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

Installation

Requires Python >= 3.10

The artistools command be invoked with uvx artistools or pipx artistools. For development (editable install), you will need the rust compiler. First, clone the repository:

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

To use a uv package manager virtual environment with locked dependency versions run:

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

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

alias artistools="uv run --frozen --project ~/PATH/TO/artistools -- artistools"

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

python3 -m pip install --editable .[dev]
pre-commit install

Usage

Type "artistools" at the command-line to get a full list of commands. The most frequently used 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 command. Most of these commands would usually be run from within an ARTIS simulation folder.

Example output

License

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

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

Citing Artistools

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