wxdata 1.5__tar.gz → 1.6__tar.gz

{wxdata-1.5 → wxdata-1.6}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: wxdata
-Version: 1.5
-Summary: A Python library that acts as a client to download, pre-process and post-process weather data. Friendly for users on VPN/PROXY connections.
+Version: 1.6
+Summary: A Python package of end-to-end weather data clients & raw data clients with VPN/PROXY support, data processors that decode variable keys from GRIB format into a plain-language format & various tools for assisting Python automated workflows, querying meteorological datasets and filling gaps in meteorological data.
 Author: Eric J. Drewitz
 Project-URL: Documentation, https://github.com/edrewitz/wxdata/blob/main/Documentation/Landing%20Page.md
 Project-URL: Repository, https://github.com/edrewitz/wxdata/tree/main
@@ -13,19 +13,21 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: metpy>=1.5.1
-Requires-Dist: numpy>=1.24
-Requires-Dist: pandas>=2.2
-Requires-Dist: xarray>=2023.1.0
-Requires-Dist: netcdf4>=1.7.1
-Requires-Dist: shapeography>=1.0
-Requires-Dist: beautifulsoup4>=4.13.4
-Requires-Dist: requests>=2.32.4
-Requires-Dist: cfgrib>=0.9.10.4
-Requires-Dist: dask>=2025.5.1
+Requires-Dist: metpy>=1.7.1
+Requires-Dist: numpy>=2.2.6
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: cartopy>=0.25.0
+Requires-Dist: xarray>=2025.6.1
+Requires-Dist: netcdf4>=1.7.3
+Requires-Dist: shapeography>=1.2
+Requires-Dist: beautifulsoup4>=4.14.3
+Requires-Dist: requests>=2.32.5
+Requires-Dist: cfgrib>=0.9.15.1
+Requires-Dist: dask>=2025.11.0
 Requires-Dist: tqdm>=4.67.3
 Requires-Dist: ecmwf-opendata>=0.3.26
 Requires-Dist: openpyxl>=3.1.5
+Requires-Dist: arm-pyart>=2.2.0
 Dynamic: license-file
 
 # WxData
@@ -51,11 +53,26 @@ PIP Downloads:
 
 **(C) Eric J. Drewitz 2025-2026**
 
-An open-source package that helps meteorologists and weather enthusiats download, pre-process and post-process various types of weather data. 
+A Python package consisting of the following:
 
-This package only retrieves open-source publicly available weather data. 
+1) End-to-end weather data clients with VPN/PROXY support
+2) Raw data clients with VPN/PROXY support
+3) Data processors that decode variable keys from GRIB format into a plain-language format
+4) Various tools for assisting Python automated workflows, querying meteorological datasets and filling gaps in meteorological data.
 
-This package provides the following extra functionality compared to existing packages for downloading weather data:
+# Table of Contents
+
+1) [Installation Instructions](https://github.com/edrewitz/WxData?tab=readme-ov-file#installation-instructions)
+2) [Proxy Server Configuration](https://github.com/edrewitz/WxData?tab=readme-ov-file#proxy-server-configuration)
+3) [What makes WxData unique among various meteorological Python packages?](https://github.com/edrewitz/WxData?tab=readme-ov-file#what-makes-wxdata-unique-among-various-meteorological-python-packages)
+4) [WxData Tutorials](https://github.com/edrewitz/WxData?tab=readme-ov-file#wxdata-tutorials)
+5) [WxData Documentation](https://github.com/edrewitz/WxData?tab=readme-ov-file#wxdata-documentation)
+6) [Importing Functions from WxData](https://github.com/edrewitz/WxData?tab=readme-ov-file#importing-functions-from-wxdata)
+7) [Citations](https://github.com/edrewitz/WxData?tab=readme-ov-file#citations)
+8) [Data Sources](https://github.com/edrewitz/WxData?tab=readme-ov-file#data-sources)
+
+
+## Installation Instructions
 
 **How To Install**
 
@@ -97,19 +114,23 @@ i) Install wxdata via Anaconda/Miniconda3 --> `conda install wxdata`
 
 ii) Set up a new environment with an earlier version of Python (must be Python >= 3.10) and then `pip install wxdata`
 
