Name | artistools JSON |
Version |
2024.2.22.2
JSON |
| download |
home_page | |
Summary | Plotting and analysis tools for the ARTIS 3D radiative transfer code for supernovae and kilonovae. |
upload_time | 2024-02-22 11:08:58 |
maintainer | |
docs_url | None |
author | |
requires_python | >=3.10 |
license | MIT |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# 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)
## 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 make use of artistools please cite it. For details, see [https://zenodo.org/badge/latestdoi/53433932](https://zenodo.org/badge/latestdoi/53433932).
Raw data
{
"_id": null,
"home_page": "",
"name": "artistools",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "",
"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>",
"download_url": "https://files.pythonhosted.org/packages/5c/ef/f3d53093f2fbc1b60f1a63664a5889fb1b2f74837e6ed1606d0db88ebb7b/artistools-2024.2.22.2.tar.gz",
"platform": null,
"description": "# Artistools\n\n> Artistools is collection of plotting, analysis, and file format conversion tools for the [ARTIS](https://github.com/artis-mcrt/artis) radiative transfer code.\n\n[![DOI](https://zenodo.org/badge/53433932.svg)](https://zenodo.org/badge/latestdoi/53433932)\n[![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)\n[![codecov](https://codecov.io/gh/artis-mcrt/artistools/branch/main/graph/badge.svg?token=XFlarJqeZd)](https://codecov.io/gh/artis-mcrt/artistools)\n\n## Installation\nRequires Python >= 3.10\n\nartistools can be installed from PyPI using `pip install artistools'. For development, clone the repository and make an editable install:\n```sh\ngit clone https://github.com/artis-mcrt/artistools.git\ncd artistools\npython3 -m pip install -e .\npre-commit install\n```\n\n## Usage\nType \"artistools\" at the command-line to get a full list of commands. The most frequently used commands are:\n- artistools plotspectra\n- artistools plotlightcurve\n- artistools plotestimators\n- artistools plotnltepops\n- artistools describeinputmodel\n\nUse 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.\n\n## Example output\n\n![Emission plot](https://github.com/artis-mcrt/artistools/raw/main/images/fig-emission.png)\n![NLTE plot](https://github.com/artis-mcrt/artistools/raw/main/images/fig-nlte-Ni.png)\n![Estimator plot](https://github.com/artis-mcrt/artistools/raw/main/images/fig-estimators.png)\n\n## License\nDistributed under the MIT license. See [LICENSE](https://github.com/artis-mcrt/artistools/blob/main/LICENSE.txt) for more information.\n\n[https://github.com/artis-mcrt/artistools](https://github.com/artis-mcrt/artistools)\n\n\n## Citing Artistools\n\nIf you make use of artistools please cite it. For details, see [https://zenodo.org/badge/latestdoi/53433932](https://zenodo.org/badge/latestdoi/53433932).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Plotting and analysis tools for the ARTIS 3D radiative transfer code for supernovae and kilonovae.",
"version": "2024.2.22.2",
"project_urls": {
"Repository": "https://www.github.com/artis-mcrt/artistools/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cceba17048a0cd3bed4bddc63b9877a90f217749d088122b5e111a84abc70432",
"md5": "194860f3584afbbd89e8bbba2083cb96",
"sha256": "be559381a42c4456c0b4a7047a6cd6ba52e4e519a069244f3036a52f709513bf"
},
"downloads": -1,
"filename": "artistools-2024.2.22.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "194860f3584afbbd89e8bbba2083cb96",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8179158,
"upload_time": "2024-02-22T11:08:56",
"upload_time_iso_8601": "2024-02-22T11:08:56.521689Z",
"url": "https://files.pythonhosted.org/packages/cc/eb/a17048a0cd3bed4bddc63b9877a90f217749d088122b5e111a84abc70432/artistools-2024.2.22.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ceff3d53093f2fbc1b60f1a63664a5889fb1b2f74837e6ed1606d0db88ebb7b",
"md5": "cb89e798c2fad5761f67a6fff367fe36",
"sha256": "faceb81fbdfab352d8879014b335602e3c83f65df0db0ae4c153ac2e1ffa321e"
},
"downloads": -1,
"filename": "artistools-2024.2.22.2.tar.gz",
"has_sig": false,
"md5_digest": "cb89e798c2fad5761f67a6fff367fe36",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 8106740,
"upload_time": "2024-02-22T11:08:58",
"upload_time_iso_8601": "2024-02-22T11:08:58.672126Z",
"url": "https://files.pythonhosted.org/packages/5c/ef/f3d53093f2fbc1b60f1a63664a5889fb1b2f74837e6ed1606d0db88ebb7b/artistools-2024.2.22.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 11:08:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "artis-mcrt",
"github_project": "artistools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "artistools"
}