The classes in s104.api can be accessed by just importing s104. They are automatically imported but can be brought in separately if desired.:

from s100py import s104
s104.s104File(...)
# or
from s100py.s104 import api
api.s104File(...)
# or
from s100py import s104.api
s104.api.s104File(...)

s100py.s104.api Module

Classes

ABC()

Helper class that provides a standard way to create an ABC using inheritance.

DiscoveryMetadata(*args, **kwargs)

12.2.6 of v1.0.1

Enum(value)

Generic enumeration.

FeatureContainerDCF2(*args, **opts)

Container for Data Coding Format 2

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.

GeometryValuesDataset([...])

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

IntEnum(value)

Enum where members are also (and must be) ints

PositioningGroup([recursively_create_children])

S100Exception

S100Root([recursively_create_children])

From table 10c-6 in S100 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(*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

S1xxAttributesBase([recursively_create_children])

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

S1xxDatasetBase(*args, **opts)

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

S1xxGridsBase([recursively_create_children])

S1xxMetadataListBase(*args, **opts)

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

TYPE_OF_WATER_LEVEL_DATA(value)

An enumeration.

VERTICAL_COORDINATE_BASE(value)

An enumeration.

VERTICAL_DATUM_REFERENCE(value)

An enumeration.

WaterLevelContainer(*args, **opts)

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

WaterLevelFeatureDataset(*args, **opts)

Create group_f feature dataset

WaterLevelFeatureInstance([...])

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

WaterLevelGroup([recursively_create_children])

WaterLevelGroupList(*args, **opts)

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

WaterLevelList(*args, **opts)

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

WaterLevelTrend(value)

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