Metadata-Version: 2.4
Name: carbary_auroral_model
Version: 0.0.1
Summary: Python implementation for J.F. Carbary auroral oval model (2005)
Home-page: https://github.com/mmatroskin/carbary_auroral_model
Author: Maksim Tulin
Project-URL: Source, https://github.com/mmatroskin/carbary_auroral_model
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
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 :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cartopy<0.26,>=0.25.0
Requires-Dist: matplotlib<4.0,==3.10.9
Requires-Dist: numpy<3.0,>=2.4.4
Requires-Dist: imageio<3.0,>=2.37.3
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Carbary auroral boundaries model

## Description

This python package conatins auroral oval model, developed by Carbary J. F. (2005). 

The statistical model allows calculation of the auroral boundaries at most MLTs as a function of Kp and can serve as an approximation to the shape and extent of the statistical oval. 
The model take Kp geomagnetic index and magnetic local time (mlt) as input and produce the peak, poleward and equatorward boundaries of the auroral oval.

Implements the Model, described in the original Carbary J. F. publication "A Kp-based model of auroral boundaries" (SPACE WEATHER, VOL. 3, S10001, doi:10.1029/2005SW000162, 2005)

Citation: Carbary, J. F. (2005), A Kp-based model of auroral boundaries, Space Weather, 3, S10001, doi:10.1029/2005SW000162.

***Python 3.10+ requires***

## Classes and Methods

Library provides **AuroralBoundary** class describing Auroral oval for using in python applications

### AuroralBoundary.intensity_map

The field contains Intensity in every point belongs the auroral oval.
Returns numpy ndarray of lists **[longitude, latitude, intense]**. 

## How to use

```python
from carbary_model import AuroralBoundary

boundary = AuroralBoundary(kp=5.2,
                           ut_hours=datetime.datetime.now(datetime.UTC).hour,
                           advanced_mode=True)

```
