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.v2_0.api Module

Classes

DATA_DYNAMICITY(*values)

S104 v2.0 Table 12.10 - Classification of data according to the relationship between the time of its collection, generation, or calculation of generation parameters, in relation to the time of publication of the dataset.

Enum(new_class_name, /, names, *[, module, ...])

Create a collection of name/value pairs.

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.

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(new_class_name, /, names, *[, ...])

Enum where members are also (and must be) ints

S100Exception

S100File(*args, **kywrds)

S100Root([recursively_create_children])

From table 10c-5 in S100 v5.2 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.

S104UnspecifiedClassException

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.

Union()

Represent a union type

VERTICAL_DATUM(*values)

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.

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)

WaterLevelDomainExtentPolygonDataset(*args, ...)

Create domainExtent.polygon dataset S-100 Ed 5.2 Table 10c-11 (Optional) – Containing coordinates of bounding polygon vertices of the spatial extent of the domain of the coverage

WaterLevelDomainExtentPolygonInformation([...])

S100 code and uncertainty of data values

WaterLevelFeatureDataset(*args, **opts)

Create group_f feature dataset

WaterLevelFeatureInstanceBase()

Basic template for the name of the attribute.

WaterLevelFeatureInstanceDCF2([...])

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)

WaterLevelTrend(*values)

Water level trend, the tendency of water level to change in a particular direction, 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])

Water Level Feature attributes