3.1. Output dataset

Once the required input datasets are selected, the user will have the ability generate and save the output NetCDF (.nc) file, providing a structured format for the variables essential for further modeling. The output file includes four subsections of data:

  • Coordinates: Coordinate and time data collected and processed from the wave forcing and shoreline observation datasets. This subsection of data includes the following variables:

Variable

Type

Units

Description

time

datetime64[ns]

Datetimes associated with each wave forcing data point

lat

float64

degrees north

Latitudes of waves

long

float64

degrees east

Longitudes of waves

ntrs

int32

number of

Numbered labels for transects.

time_obs

datetime64[ns]

Datetimes associated with each shoreline observation data point

xi

float64

meters

Initial x-values for transects

yi

float64

meters

Initial y-values for transects

xf

float64

meters

Final x-values for transects

yf

float64

meters

Final y-values for transects

phi

float64

degrees

Transect angle

lat_waves

float64

degrees north

Latitude of provided waves

lon_waves

float64

degrees east

Longitude of provided waves

x_pivotal

float64

meters

Initial x-coordinate of pivotal transect

y_pivotal

float64

meters

Initial y-coordinate of pivotal transect

phi_pivotal

float64

degrees

Angle of pivotal transects

  • Data Variables: Wave forcing, shoreline observation, and local sea level data associated with the times and coordinates defined in the Coordinates subsection. This subsection of data includes the following variables:

Variable

Corresponding Variables

Type

Units

Description

hs

(time,ntrs)

float64

meters

Significant wave height

tp

(time,ntrs)

float64

seconds

Peak wave period

dir

(time,ntrs)

float64

degrees north

Direction of wave propagation

tide

(time,ntrs)

float64

meters

Astronomical tide

surge

(time,ntrs)

float64

meters

Storm surge

slr

(time,ntrs)

float64

meters

Sea level rise

obs

(time_obs,ntrs)

float64

meters

Observed shoreline position

rot

(time_obs)

float64

degrees

Shoreline rotation

average_obs

(time_obs)

float64

meters

Average shoreline position

mask_nan_obs

(time_obs,ntrs)

bool

boolean

Mask for NaNs in shoreline observations

mask_nan_rot

(time_obs)

bool

boolean

Mask for NaNs in rotation

mask_non_average_obs

(time_obs)

bool

boolean

LMask for NaNs in average observations

  • Indexes: PandasIndex for each variables listed in the Coordinates subsection.

  • Attributes: List of contributions, sources, and conventions used in the Preprocess module to create the output file. This subsection of data includes the following attributes:

Attribute

Description

title

“Input File for IH-SET models”

institution

“Environmental Hydraulics Institute of Cantabria - https://ihcantabria.com/

source

“IH-SET preprocessing module”

history

States the date created

references

“Jaramillo et al. (2025) - doi: xxxxxxxx.xx”

Documentation

https://ihcantabria.github.io/IHSetDocs/

Conventions

“CF-1.6”

Data Sources

Lists the file type of each input file used

Summary

“This dataset is output from the IH-SET preprocessing module. Etc…”

geospatial_lat_min

“-90”

geospatial_lat_max

“90”

geospatial_lon_min

“-180”

geospatial_lon_max

“180”

applicable_models

Lists the models that can be applied to the data included in the output file.

EPSG

States the European Petroleum Survey Group (EPSG) coordinate code for the latitude and longtitude data