Older versions of S104

Version 1.0

s100py.s104.v1_0.utils Module

Functions to create S104 files and populate with data from other sources

Functions

add_data_from_arrays(height, trend, ...)

Updates an S104File object based on numpy array/h5py datasets.

add_metadata(metadata, data_file)

Updates an S104File object based on input metadata.

create_s104(output_file, dcf)

Creates or updates an S104File object.

update_metadata(data_file, grid_properties, ...)

Updates an S104File object based on dynamic metadata.

write_data_file(data_file)

Writes file structure, metadata, data and closes S104File object.

s100py.s104.v1_0.api Module

S-104 Edition 1.0 utilized features from both S100 Edition 4.0 and 5.0, the Edition 5.0 S100 root object was copied and extended to support Edition 4.0 chunking attributes

Classes

DiscoveryMetadata(*args, **kwargs)

12.2.6 of v1.0.1

Enum(value[, names, module, qualname, type, ...])

Create a collection of name/value pairs.

FeatureContainerDCF2(*args, **opts)

Container for Data Coding Format 2

FeatureContainerDCF3(*args, **opts)

Container for Data Coding Format 3

FeatureInformation([recursively_create_children])

In S100, table 10c-8.

FeatureInformationDataset(*args, **opts)

This class comes from S100 -- 10c-9.5 Feature information group.

FeatureInstanceDCF2([...])

Data Coding Format 2 is the grid format from table 10c-12 in S100 spec.

FeatureInstanceDCF3([...])

Data Coding Format 3 is the Ungeorectified grid format from table 10c-12 in S100 spec.

GeographicBoundingBox([...])

S100 Tables 10C-6 and 10c-12 see also 4.2.1.1.13 of S102 v2.0.0 The class EX_GeographicBoundingBox is a metadata class from ISO 19115.

GroupF([recursively_create_children])

From S100 Table 10c-8 – Components of feature information group

GroupFBase([recursively_create_children])

From S100 Table 10c-8 – Components of feature information group

HORIZONTAL_CS(value[, names, module, ...])

IntEnum(value[, names, module, qualname, ...])

Enum where members are also (and must be) ints

PROJECTION_METHOD

alias of PROJECTION_METHODS

S100Exception

S100File(*args, **kywrds)

S100Root([recursively_create_children])

From table 10c-6 in S100 v4.0 spec.

S104Exception

Raised when input is not S104 compliant

S104File(*args, **kywrds)

HDF5 file object

S104MetadataListBase(*args, **opts)

Define group name format

S104Root([recursively_create_children])

The root group contains a feature information group and N feature containers.

S1XXFile(name, *args, **kywrds)

hdf5 files have primary creation methods of create_dataset to insert array data attrs a dictionary-like to add/read metadata about the current group create_group to make a group containing datasets and/or metadata

S1xxCollection(*args, **opts)

This class represents arrays (noted in UML as , 1.., 0..* etc) which is not really part of HDF5.

S1xxDatasetBase(*args, **opts)

The S102 spec stores some things as datasets that could (or should) be stored as attributes.

S1xxGridsBase([recursively_create_children])

This base class is intended for use with "values" groups.

S1xxObject([recursively_create_children])

This class implements a general hdf5 group object that has attributes, datasets or sub-groups.

TYPE_OF_HORIZONTAL_CRS(value[, names, ...])

TYPE_OF_WATER_LEVEL_DATA(value[, names, ...])

VERTICAL_COORDINATE_BASE(value[, names, ...])

VERTICAL_CS(value[, names, module, ...])

VERTICAL_DATUM(value[, names, module, ...])

Note: while a Vertical Datum can be created with the shorthand aliases, ex: MLWS, the string written and returned from the file/S100 object will be the official long name, e.g. "meanLowWaterSprings" etc.

VERTICAL_DATUM_REFERENCE(value[, names, ...])

WaterLevelContainerBase()

This is the WaterLevel right off the root of the HDF5 which has possible attributes from S100 spec table 10c-10 This will hold child groups named WaterLevel.NN

WaterLevelContainerDCF2(*args, **opts)

WaterLevelContainerDCF3(*args, **opts)

WaterLevelFeatureDataset(*args, **opts)

Create group_f feature dataset

WaterLevelFeatureInstanceBase()

Basic template for the name of the attribute will be automatically determined based on the array position of the S104_MetadataList

WaterLevelFeatureInstanceDCF2([...])

WaterLevelFeatureInstanceDCF3([...])

WaterLevelGroup([recursively_create_children])

WaterLevelGroupList(*args, **opts)

This is the list of Group.NNN that are held as a list.

WaterLevelListBase(*args, **opts)

This is the set of WaterLevel.NN that act like a list here.

WaterLevelListDCF2(*args, **opts)

WaterLevelListDCF3(*args, **opts)

WaterLevelTrend(value[, names, module, ...])

Water level trend enumerated constant and returns an int object

WaterLevelUncertaintyDataset(*args, **opts)

Create uncertainty dataset

WaterLevelUncertaintyInformation([...])

S100 code and uncertainty of data values

WaterLevelValues([recursively_create_children])

NNN Group Datasets