s111

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

Overview

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

  • Create and modify S-111 compliant HDF5 files in all four data coding formats:

1.  Time-series at fixed station
2.  Regularly-gridded arrays
3.  Ungeorectified gridded arrays (i.e. irregular grid)
4.  Time series for moving platform

Example Usage

Create an S-111 DCF2 File:

import numpy
import datetime
from s100py import s111
speed = numpy.array([[0.34, 0.35, 0.35, 0.36, 0.37, 0.39, 0.4 , 0.4 , 0.4 , 0.39, 0.39,
                    0.4 , 0.41, 0.41, 0.42, 0.43, 0.43, 0.44, 0.44, 0.45, 0.46, 0.47,
                    0.48, 0.49, 0.49, 0.49, 0.5 , 0.51, 0.51, 0.52, 0.52, 0.52, 0.53,
                    0.53, 0.54, 0.54, 0.55, 0.56, 0.57, 0.58, 0.58, 0.59, 0.59, 0.59,
                    0.59, 0.6 , 0.61, 0.62, 0.63, 0.64, 0.64, 0.65, 0.66, 0.66]])

direction = numpy.array([[189.1, 188.6, 188.1, 188.8, 189.7, 190.6, 191.5, 192. , 192.3,
                        192.6, 192.9, 192.8, 192.9, 193.1, 193.4, 193.5, 193.4, 193.6,
                        193.6, 193.8, 193.9, 193.8, 193.6, 193.4, 193.1, 193. , 192.9,
                        192.8, 192.7, 192.9, 193.1, 193.3, 193.6, 193.7, 194.1, 194.6,
                        195. , 195.4, 195.7, 195.8, 195.7, 195.4, 195.1, 194.8, 194.5,
                        194.3, 194.1, 194.0, 194.0, 194.0, 194.1, 194.1, 194.1, 194.2]])

grid_properties = {
        'maxx': -75.30278,
        'minx': -75.59722,
        'miny': 37.202778,
        'maxy': 37.497223,
        'cellsize_x': 0.005554199,
        'cellsize_y': 0.005558014,
        'nx': 54,
        'ny': 1
}

# Example metadata
metadata = {
    'horizontalDatumReference': 'EPSG',
    'horizontalDatumValue': 4326,
    'metadata': f'MD_test_s111.XML',
    'epoch': 'G1762',
    'geographicIdentifier': 'Region',
    'speedUncertainty': -1.0, # Default or Unknown values
    'directionUncertainty': -1.0, # Default or Unknown values
    'verticalUncertainty': -1.0, # Default or Unknown values
    'horizontalPositionUncertainty': -1.0, # Default or Unknown values
    'timeUncertainty': -1.0, # Default or Unknown values
    'surfaceCurrentDepth': 0,
    'depthTypeIndex': 2, 'Sea surface'
    'commonPointRule': 3, # 'high'
    'interpolationType': 10, #'discrete'
    'typeOfCurrentData': 6, # Hydrodynamic model forecast (F)
    'methodCurrentsProduct': 'ROMS_Hydrodynamic_Model_Forecasts',
    'datetimeOfFirstRecord': '20210107T130000Z'

}

datetime_value = datetime.datetime(2021, 1, 7, 12, 0, 0)

data_coding_format = 2

update_meta = {
        'dateTimeOfLastRecord': '20210107T130000Z',
        'numberOfGroups': 1,
        'numberOfTimes': 1,
        'timeRecordInterval': 0,
        'num_instances': 1
    }

data_file = s111.utils.create_s111("test_s111.h5")

s111.utils.add_metadata(metadata, data_file)
s111.utils.add_data_from_arrays(speed, direction, data_file, grid_properties, datetime_value, data_coding_format)
s111.utils.update_metadata(data_file, grid_properties, update_meta)

s111.utils.write_data_file(data_file)

Authors

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.

S111 Module Docs