diff --git a/README.md b/README.md index 1b5ea870c..47a79df84 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ -# Artistools +# artistools [![DOI](https://zenodo.org/badge/53433932.svg)](https://zenodo.org/badge/latestdoi/53433932) -[![Supported Python versions](https://img.shields.io/pypi/pyversions/artistools)](https://pypi.org/project/artistools/) [![PyPI - Version](https://img.shields.io/pypi/v/artistools)](https://pypi.org/project/artistools) +[![License](https://img.shields.io/github/license/artis-mcrt/artistools)](https://github.com/artis-mcrt/artistools/blob/main/LICENSE) + +[![Supported Python versions](https://img.shields.io/pypi/pyversions/artistools)](https://pypi.org/project/artistools/) [![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) -[![License](https://img.shields.io/github/license/artis-mcrt/artistools)](https://github.com/artis-mcrt/artistools/blob/main/LICENSE) Artistools is collection of plotting, analysis, and file format conversion tools for the [ARTIS](https://github.com/artis-mcrt/artis) radiative transfer code. @@ -38,15 +39,19 @@ pip install --editable .[dev] pre-commit install ``` +## 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). + ## Usage -Type "artistools" at the command-line to get a full list of commands. The most frequently used commands are: +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 command. Most of these commands would usually be run from within an ARTIS simulation folder. +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 @@ -58,8 +63,3 @@ Use the -h option to get a list of command-line arguments for each command. Most 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).