# 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:
```
from wam_api import WAMInterpolator
foo = WAMInterpolator()
dt = foo.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)
```
# 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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "swpc-wamipe",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Atheesh Thirumalairajan, Nand Vinchhi, Samai Patel, Gili Gordiyenko, Anusha Iyer, Varun Kota, Arav Luthra, Scott Chen",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d1/56/550176be5af30fcd5793e5a31e40df41aca7048e08738ccdb951cff5a929/swpc_wamipe-0.0.2.tar.gz",
"platform": null,
"description": "# Project Overview\nThis software package is a collaboration between the [National Oceanic and Atmospheric Administration Space Weather Prediction Center (NOAA SWPC)](https://www.swpc.noaa.gov/)\nand [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. \n\n# Prerequisites\nInstallation of latest package versions of netCDF4, numpy, scipy, and requests. \n\n# Usage\nTo install the package, open the terminal of a code editor and run the following command. <br>\n **Update this command after each package version change to keep documentation up to date.**\n```\npip install swpc-wamipe\n```\n\nTo print a density value run the following code:\n```\nfrom wam_api import WAMInterpolator\nfoo = WAMInterpolator() \ndt = foo.datetime(2024, 5, 11, 18, 12, 22)\nlat, lon, alt = -33.4, -153.24, 550.68 # degrees north, degrees east, km\nmy_density = foo.get_density(dt, lat, lon, alt)\nprint(my_density)\n```\n\n# Updating the package version\n\nTo update the package version on PyPI from local with any changes you have made to the project, \nfirst change the version number\nin ```pyproject.toml```. \n\nNext, \nrun the following commands in order:\n```\npython -m build \n```\n```\npython -m twine upload dist/*\n```\n\nTo update the local version, run:\n```\npip install swpc-wamipe --upgrade\n```",
"bugtrack_url": null,
"license": null,
"summary": "Provides simple APIs to calculate neutral density values using the NOAA Whole Atmosphere Model-Ionosphere Plasmasphere Electrodynamics (WAM-IPE) model",
"version": "0.0.2",
"project_urls": {
"App Dev Club LLC": "https://appdevclub.com",
"NOAA SWCC Website": "https://www.swpc.noaa.gov/",
"NOAA WAM-IPE Model": "https://www.swpc.noaa.gov/products/wam-ipe"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "107b8c218fd6a2fb5576b4636de871cfe78322b809dba4c17fa0991e02e0ca82",
"md5": "948e7d45c31ffe49e700ba3e31be6f9d",
"sha256": "e7f6ce8720fb85a1d3b991900800806cf85dc8cc9471c5232afe8a31e060408b"
},
"downloads": -1,
"filename": "swpc_wamipe-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "948e7d45c31ffe49e700ba3e31be6f9d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7036,
"upload_time": "2024-10-21T00:50:44",
"upload_time_iso_8601": "2024-10-21T00:50:44.344652Z",
"url": "https://files.pythonhosted.org/packages/10/7b/8c218fd6a2fb5576b4636de871cfe78322b809dba4c17fa0991e02e0ca82/swpc_wamipe-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d156550176be5af30fcd5793e5a31e40df41aca7048e08738ccdb951cff5a929",
"md5": "3b481b7d7b7d091470a14c09f4ad7433",
"sha256": "b90670b7f68917cd79b1c271b61511c18a60b3ae7e70f7ab1449c669daf008b9"
},
"downloads": -1,
"filename": "swpc_wamipe-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "3b481b7d7b7d091470a14c09f4ad7433",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8116,
"upload_time": "2024-10-21T00:50:45",
"upload_time_iso_8601": "2024-10-21T00:50:45.322382Z",
"url": "https://files.pythonhosted.org/packages/d1/56/550176be5af30fcd5793e5a31e40df41aca7048e08738ccdb951cff5a929/swpc_wamipe-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 00:50:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "swpc-wamipe"
}
JSON