Metadata-Version: 2.4
Name: fiasco
Version: 0.4.1
Summary: A Python interface to the CHIANTI atomic database
Author-email: Will Barnes <will.t.barnes@gmail.com>
License: Copyright (c) 2024, Will Barnes
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without modification,
        are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright notice, this
          list of conditions and the following disclaimer in the documentation and/or
          other materials provided with the distribution.
        * Neither the name of the copyright holder nor the names of its contributors may be
          used to endorse or promote products derived from this software without
          specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
        ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://fiasco.readthedocs.io
Project-URL: Documentation, https://fiasco.readthedocs.io
Project-URL: Repository, https://github.com/wtbarnes/fiasco
Project-URL: Issues, https://github.com/wtbarnes/fiasco/issues/
Keywords: heliophysics,solar physics,astrophysics,plasma physics,science,atomic data,atomic physics
Classifier: Development Status :: 4 - Beta
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.rst
Requires-Dist: astropy
Requires-Dist: fortranformat
Requires-Dist: h5py
Requires-Dist: numpy<2.3.0
Requires-Dist: plasmapy
Provides-Extra: all
Requires-Dist: fiasco; extra == "all"
Provides-Extra: test
Requires-Dist: fiasco[all]; extra == "test"
Requires-Dist: asdf-astropy; extra == "test"
Requires-Dist: asdf>=3.1; extra == "test"
Requires-Dist: matplotlib; extra == "test"
Requires-Dist: pytest-astropy; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest; extra == "test"
Provides-Extra: test-idl
Requires-Dist: fiasco[test]; extra == "test-idl"
Requires-Dist: hissw; extra == "test-idl"
Provides-Extra: docs
Requires-Dist: fiasco[all]; extra == "docs"
Requires-Dist: aiapy>=0.10; extra == "docs"
Requires-Dist: asdf-astropy; extra == "docs"
Requires-Dist: asdf>=3.1; extra == "docs"
Requires-Dist: hissw; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-gallery; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
Provides-Extra: dev
Requires-Dist: fiasco[docs,test]; extra == "dev"
Dynamic: license-file

# fiasco

[![fiasco CI status](https://github.com/wtbarnes/fiasco/actions/workflows/ci.yml/badge.svg)](https://github.com/wtbarnes/fiasco/actions/workflows/ci.yml)
[![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)

`fiasco` provides a Python interface to the [CHIANTI](http://www.chiantidatabase.org/), an atomic database used primarily for astrophysical spectroscopy.
In addition to several high-level abstractions of the atomic data, fiasco also provides many common atomic physics calculations.

## 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/quick_start.html#fiasco-quick-start) for more details.

## Usage

The primary interface in `fiasco` is the `Ion` object:

```python
>>> import fiasco
>>> import astropy.units as u
>>> fe_18 = fiasco.Ion('Fe XVIII', 1*u.MK)
>>> fe_18
CHIANTI Database Ion
---------------------
Name: Fe 18
Element: iron (26)
Charge: +17
Number of Levels: 337
Number of Transitions: 7712

Temperature range: [1.000 MK, 1.000 MK]

HDF5 Database: ...chianti_dbase.h5
Using Datasets:
    ioneq: chianti
    abundance: sun_coronal_1992_feldman_ext
    ip: chianti
```

For a quick start guide to using `fiasco`, see [this page of the documentation](https://fiasco.readthedocs.io/en/stable/quick_start.html#fiasco-quick-start).
For more advanced examples, see [the example gallery](https://fiasco.readthedocs.io/en/stable/generated/gallery/index.html).

## Acknowledging or Citing fiasco

If you use `fiasco` in any published work, please cite the appropriate version of the software as well as the CHIANTI atomic database.
See [this page](https://fiasco.readthedocs.io/en/stable/citation.html) for additional details.

## 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.
