Metadata-Version: 1.0
Name: ChiantiPy
Version: 0.7.1a0
Summary: a Python interface to the CHIANTI atomic database for astrophysical spectroscopy
Home-page: https://github.com/chianti-atomic/ChiantiPy
Author: Ken Dere
Author-email: kdere@gmu.edu
License: BSD
Description-Content-Type: UNKNOWN
Description: # ChiantiPy
        [![Build Status](https://travis-ci.org/chianti-atomic/ChiantiPy.svg?branch=master)](https://travis-ci.org/chianti-atomic/ChiantiPy)
        [![Documentation Status](http://readthedocs.org/projects/chiantipy/badge/?version=latest)](http://chiantipy.readthedocs.io/en/latest/?badge=latest)
        [![Coverage Status](https://coveralls.io/repos/github/chianti-atomic/ChiantiPy/badge.svg?branch=master)](https://coveralls.io/github/chianti-atomic/ChiantiPy?branch=master)
        [![ascl:1308.017](https://img.shields.io/badge/ascl-1308.017-blue.svg?colorB=262255)](http://ascl.net/1308.017)
        
        ChiantiPy is the Python interface to the [CHIANTI atomic database](http://www.chiantidatabase.org) for astrophysical spectroscopy.  It provides the capability to calculate the emission line and continuum spectrum of an optically thin plasma based on the data in the CHIANTI database.
        
        ## What is CHIANTI?
        CHIANTI provides a database of atomic data that can be used to interpret the emission of spectral lines and continua emitted from high-temperature, optically-thin astrophysical sources.  The CHIANTI project provides a suite of routines written in Interactive Data Language (IDL) to access the database and calculate various quantities for use in interpreting observed spectra or producing synthetic spectra.
        
        ## Installation
        The following dependencies are required to run ChiantiPy,
        
        * [Python](https://www.python.org/) (2.7,3)
        * [Numpy](http://www.numpy.org/)
        * [Scipy](https://www.scipy.org/)
        * [Matplotlib](http://matplotlib.org/)
        * [ipyparallel](https://github.com/ipython/ipyparallel)
        
        The following two are extremely useful for running Python programs
        * [IPython](http://ipython.org)
        * [Jupyter](http://jupyter.org/)
        
        
        Optionally, if you'd like to use the GUI dialogs,
        
        * [PyQt5](https://riverbankcomputing.com/software/pyqt/intro) and/or
        * [PyQt4](https://riverbankcomputing.com/software/pyqt/intro) and/or
        * [wxPython](http://www.wxpython.org/) although wxPython is only compatible with Python 2
        
        If you are not familiar with installing Python and the needed dependencies, we recommend the [Anaconda platform](https://www.continuum.io/downloads). Next, download the [CHIANTI database](http://www.chiantidatabase.org/chianti_download.html). Assuming you've placed the CHIANTI tree in `$HOME`, set the environment variable in your `.bashrc` file,
        ```Shell
        export XUVTOP=$HOME/chianti/dbase
        ```
        
        Finally, clone and install the source from GitHub,
        ```Shell
        $ git clone --recursive https://github.com/chianti-atomic/ChiantiPy.git
        $ cd ChiantiPy
        $ python setup.py install
        ```
        
        ## Usage
        As a quick example, we'll calculate the populations of the top 10 levels of Fe XIV as a function of temperature at constant density and plot them:
        ```Python
        >>> import ChiantiPy.core as ch
        >>> import numpy as np
        >>> import matplotlib.pyplot as plt
        >>> temperature = np.logspace(5.8,6.8,21)
        >>> fe14 = ch.ion('fe_14',temperature=temperature,eDensity=1.e+9,em=1.e+27)
        >>> fe14.popPlot()
        >>> plt.show()
        ```
        
        ## Help
        For more information about installing and using either ChiantiPy or the CHIANTI atomic database, check out the following links:
        
        * [ChiantiPy Documentation](http://chiantipy.readthedocs.io/en/latest/)
        * [Chianti Google Mailing List](https://groups.google.com/forum/#!forum/chianti)
        * [CHIANTI Atomic Database Webpage](http://www.chiantidatabase.org/)
        
Platform: UNKNOWN