+---------------------------------------------------------
+
+## Proxy Server Configuration
+
 ***Friendly for users working on VPN/PROXY connections***
 
    Depending on which client, the proxy-address:port must be entered as either a dictionary or a string.
 
    The clients that use a string for proxies are:
 
-   1) All ECMWF clients
+   1) All ECMWF clients.
 
-   2) METAR Observations Client
+   2) METAR Observations Client.
       
-   3) `pixel_query()` tool if the user needs to download the airport station codes list. 
+   3) `pixel_query()` tool if the user needs to download the airport station codes list.
 
-      All other clients use proxies as a dictionary
+   All other clients use proxies as a dictionary
 
                   Example: We want to download the latest Observed Sounding Data for San Diego, CA (NKX)
          
@@ -128,6 +149,10 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 
 
    For more information on configuring proxies: https://requests.readthedocs.io/en/latest/user/advanced/#proxies
+
+---------------------------------------------------------------------
+
+## What makes WxData unique among various meteorological Python packages?
        
 1) Converts GRIB variable keys into variable keys that are in plain language.
     - (e.g. 'r2' ---> '2m_relative_humidity')
@@ -143,7 +168,15 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
         - If a user wishes to not clear out their recycle bin `set clear_recycle_bin=False`.
         - Default: `clear_recycle_bin=False`.
     
