# simple_NOAA
Welcome to simple_NOAA, a Python package for accessing weather data from the National Oceanic and Atmospheric Administration (NOAA) through their API. The package includes a dataframe of station metadata, which can be used to request weather data based on location and time.
# Dependencies
- import pandas
- import io
- import request
- from shapely.geometry import Point, Polygon
# Usage
The package includes the following functionalities:
- stations_frame: A dataframe of station data from NOAA, this enables stations_in_region
- stations_in_region(lat, lon, num_closest, radius): Returns a list of the num_closest stations within radius kilometers of the point created by lat and lon, enables searching
- yearly_request(search_type, station_list, year1, year2): Returns a dataframe of global-summary-of-the-year datasets for the requested stations
- monthly_request(search_type, station_list, year1, year2): Returns a dataframe of global-summary-of-the-month datasets for the requested stations
- daily_request(search_type, station_list, year1, year2): Returns a dataframe of daily-summaries datasets for the requested stations
Examples and testing of the package's functionality can be found in the testing.ipynb file.
# Contribution
If you're interested in contributing to the development of the library, please reach out to me at devinrshaw@gmail.com. We welcome bug reports and feature requests.
# License
This package is released under a open-source license. Please refer to the license file for any restrictions on its use.
# Contact
Creator: devinrshaw@gmail.com
# References
Metadata on NOAA stations: https://www.ncei.noaa.gov/access/homr/reports/mshr
NOAA dataset API user documentation: https://www.ncei.noaa.gov/support/access-data-service-api-user-documentation
NOAA datasets explained: https://www.ncdc.noaa.gov/cdo-web/datasets
Explanation of dataset labels: https://www.ncei.noaa.gov/pub/data/metadata/documents/
# FAQs
- What is the package's main purpose?
simple_NOAA is a Python package that provides an easy-to-use interface for accessing weather data from the National Oceanic and Atmospheric Administration (NOAA) through their API.
- What kind of weather data can I request?
You can request global-summary-of-the-year, global-summary-of-the-month, and daily-summaries datasets for specific stations.
- How do I find the stations I want to request data for?
You can use the stations_in_region function to find stations within a certain radius of a given latitude and longitude. Alternatively you can create you own functions using the dataframe staions_frame upon simple_NOAA creation.
- Is there a limit on how much data I can request?
The NOAA API has usage limits, please refer to their API documentation for more information.
Please let me know if you have any other question.
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/mypackage",
"name": "simple-NOAA",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "NOAA Climate Data",
"author": "Devin Shaw",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/ea/f2/492b37f222776e63b2e04270dca031f2419e5fda05a6a2c84dc1d184e324/simple_NOAA-0.1.tar.gz",
"platform": null,
"description": "# simple_NOAA\n\nWelcome to simple_NOAA, a Python package for accessing weather data from the National Oceanic and Atmospheric Administration (NOAA) through their API. The package includes a dataframe of station metadata, which can be used to request weather data based on location and time.\n\n# Dependencies\n- import pandas\n- import io\n- import request\n- from shapely.geometry import Point, Polygon\n# Usage\nThe package includes the following functionalities:\n\n- stations_frame: A dataframe of station data from NOAA, this enables stations_in_region\n- stations_in_region(lat, lon, num_closest, radius): Returns a list of the num_closest stations within radius kilometers of the point created by lat and lon, enables searching \n- yearly_request(search_type, station_list, year1, year2): Returns a dataframe of global-summary-of-the-year datasets for the requested stations\n- monthly_request(search_type, station_list, year1, year2): Returns a dataframe of global-summary-of-the-month datasets for the requested stations\n- daily_request(search_type, station_list, year1, year2): Returns a dataframe of daily-summaries datasets for the requested stations\nExamples and testing of the package's functionality can be found in the testing.ipynb file.\n\n# Contribution\nIf you're interested in contributing to the development of the library, please reach out to me at devinrshaw@gmail.com. We welcome bug reports and feature requests.\n\n# License\nThis package is released under a open-source license. Please refer to the license file for any restrictions on its use.\n\n# Contact\nCreator: devinrshaw@gmail.com\n\n# References\nMetadata on NOAA stations: https://www.ncei.noaa.gov/access/homr/reports/mshr\nNOAA dataset API user documentation: https://www.ncei.noaa.gov/support/access-data-service-api-user-documentation\nNOAA datasets explained: https://www.ncdc.noaa.gov/cdo-web/datasets\nExplanation of dataset labels: https://www.ncei.noaa.gov/pub/data/metadata/documents/\n# FAQs\n- What is the package's main purpose?\n\nsimple_NOAA is a Python package that provides an easy-to-use interface for accessing weather data from the National Oceanic and Atmospheric Administration (NOAA) through their API.\n\n- What kind of weather data can I request?\n\nYou can request global-summary-of-the-year, global-summary-of-the-month, and daily-summaries datasets for specific stations.\n\n- How do I find the stations I want to request data for?\n\nYou can use the stations_in_region function to find stations within a certain radius of a given latitude and longitude. Alternatively you can create you own functions using the dataframe staions_frame upon simple_NOAA creation.\n\n- Is there a limit on how much data I can request?\n\nThe NOAA API has usage limits, please refer to their API documentation for more information.\nPlease let me know if you have any other question.\n",
"bugtrack_url": null,
"license": "",
"summary": "simple_NOAA allows for streamlined access to NOAA datasets",
"version": "0.1",
"split_keywords": [
"noaa",
"climate",
"data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b27ac273e8735f831625b02c64e98ba981490972572df59aaa9e7788e329887",
"md5": "790f31b031013b066d4fc52015043325",
"sha256": "0165c26813992c2fac9191ee7ea369938e3fa55812681b61b28ab94b3d359b0f"
},
"downloads": -1,
"filename": "simple_NOAA-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "790f31b031013b066d4fc52015043325",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4159,
"upload_time": "2023-01-29T22:12:00",
"upload_time_iso_8601": "2023-01-29T22:12:00.053836Z",
"url": "https://files.pythonhosted.org/packages/4b/27/ac273e8735f831625b02c64e98ba981490972572df59aaa9e7788e329887/simple_NOAA-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eaf2492b37f222776e63b2e04270dca031f2419e5fda05a6a2c84dc1d184e324",
"md5": "2182a3e0342c0a69fe21bcd4836689fc",
"sha256": "b6ba24af36dec625a9e6f77daaf86b1e4a8673c727395372c160fd72eb2ebb26"
},
"downloads": -1,
"filename": "simple_NOAA-0.1.tar.gz",
"has_sig": false,
"md5_digest": "2182a3e0342c0a69fe21bcd4836689fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3966,
"upload_time": "2023-01-29T22:12:01",
"upload_time_iso_8601": "2023-01-29T22:12:01.901389Z",
"url": "https://files.pythonhosted.org/packages/ea/f2/492b37f222776e63b2e04270dca031f2419e5fda05a6a2c84dc1d184e324/simple_NOAA-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-29 22:12:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "yourusername",
"github_project": "mypackage",
"lcname": "simple-noaa"
}
JSON
