Metadata-Version: 2.1
Name: fiasco
Version: 0.2.1
Summary: A Python interface to the CHIANTI atomic database
Home-page: https://fiasco.readthedocs.io
Author: Will Barnes
Author-email: will.t.barnes@gmail.com
License: BSD 3-Clause
Project-URL: Source, https://github.com/wtbarnes/fiasco
Project-URL: Issues, https://github.com/wtbarnes/fiasco/issues/
Keywords: heliophysics,solar physics,astrophysics,plasma physics,science,atomic data
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.rst
Requires-Dist: astropy
Requires-Dist: numpy
Requires-Dist: h5py
Requires-Dist: fortranformat
Requires-Dist: plasmapy
Provides-Extra: all
Requires-Dist: pytest ; extra == 'all'
Requires-Dist: pytest-astropy ; extra == 'all'
Requires-Dist: pytest-cov ; extra == 'all'
Requires-Dist: matplotlib ; extra == 'all'
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-astropy ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: matplotlib ; extra == 'dev'
Requires-Dist: sphinx <5,>=4.2 ; extra == 'dev'
Requires-Dist: sphinx-automodapi ; extra == 'dev'
Requires-Dist: sphinx-gallery ; extra == 'dev'
Requires-Dist: towncrier ; extra == 'dev'
Requires-Dist: aiapy ; extra == 'dev'
Requires-Dist: sphinx-book-theme ; extra == 'dev'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx <5,>=4.2 ; extra == 'docs'
Requires-Dist: sphinx-automodapi ; extra == 'docs'
Requires-Dist: sphinx-gallery ; extra == 'docs'
Requires-Dist: towncrier ; extra == 'docs'
Requires-Dist: aiapy ; extra == 'docs'
Requires-Dist: sphinx-book-theme ; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-astropy ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: matplotlib ; extra == 'test'

# fiasco

[![Powered by SunPy Badge]( http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat)](http://www.sunpy.org)
[![fiasco CI status](https://github.com/wtbarnes/fiasco/workflows/CI/badge.svg?branch=main)](https://github.com/wtbarnes/fiasco/actions)
[![Documentation Status](https://readthedocs.org/projects/fiasco/badge/?version=stable)](https://fiasco.readthedocs.io/en/stable/?badge=stable)
[![PyPI](https://img.shields.io/pypi/v/fiasco.svg)](https://pypi.python.org/pypi)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7504785.svg)](https://doi.org/10.5281/zenodo.7504785)
[![codecov](https://codecov.io/gh/wtbarnes/fiasco/branch/main/graph/badge.svg?token=damCmTyRUN)](https://codecov.io/gh/wtbarnes/fiasco)
[![matrix](https://img.shields.io/matrix/atomic-data:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=openastronomy.modular.im)](https://openastronomy.element.io/#/room/#atomic-data:openastronomy.org)

A Python interface to the [CHIANTI atomic database](http://www.chiantidatabase.org/). For a high level
overview of the package, have a look at my talk ([slides](https://zenodo.org/record/1249002), [video](https://youtu.be/7_Nr700kBME)) from
the [2018 Python in Astronomy](http://openastronomy.org/pyastro/2018/) conference.

## Install

```shell
$ pip install fiasco
```

The [CHIANTI atomic database](http://www.chiantidatabase.org/chianti_download.html) is also required.
See [the docs](https://fiasco.readthedocs.io/en/latest/chianti.html#acquiring-the-atomic-data) for more details.

## Example

```python
>>> import astropy.units as u
>>> import fiasco
>>> iron = fiasco.Element('iron', [1e4, 1e6, 1e8]*u.K)
# Print some information about the element
>>> iron.atomic_number
26
>>> iron.atomic_symbol
'Fe'
>>> iron.abundance
<Quantity 3.16227766e-05>
# Select the Fe 16 ion
>>> iron[15].ion_name
'Fe 16'
>>> iron[15].charge_state
15
# Ionization fraction
>>> iron[15].ioneq
<Quantity [0.000e+00, 2.377e-08, 4.163e-18]>
```

## Why *fiasco*?

A *fiasco*, or flask, is [the typical style of bottle](https://en.wikipedia.org/wiki/Fiasco_(bottle)) used to serve the *Chianti Classico* wine. It is typically larger and rounder at the bottom and is covered by a straw basket. In the same way, the `fiasco` package serves up the CHIANTI atomic database.
