Metadata-Version: 2.3
Name: swpc-wamipe
Version: 0.0.3
Summary: Provides simple APIs to calculate neutral density values using the NOAA Whole Atmosphere Model-Ionosphere Plasmasphere Electrodynamics (WAM-IPE) model
Project-URL: NOAA SWCC Website, https://www.swpc.noaa.gov/
Project-URL: NOAA WAM-IPE Model, https://www.swpc.noaa.gov/products/wam-ipe
Project-URL: App Dev Club LLC, https://appdevclub.com
Author: Atheesh Thirumalairajan, Nand Vinchhi, Samai Patel, Gili Gordiyenko, Anusha Iyer, Varun Kota, Arav Luthra, Scott Chen
License-File: LICENSE
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: netcdf4
Requires-Dist: numpy
Requires-Dist: requests
Requires-Dist: scipy
Description-Content-Type: text/markdown

# Project Overview

This software package is a collaboration between the [National Oceanic and Atmospheric Administration Space Weather Prediction Center (NOAA SWPC)](https://www.swpc.noaa.gov/)
and [App Dev Club LLC](https://appdevclub.com) at the University of Maryland. Using [outputs](https://noaa-nws-wam-ipe-pds.s3.amazonaws.com/index.html) from the Whole Atmosphere Model-Ionosphere Plasmasphere Electrodynamics (WAM-IPE) model, it allows users to input date, time, and satellite location (longitude + latitude) and output the neutral density value near the satellite at that date and time.

# Prerequisites

Installation of latest package versions of netCDF4, numpy, scipy, and requests.

# Usage

To install the package, open the terminal of a code editor and run the following command. <br>
**Update this command after each package version change to keep documentation up to date.**

```
pip install swpc-wamipe
```

To print a density value run the following code:

```py
from wam_api import WAMInterpolator
from datetime import datetime
foo = WAMInterpolator()
dt = datetime(2024, 5, 11, 18, 12, 22)
lat, lon, alt = -33.4, -153.24, 550.68  # degrees north, degrees east, km
my_density = foo.get_density(dt, lat, lon, alt)
print(my_density)
```

To get densities for an array of datetimes, run the following code:

```py
from wam_api import WAMInterpolator
from datetime import datetime, timedelta
foo = WAMInterpolator()
dt = datetime(2024, 5, 11, 18, 12, 22)
lat, lon, alt = -33.4, -153.24, 550.68  # degrees north, degrees east, km
dt_array = [dt + timedelta(minutes=10*i) for i in range(10)]
my_densities = foo.get_density_batch(dt_array, [lat] * 10, [lon] * 10, [alt] * 10)
print(my_densities)
```

# Updating the package version

To update the package version on PyPI from local with any changes you have made to the project,
first change the version number
in `pyproject.toml`.

Next,
run the following commands in order:

```
python -m build
```

```
python -m twine upload dist/*
```

To update the local version, run:

```
pip install swpc-wamipe --upgrade
```
