fiasco


Namefiasco JSON
Version 0.3.0 PyPI version JSON
download
home_pageNone
SummaryA Python interface to the CHIANTI atomic database
upload_time2024-09-11 16:34:05
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseCopyright (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.
keywords heliophysics solar physics astrophysics plasma physics science atomic data atomic physics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "fiasco",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "heliophysics, solar physics, astrophysics, plasma physics, science, atomic data, atomic physics",
    "author": null,
    "author_email": "Will Barnes <will.t.barnes@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/89/13/f4c234eb7c6e369955e1eb6f57aac820668b0e2254955a450c4b7f1d1f9d/fiasco-0.3.0.tar.gz",
    "platform": null,
    "description": "# fiasco\n\n[![fiasco CI status](https://github.com/wtbarnes/fiasco/actions/workflows/ci.yml/badge.svg)](https://github.com/wtbarnes/fiasco/actions/workflows/ci.yml)\n[![Documentation Status](https://readthedocs.org/projects/fiasco/badge/?version=stable)](https://fiasco.readthedocs.io/en/stable/?badge=stable)\n[![PyPI](https://img.shields.io/pypi/v/fiasco.svg)](https://pypi.python.org/pypi)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7504785.svg)](https://doi.org/10.5281/zenodo.7504785)\n[![codecov](https://codecov.io/gh/wtbarnes/fiasco/branch/main/graph/badge.svg?token=damCmTyRUN)](https://codecov.io/gh/wtbarnes/fiasco)\n[![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)\n\n`fiasco` provides a Python interface to the [CHIANTI](http://www.chiantidatabase.org/), an atomic database used primarily for astrophysical spectroscopy.\nIn addition to several high-level abstractions of the atomic data, fiasco also provides many common atomic physics calculations.\n\n## Install\n\n```shell\npip install fiasco\n```\n\nThe [CHIANTI atomic database](http://www.chiantidatabase.org/chianti_download.html) is also required.\nSee [the docs](https://fiasco.readthedocs.io/en/latest/quick_start.html#fiasco-quick-start) for more details.\n\n## Usage\n\nThe primary interface in `fiasco` is the `Ion` object:\n\n```python\n>>> import fiasco\n>>> import astropy.units as u\n>>> fe_18 = fiasco.Ion('Fe XVIII', 1*u.MK)\n>>> fe_18\nCHIANTI Database Ion\n---------------------\nName: Fe 18\nElement: iron (26)\nCharge: +17\nNumber of Levels: 337\nNumber of Transitions: 7712\n\nTemperature range: [1.000 MK, 1.000 MK]\n\nHDF5 Database: ...chianti_dbase.h5\nUsing Datasets:\n    ioneq: chianti\n    abundance: sun_coronal_1992_feldman_ext\n    ip: chianti\n```\n\nFor 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).\nFor more advanced examples, see [the example gallery](https://fiasco.readthedocs.io/en/stable/generated/gallery/index.html).\n\n## Acknowledging or Citing fiasco\n\nIf you use `fiasco` in any published work, please cite the appropriate version of the software as well as the CHIANTI atomic database.\nSee [this page](https://fiasco.readthedocs.io/en/stable/citation.html) for additional details.\n\n## Why *fiasco*?\n\nA *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.\n",
    "bugtrack_url": null,
    "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. ",
    "summary": "A Python interface to the CHIANTI atomic database",
    "version": "0.3.0",
    "project_urls": {
        "Documentation": "https://fiasco.readthedocs.io",
        "Homepage": "https://fiasco.readthedocs.io",
        "Issues": "https://github.com/wtbarnes/fiasco/issues/",
        "Repository": "https://github.com/wtbarnes/fiasco"
    },
    "split_keywords": [
        "heliophysics",
        " solar physics",
        " astrophysics",
        " plasma physics",
        " science",
        " atomic data",
        " atomic physics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6a26f60a102a7bf18fa244bc94b2467c3306b076b923dbf2f2b4b43742468331",
                "md5": "3e806e0b402941be4da7546481d9ff16",
                "sha256": "e53451f97658b299270dad4ff3f6538fe7add590a9b6538bc4c9a4df679e1098"
            },
            "downloads": -1,
            "filename": "fiasco-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3e806e0b402941be4da7546481d9ff16",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 1514304,
            "upload_time": "2024-09-11T16:34:03",
            "upload_time_iso_8601": "2024-09-11T16:34:03.553009Z",
            "url": "https://files.pythonhosted.org/packages/6a/26/f60a102a7bf18fa244bc94b2467c3306b076b923dbf2f2b4b43742468331/fiasco-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8913f4c234eb7c6e369955e1eb6f57aac820668b0e2254955a450c4b7f1d1f9d",
                "md5": "aa9fececea36d220615d9c1aa7fbaf64",
                "sha256": "46be5ecb4f9e19fb45f655767cc7a0b1cd001f2f6519c4f07a130a111a9f2d48"
            },
            "downloads": -1,
            "filename": "fiasco-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "aa9fececea36d220615d9c1aa7fbaf64",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 1567707,
            "upload_time": "2024-09-11T16:34:05",
            "upload_time_iso_8601": "2024-09-11T16:34:05.404351Z",
            "url": "https://files.pythonhosted.org/packages/89/13/f4c234eb7c6e369955e1eb6f57aac820668b0e2254955a450c4b7f1d1f9d/fiasco-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-11 16:34:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "wtbarnes",
    "github_project": "fiasco",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "fiasco"
}
        
Elapsed time: 7.86916s