Skip to content

Plotting and analysis tools for ARTIS simulations

License

Notifications You must be signed in to change notification settings

artis-mcrt/artistools

Repository files navigation

Artistools

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

DOI Installation and pytest codecov PyPI - Version

Installation

Requires Python >= 3.10

artistools can be installed from PyPI using `pip install artistools'. For development, clone the repository and make an editable install:

git clone https://github.com/artis-mcrt/artistools.git
cd artistools
python3 -m pip install -e .
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

Emission plot NLTE plot Estimator plot

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.