s100py

Python API and Utilities for Working with IHO S-100 HDF5 Data Formats

Overview

This python package provides utilities for encoding hydrographic datasets in the International Hydrographic Organization (IHO) S-100 HDF5 format.

Background

The IHO S-100 standard is a data framework for digital products and services for hydrographic, maritime, and GIS communities, comprised of multiple data encoding formats designed for interoperability with Electronic Navigational Charts (ENCs).

This package includes the following S-100 encoding formats:

• S-102 Bathymetric Surface
• S-104 Water Level Information for Surface Navigation
• S-111 Water Currents for Surface Navigation

However, support for additional formats as they become available will be added in the future. For further information about S-100 formats, see the IHO website.

Create S100 Products

• Follow S-102 examples to create an S-102 File
• Follow S-104 examples to create an S-104 File
• Follow S-111 examples to create an S-111 File

For S100 API Developers

• Extending the API
• Example API
• Using Example API
• Advanced Example API Usage

Requirements

This codebase is written for Python 3 and relies on the following python packages:

• h5py
• numpy
• gdal

Installation

This package requires the GDAL Python bindings be present, so it usually can't just be installed using pip install gdal. We recommend installing GDAL either through a package manager (e.g. conda, apt, yum, pacman) or by compiling from scratch. Miniconda is probably the easiest method.

Once gdal has been installed, s100py can be installed using pip:

pip install s100py

Release Notes

Version 1.0.0-rc.1 (2021-02-11)

• This is a major release, which inclues a new API that encapsulates the data specifications to allow introspection with Python to determine what data is available or should be and what data types would be acceptable. Convenience utilities are available to convert data into S102/S104/S111 so detailed knowledge of the S100 specs and APIs is not required in most cases
• Support for s102 (bathymetry) and s104 (water levels) has been added
• A consistent API for S100 data structures was added and is used to encode S102, S104, and S111
• The previous S111 library has been migrated to this general S100 API and therefore any code written against the previous s100py library will no longer work
• Examples of using the new S111 API are available here

Authors

• Barry Gallagher (NOAA), barry.gallagher@noaa.gov
• Erin Nagel (UCAR), erin.nagel@noaa.gov
• Glen Rice (NOAA), glen.rice@noaa.gov
• Jason Greenlaw

License

This work, as a whole, falls under Creative Commons Zero (see LICENSE).

Disclaimer

This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an 'as is' basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.