Metadata-Version: 2.0
Name: reesaurora
Version: 1.0.3
Summary: Model of Earth ionosphere.
Home-page: https://github.com/scivision/reesaurora
Author: Michael Hirsch, Ph.D
Author-email: UNKNOWN
License: UNKNOWN
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Requires-Python: >=3.6
Requires-Dist: gridaurora
Requires-Dist: msise00
Requires-Dist: numpy
Requires-Dist: python-dateutil
Requires-Dist: pytz
Requires-Dist: scipy
Requires-Dist: xarray
Provides-Extra: plot
Requires-Dist: matplotlib; extra == 'plot'
Requires-Dist: seaborn; extra == 'plot'
Provides-Extra: tests
Requires-Dist: coveralls; extra == 'tests'
Requires-Dist: nose; extra == 'tests'
Requires-Dist: pytest; extra == 'tests'

.. image:: https://zenodo.org/badge/36744637.svg
   :target: https://zenodo.org/badge/latestdoi/36744637

.. image:: https://travis-ci.org/scivision/reesaurora.svg
    :target: https://travis-ci.org/scivision/reesaurora

.. image:: https://coveralls.io/repos/scivision/reesaurora/badge.svg?branch=master
    :target: https://coveralls.io/github/scivision/reesaurora?branch=master

.. image:: https://api.codeclimate.com/v1/badges/fae4ee1dfb20a766ebce/maintainability
   :target: https://codeclimate.com/github/scivision/reesaurora/maintainability
   :alt: Maintainability


==========
ReesAurora
==========

Rees-Sergienko-Ivanov model of excitation rates, relevant to auroral optical emissions
inspired/based upon Gustavsson / Brandstrom et al `AIDA_Tools <https://github.com/scivision/AIDA-tools>`_

Model designed for **100 - 10,000 eV**, and is essentially a *parameter fit* to more advanced
models, making for convenient computation in this energy range with the PCs of the early 1990s.
Today, much more advanced physics-based models are tractable on a PC.

Uses MSISE-00 to generate O, O\ :sub:`2`, N\ :sub:`2` densities, and models outcome of primary electron precipitation on this neutral background.

.. image:: tests/demo.png
   :alt: volume production rate

.. contents::



Install
=======

Requires a Fortran compiler, such as ``gfortran``.  
Any Fortran compiler should work::

    pip install -e .


Example
========
::

  python RunRees.py -t 2011-03-15T12:34:56Z -c 65 -148

-o    specify output file (HDF5)
-c    specify geographic lat,lon