-## WxData Examples
+4) Has built-in support for users on VPN/PROXY connections.
+
+5) Consists of both observational and model data.
+
+6) Has additional tools to assist querying data, resolving gaps in data and automating your Python workflow. 
+
+-----------------------------------------------
+    
+## WxData Tutorials
 
 *Regular Users*
 1) [Downloading METAR Data](https://github.com/edrewitz/WxData-JupyterLab-Examples/blob/main/metars.ipynb)
@@ -165,13 +198,28 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 17) [Downloading the 7-Day NFDRS Forecast for Acton RAWS and Plotting Forecast 100-HR Dead Fuel Moisture](https://github.com/edrewitz/WxData-JupyterLab-Examples/blob/main/acton_raws_forecast.ipynb)
 18) [Downloading Current RAWS and METAR Data and Plotting Current Relative Humidity Observations Across California and Nevada](https://github.com/edrewitz/WxData-JupyterLab-Examples/blob/main/metar_raws_observed_rh.ipynb)
 19) [Downloading Current RAWS Data and Plotting Current Energy Release Components (ERCs) Observations Across California and Nevada](https://github.com/edrewitz/WxData-JupyterLab-Examples/blob/main/observed_erc_map.ipynb)
+20) [Downloading NEXRAD II Radar Data and then plotting it in Py-ART](https://github.com/edrewitz/WxData-JupyterLab-Examples/blob/main/NEXRADII.ipynb)
+21) [Downloading 30 Days of 6hrly CFS Data and plotting the 30-Day time-mean for mean sea level pressure across the Northern Hemisphere](https://github.com/edrewitz/WxData-JupyterLab-Examples/blob/main/cfs.ipynb)
 
 *Advanced Users*
 1) [Using the `client` module to download the latest HadCRUT5 Analysis netCDF file and open this dataset in xarray](https://github.com/edrewitz/WxData-JupyterLab-Examples/blob/main/hadcrut5.ipynb)
 2) [Downloading the GFS0P25 for temperature fields and using run_external_scripts() to post-process this GFS0P25 dataset in an external Python script](https://github.com/edrewitz/WxData-JupyterLab-Examples/blob/main/external_scripts.ipynb)
 
+---------------------------------------------------
+
 ## WxData Documentation
 
+***Documentation Sections***
+
+1. [End-To-End Data Clients](https://github.com/edrewitz/WxData?tab=readme-ov-file#end-to-end-data-clients)
+2. [Raw Data Clients](https://github.com/edrewitz/WxData?tab=readme-ov-file#raw-data-clients)
+3. [Post-Processors](https://github.com/edrewitz/WxData?tab=readme-ov-file#post-processors)
+4. [Data Querying Tools](https://github.com/edrewitz/WxData?tab=readme-ov-file#data-querying-tools)
+5. [Data Transformation & Gap Filling Tools](https://github.com/edrewitz/WxData?tab=readme-ov-file#data-transformation--gap-filling-tools)
+6. [Automated Python Workflow Tools](https://github.com/edrewitz/WxData?tab=readme-ov-file#automated-python-workflow-tools)
+
+### End-To-End Data Clients
+
 ***Global Forecast System (GFS)***
 1. [GFS0P25](https://github.com/edrewitz/WxData/blob/main/Documentation/GFS0P25.md)
 2. [GFS0P25 SECONDARY PARAMETERS](https://github.com/edrewitz/WxData/blob/main/Documentation/GFS0P25%20Secondary%20Parameters.md)
@@ -180,6 +228,10 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 ***AI Global Forecast System (AIGFS)***
 1. [AIGFS](https://github.com/edrewitz/WxData/blob/main/Documentation/aigfs.md)
 
+***Climate Forecast System (CFS)***
+1. [CFS Pressure](https://github.com/edrewitz/WxData/blob/main/Documentation/cfs_pressure.md#climate-forecast-system-cfs-pressure)
+2. [CFS Flux](https://github.com/edrewitz/WxData/blob/main/Documentation/cfs_flux.md#climate-forecast-system-cfs-flux)
+
 ***Hybrid Global Ensemble Forecast System (HGEFS)***
 1. [HGEFS](https://github.com/edrewitz/WxData/blob/main/Documentation/hgefs.md#hybrid-global-ensemble-forecast-system-hgefs)
 
@@ -231,6 +283,14 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 ***Observed Atmospheric Soundings***
 1. [University Of Wyoming Soundings](https://github.com/edrewitz/wxdata/blob/main/Documentation/wyoming_soundings.md)
 
+***NEXRAD II Radar Data***
+1. [Single Site](https://github.com/edrewitz/WxData/blob/main/Documentation/nexrad2_single.md#nexrad-ii-single-radar)
+2. [Multi-Site](https://github.com/edrewitz/WxData/blob/main/Documentation/nexrad2_multi.md#nexrad-ii-multi-radar)
+
+-----------------------------
+
+### Post-Processors
+
 ***GFS Post-Processing***
 1. [Primary GFS Post-Processing](https://github.com/edrewitz/WxData/blob/main/Documentation/Primary%20GFS%20Post%20Processing.md)
 2. [Secondary GFS Post-Processing](https://github.com/edrewitz/WxData/blob/main/Documentation/Secondary%20GFS%20Post%20Processing.md)
@@ -238,6 +298,10 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 ***AIGFS Post-Processing***
 1. [AIGFS Post-Processing](https://github.com/edrewitz/WxData/blob/main/Documentation/aigfs_post_processing.md)
 
+***CFS Post-Processing***
+1. [CFS Pressure Post-Processing](https://github.com/edrewitz/WxData/blob/main/Documentation/cfs_pressure_post_processing.md#climate-forecast-system-cfs-pressure-post-processing)
+2. [CFS Flux Post-Processing](https://github.com/edrewitz/WxData/blob/main/Documentation/cfs_flux_post_processing.md#climate-forecast-system-cfs-flux-post-processing)
+
 ***GEFS Post-Processing***
 1. [Primary GEFS Post-Processing](https://github.com/edrewitz/WxData/blob/main/Documentation/Primary%20GEFS%20Post-Processing.md)
 2. [Secondary GEFS Post-Processing](https://github.com/edrewitz/WxData/blob/main/Documentation/Secondary%20GEFS%20Post%20Processing.md)
@@ -257,6 +321,10 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 ***Real-Time Mesoscale Analysis Post-Processing***
 1. [RTMA](https://github.com/edrewitz/WxData/blob/main/Documentation/RTMA%20Post%20Processing.md)
 
+-----------------------------------------------
+
+### Raw Data Clients
+
 ***xmACIS2 Climate Data***
 1. [xmACIS2 Client](https://github.com/edrewitz/WxData/blob/main/Documentation/xmacis2_client.md)
 
@@ -269,11 +337,12 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 ***Custom Excel Data***
 1. [Excel Data Client](https://github.com/edrewitz/WxData/blob/main/Documentation/get_excel_data.md#get-excel-data)
 
-***Cyclic Points For Hemispheric Plots***
-1. [Cyclic Points](https://github.com/edrewitz/wxdata/blob/main/Documentation/cyclic_point.md#using-wxdata-to-add-cyclic-points-for-hemispheric-plots)
+***AWS Open Data***
+1. [AWS Open Data](https://github.com/edrewitz/WxData/blob/main/Documentation/get_open_aws_data.md#get-aws-open-data)
 
-***Shifting Longitude From 0 to 360 --> -180 to 180***
-1. [shift_longitude](https://github.com/edrewitz/WxData/blob/main/Documentation/shift_longitude.md)
+---------------------------------------------------------------
+
+### Data Querying Tools
 
 ***Pixel Query***
 1. [pixel_query](https://github.com/edrewitz/WxData/blob/main/Documentation/pixel_query.md)
@@ -281,13 +350,29 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 ***Line Query***
 1. [line_query](https://github.com/edrewitz/WxData/blob/main/Documentation/line_query.md)
 
+--------------------------------------------------
+
+### Data Transformation & Gap Filling Tools
+
+***Cyclic Points For Hemispheric Plots***
+1. [Cyclic Points](https://github.com/edrewitz/wxdata/blob/main/Documentation/cyclic_point.md#using-wxdata-to-add-cyclic-points-for-hemispheric-plots)
+
+***Shifting Longitude From 0 to 360 --> -180 to 180***
+1. [shift_longitude](https://github.com/edrewitz/WxData/blob/main/Documentation/shift_longitude.md)
+
 ***Linear Anti-Aliasing Between Two Points***
 1. [linear_anti_aliasing](https://github.com/edrewitz/WxData/blob/main/Documentation/linear_anti_aliasing.md#linear-anti-aliasing-between-points)
 
+------------------------------------------
+
+### Automated Python Workflow Tools
+
 ***Running External Python Scripts In Your Workflow***
 
 1 [run_external_scripts](https://github.com/edrewitz/WxData/blob/main/Documentation/run_external_scripts.md)
 
+---------------------------------------
+
 ## Importing Functions from WxData
 
       """
@@ -357,6 +442,14 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
           gefs_0p25
       )
       
+      # Climate Forecast System (CFS)
+      # - CFS Flux Products
+      # - CFS Pressure Products
+      from wxdata.cfs.cfs import(
+          cfs_flux,
+          cfs_pressure
+      )
+      
       # AI Global Ensemble Forecast System (AIGEFS)
       # - AIGEFS Pressure Members (Pressure Level Variables)
       # - AIGEFS Surface Members (Surface Level Variables)
@@ -396,7 +489,7 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
       # - Multi Station NFDRS Forecast
       # - Single Station Weather Forecast
       # - Multi Station Weather Forecast
-      from wxdata.fems.fems import(
+      from wxdata.fems.observations import(
           get_single_raws_station_weather_observations,
           get_single_raws_station_fuels_observations,
           get_multi_raws_station_weather_observations,
@@ -443,6 +536,14 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
       # METAR Observational Data (From NOAA)
       from wxdata.metars.metar_obs import download_metar_data
       
+      # NEXRAD2 Radar Data
+      # - NEXRAD2 Radar Single Station
+      # - NEXRAD2 Radar Multi Station
+      from wxdata.radar.nexrad2 import(
+          download_current_single_station_nexrad2_radar_data,
+          download_current_multi_station_nexrad2_radar_data
+      )
+      
       """
       This section hosts all the functions and modules that involve post-processing the data.
       These are the functions and modules that:
@@ -471,6 +572,9 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
       # European Centre for Medium-Range Weather Forecasts (ECMWF)
       import wxdata.post_processors.ecmwf_post_processing as ecmwf_post_processing
       
+      # Climate Forecast System (CFS)
+      import wxdata.post_processors.cfs_post_processing as cfs_post_processing
+      
       # Real-Time Mesoscale Analysis (RTMA)
       from wxdata.post_processors.rtma_post_processing import process_rtma_data
       
@@ -506,6 +610,9 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
           linear_anti_aliasing
       )
       
+      # This function executes a list of Python scripts in the order the user lists them
+      from wxdata.utils.scripts import run_external_scripts
+      
       """
       This section hosts the various data clients that retrieve various types of data.
       
@@ -516,12 +623,12 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
       # Client List:
       #  - get_gridded_data()
       #  - get_csv_data()
-      #  - get_excel_data() 
+      #  - get_excel_data()
       #  - get_xmacis_data()
+      #  - get_aws_open_data()
       import wxdata.client.client as client
-      
-      # This function executes a list of Python scripts in the order the user lists them
-      from wxdata.utils.scripts import run_external_scripts
+
+-------------------------------------------
 
 ## Citations
 
@@ -544,6 +651,8 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 
 **requests**: K. Reitz, "Requests: HTTP for Humans". Available: https://requests.readthedocs.io/.
 
+**Beautiful Soup**: Richardson, L. (2025). Beautiful Soup (Version 4.14.3) [Computer software]. https://www.crummy.com/software/BeautifulSoup/
+
 **shapeography**: Eric J. Drewitz. (2026). edrewitz/shapeography: shapeography 1.0 Released (shapeography1.0). Zenodo. https://doi.org/10.5281/zenodo.18676845
 
 **geopandas**: Kelsey Jordahl, Joris Van den Bossche, Martin Fleischmann, Jacob Wasserman, James McBride, Jeffrey Gerard, … François Leblanc. (2020, July 15). geopandas/geopandas: v0.8.1 (Version v0.8.1). Zenodo. http://doi.org/10.5281/zenodo.3946761
@@ -554,6 +663,10 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 
 **openpyxl**: Gazoni, E., & Clark, C. (2024). openpyxl: A Python library to read/write Excel 2010 xlsx/xlsm/xltx/xltm files (Version 3.1.5) [Computer software]. https://openpyxl.readthedocs.io/
 
+**pyart**: Helmus, J.J. & Collis, S.M., (2016). The Python ARM Radar Toolkit (Py-ART), a Library for Working with Weather Radar Data in the Python Programming Language. Journal of Open Research Software. 4(1), p.e25. DOI: 10.5334/jors.119.
+
+----------------------------------------------------------
+
 ## Data Sources
 
 1) [National Oceanic and Atmospheric Administration/National Center for Environmental Prediction](https://nomads.ncep.noaa.gov/)
@@ -564,5 +677,6 @@ ii) Set up a new environment with an earlier version of Python (must be Python >
 6) [National Oceanic and Atmospheric Administration/Climate Prediction Center](https://www.cpc.ncep.noaa.gov/products/GIS/GIS_DATA/us_tempprcpfcst/index.php)
 7) [Applied Climate Information System (ACIS)](https://www.rcc-acis.org/docs_webservices.html)
 8) [USDA Fire Environment Mapping System](https://fems.fs2c.usda.gov/download)
+9) [Amazon AWS Unidata NEXRAD2 Bucket](https://unidata-nexrad-level2.s3.amazonaws.com/index.html)