Skip to content

Commit

Permalink
Update README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
nawendt committed Oct 2, 2023
1 parent e98c01f commit a0bac1e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2022, Nathan Wendt
Copyright (c) 2023, Nathan Wendt
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# gempakIO

gempakIO is a pure-Python package that will read and decode GEMPAK grid, sounding, and surface data. Because Python is platform independent, this brings the ability to read GEMPAK data in Windows much more easily.
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 classes (`GempakGrid`, `GempakSounding`, and `GempakSurface`) to read each respective data type. The package uses the same logic to decode and unpack the binary into data that you can use. 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, see the `GempakGrid.gdxarray`, `GempakSounding.snxarray`, `GempakSurface.sfjson` methods and check out the notebook with examples in it.
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.

### Things Implemented With Limited Testing
* Climate surface file type (see [GEMPAK Surface Library](https://github.com/Unidata/gempak/blob/master/gempak/txt/gemlib/sflib.txt) documentation). This is another situation where I have no files to test.

0 comments on commit a0bac1e

Please sign in to comment.