Metadata-Version: 2.4
Name: gempakIO
Version: 1.4.4
Summary: Read GEMPAK data with pure Python.
Author-email: Nathan Wendt <nathan.wendt@noaa.gov>
License: BSD 3-Clause License
        
        Copyright (c) 2026, Nathan Wendt
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: homepage, https://github.com/nawendt/gempakio
Project-URL: repository, https://github.com/nawendt/gempakio
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pyproj
Requires-Dist: xarray
Provides-Extra: lint
Requires-Dist: ruff; extra == "lint"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Dynamic: license-file

# gempakIO

gempakIO is a pure-Python package that will read and write GEMPAK grid, sounding, and surface data. Because Python is platform independent, this brings the ability to read GEMPAK data in Windows much more easily.

### How It Works
gempakIO uses three decoding classes (`GempakGrid`, `GempakSounding`, and `GempakSurface`) to read each respective data type. Three other classes (`GridFile`, `SoundingFile`, and `SurfaceFile`) are used to write GEMPAK data. Because of how the code is structured, data from the GEMPAK files is lazily loaded. You only do I/O on the data that you select and avoid as much unnecessary loading as possible. For more information on reading data, see the documentation for the `GempakGrid.gdxarray`, `GempakSounding.snxarray`, `GempakSurface.sfjson` methods. More information about writing data can be found in the documentationn for `GridFile.to_gempak`, `SoundingFile.to_gempak`, and `SurfaceFile.to_gempak`. There is a notebook with examples in it to help you get started.

### Things Not Currently Implemented
*  GEMPAK grids can be packed using GRIB2 compression. These files cannot be decoded yet, but plans are in place to add that functionality.
*  GEMPAK grids packed with the NMC method cannot be read. I have not found a file to test in the wild so this may not get added.
*  GEMPAK had conversion methods for floating point number representations (e.g., IBM, IEEE, etc.). This package assumes IEEE. As it is relatively unlikely that there are much data not using IEEE floats, there is no plan to add conversions from other formats unless the need arises.
*  GEMPAK sounding and surface files can have their parameter data packed/compressed, but this is not currently implemented. GEMPAK grids do have basic GRIB packing by default, but GRIB2 packing is not implemented at this time.
