Metadata-Version: 2.1
Name: artistools
Version: 2024.7.4.2
Summary: Plotting and analysis tools for the ARTIS 3D radiative transfer code for supernovae and kilonovae.
Author-email: "Luke J. Shingles" <luke.shingles@gmail.com>, "Christine E. Collins" <c.collins@gsi.de>, Alexander Holas <alexander.holas@h-its.org>, Fionntan Callan <fcallan02@qub.ac.uk>, Stuart Sim <s.sim@qub.ac.uk>
License: MIT
Project-URL: Repository, https://www.github.com/artis-mcrt/artistools
Project-URL: Source, https://www.github.com/artis-mcrt/artistools
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Rust
Classifier: Framework :: Matplotlib
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: argcomplete>=3.4.0
Requires-Dist: astropy>=6.1.1
Requires-Dist: coverage>=7.5.4
Requires-Dist: extinction>=0.4.6
Requires-Dist: imageio>=2.34.2
Requires-Dist: matplotlib>=3.9.1
Requires-Dist: mypy>=1.10.1
Requires-Dist: numexpr>=2.10.1
Requires-Dist: numpy>=2.0.0
Requires-Dist: pandas>=2.2.2
Requires-Dist: polars>=1.0.0
Requires-Dist: pre-commit>=3.7.1
Requires-Dist: pyarrow>=16.1.0
Requires-Dist: pynonthermal>=2024.4.29
Requires-Dist: pypdf>=4.2.0
Requires-Dist: pytest>=8.2.2
Requires-Dist: pytest-codspeed>=2.2.1
Requires-Dist: pytest-cov>=5.0.0
Requires-Dist: pytest-xdist[psutil]>=3.6.1
Requires-Dist: pyvista>=0.43.10
Requires-Dist: PyYAML>=6.0.1
Requires-Dist: ruff>=0.5.0
Requires-Dist: scipy>=1.14.0
Requires-Dist: setuptools_scm[toml]>=8.1.0
Requires-Dist: tabulate>=0.9
Requires-Dist: typeguard>=4.3.0
Requires-Dist: types-PyYAML>=6.0.12.20240311
Requires-Dist: types-tabulate>=0.9.0.20240106
Requires-Dist: wheel>=0.43.0
Requires-Dist: zstandard>=0.22.0

# Artistools

> Artistools is collection of plotting, analysis, and file format conversion tools for the [ARTIS](https://github.com/artis-mcrt/artis) radiative transfer code.

[![DOI](https://zenodo.org/badge/53433932.svg)](https://zenodo.org/badge/latestdoi/53433932)
[![Installation and pytest](https://github.com/artis-mcrt/artistools/actions/workflows/pytest.yml/badge.svg)](https://github.com/artis-mcrt/artistools/actions/workflows/pytest.yml)
[![codecov](https://codecov.io/gh/artis-mcrt/artistools/branch/main/graph/badge.svg?token=XFlarJqeZd)](https://codecov.io/gh/artis-mcrt/artistools)
![PyPI - Version](https://img.shields.io/pypi/v/artistools)

## 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:
```sh
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](https://github.com/artis-mcrt/artistools/raw/main/images/fig-emission.png)
![NLTE plot](https://github.com/artis-mcrt/artistools/raw/main/images/fig-nlte-Ni.png)
![Estimator plot](https://github.com/artis-mcrt/artistools/raw/main/images/fig-estimators.png)

## License
Distributed under the MIT license. See [LICENSE](https://github.com/artis-mcrt/artistools/blob/main/LICENSE.txt) for more information.

[https://github.com/artis-mcrt/artistools](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](https://zenodo.org/badge/latestdoi/53433932).
