Metadata-Version: 2.4
Name: PyIRTAM
Version: 0.0.7
Summary: Python tool for IRTAM using PyIRI
Author-email: Victoriya Forsythe <victoriya.makarevich@nrl.navy.mil>
License: MIT License
        
        Copyright (c) 2023 Victoriya V. Forsythe
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Source, https://github.com/victoriyaforsythe/PyIRTAM
Keywords: ionosphere,modeling,modelling
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pyiri
Requires-Dist: requests
Provides-Extra: test
Requires-Dist: coveralls; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: flake8-docstrings; extra == "test"
Requires-Dist: hacking>=1.0; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-ordering; extra == "test"
Provides-Extra: doc
Requires-Dist: extras_require; extra == "doc"
Requires-Dist: ipython; extra == "doc"
Requires-Dist: m2r2; extra == "doc"
Requires-Dist: numpydoc; extra == "doc"
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx_rtd_theme<2.0.0,>=1.2.2; extra == "doc"
Dynamic: license-file

<img width="200" height="200" src="https://raw.githubusercontent.com/victoriyaforsythe/PyIRTAM/main/docs/figures/PyIRTAM_logo.png" alt="Black circle with PyIRTAM logo of two snakes marking the data-influenced EIA" title="PyIRTAM Logo" style="float:left;">

# PyIRTAM

[![PyPI Package latest release](https://img.shields.io/pypi/v/PyIRTAM.svg)](https://pypi.org/project/PyIRTAM/)
[![Build Status](https://github.com/victoriyaforsythe/PyIRTAM/actions/workflows/main.yml/badge.svg)](https://github.com/victoriyaforsythe/PyIRTAM/actions/workflows/main.yml)
[![Coverage Status](https://coveralls.io/repos/github/victoriyaforsythe/PyIRTAM/badge.svg?branch=main)](https://coveralls.io/github/victoriyaforsythe/PyIRTAM?branch=main)
[![Documentation Status](https://readthedocs.org/projects/pyirtam/badge/?version=latest)](https://pyirtam.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10844521.svg)](https://doi.org/10.5281/zenodo.10844521)

Python tool for processing IRTAM coefficients that evaluates ionospheric
parameters and electron density on the entire given global grid and for the
entire day simultaneously.


## Installation

Install from PyPI:

```bash
pip install PyIRTAM
```

Or clone and install from the GitHub repository:

```bash
git clone https://github.com/victoriyaforsythe/PyIRTAM.git
cd PyIRTAM
pip install .
```

For more details and usage examples, see the Jupyter [tutorials](https://github.com/victoriyaforsythe/PyIRTAM/tree/main/docs/tutorials).

---

## Example: Daily Ionospheric Parameters (I have IRTAM coefficients)

PyIRTAM computes daily ionospheric parameters with 15-min resolution IRTAM coefficietns.
The user provides the F10.7 index for the day of interest, the **alon** and **alat** grid,
the vertical grid **aalt**, and the time array of interest **ahr**.

Define the F10.7 index in solar flux units (sfu):

```python
F107 = 90.8
```

Define day of interest:

```python
year = 2022
month = 1
day = 1
```

Run PyIRTAM (coefficients need to be placed in irtam_dir):

```python
(f2_iri, f1_iri, e_iri, es_iri, sun, mag, edp_iri, f2_irtam, f1_irtam,
e_irtam, es_irtam, edp_irtam) = PyIRTAM.run_PyIRTAM(year, month, day, ahr,
                                                    alon, alat, aalt, f107,
                                                    irtam_dir=irtam_dir,
                                                    use_subdirs=True,
                                                    download=False)
```

<div align="center">
  <img src="docs/figures/PyIRTAM_NmF2.png" width="45%">
  <img src="docs/figures/PyIRTAM_hmF2.png" width="45%">
</div>

In case you need to download the coefficients use True in the download input.

## Tutorials

Tutorials with Notebooks are available [tutorials](https://github.com/victoriyaforsythe/PyIRTAM/tree/main/docs/tutorials)
