Output Parsing

ADCIRC outputs

ADCIRC generates several output data files, depending on configuration. These data files contain oceanic variables along the model mesh / recording stations, and can be parsed into dedicated Python objects using the parse_adcirc_outputs function.

ensembleperturbation.parsing.adcirc.parse_adcirc_outputs(directory: PathLike | None = None, file_outputs: List[str] | None = None, parallel: bool = False) → Dict[str, dict]

Parse output from multiple ADCIRC runs.

Parameters:

directory – directory containing run output directories
file_outputs – output files to parse
parallel – load data concurrently with Dask

Returns:

variables to parsed data

`fort.61` - sea-surface elevation at stations (specific stations over time series)

class ensembleperturbation.parsing.adcirc.ElevationStationOutput

Bases: StationTimeSeriesOutput

fort.61 - Elevation Time Series at Specified Elevation Recording Stations

https://adcirc.org/home/documentation/users-manual-v52/output-file-descriptions/elevation-time-series-specified-elevation-recording-stations-fort-61

`fort.62` - sea-surface horizontal velocity at stations (specific stations over time series)

class ensembleperturbation.parsing.adcirc.VelocityStationOutput

Bases: StationTimeSeriesOutput

fort.62 - Depth-averaged Velocity Time Series at Specified Velocity Recording Stations

https://adcirc.org/home/documentation/users-manual-v52/output-file-descriptions/depth-averaged-velocity-time-series-specified-velocity-recording-stations-fort-62

`fort.63` - sea-surface elevation (2D field over time series)

class ensembleperturbation.parsing.adcirc.ElevationTimeSeriesOutput

Bases: FieldTimeSeriesOutput

fort.63 - Elevation Time Series at All Nodes in the Model Grid

https://adcirc.org/home/documentation/users-manual-v52/output-file-descriptions/elevation-time-series-nodes-model-grid-fort-63

`fort.64` - sea-surface horizontal velocity (2D field over time series)

class ensembleperturbation.parsing.adcirc.VelocityTimeSeriesOutput

Bases: FieldTimeSeriesOutput

fort.64 - Depth-averaged Velocity Time Series at All Nodes in the Model Grid

https://adcirc.org/home/documentation/users-manual-v52/output-file-descriptions/depth-averaged-velocity-time-series-nodes-model-grid-fort-64

`maxele.63` - maximum sea-surface elevation (2D field with single time per-node)

class ensembleperturbation.parsing.adcirc.MaximumElevationOutput

Bases: FieldOutput

maxele.63 - Maximum Elevation at All Nodes in the Model Grid

https://adcirc.org/home/documentation/users-manual-v52/output-file-descriptions/global-maximum-minimum-files-model-run-maxele-63-maxvel-63-maxwvel-63-maxrs-63-minpr-63/

`maxvel.63` - maximum sea-surface horizontal velocity (2D field with single time per-node)

class ensembleperturbation.parsing.adcirc.MaximumVelocityOutput

Bases: FieldOutput

maxvel.63 - Maximum Speed at All Nodes in the Model Grid

https://adcirc.org/home/documentation/users-manual-v52/output-file-descriptions/global-maximum-minimum-files-model-run-maxele-63-maxvel-63-maxwvel-63-maxrs-63-minpr-63/

`minpr.63` - minimum sea-surface atmospheric pressure (2D field with single time per-node)

class ensembleperturbation.parsing.adcirc.MinimumSurfacePressureOutput

Bases: FieldOutput

minpr.63 - Minimum Sea-level Pressure at All Nodes in the Model Grid

https://adcirc.org/home/documentation/users-manual-v52/output-file-descriptions/global-maximum-minimum-files-model-run-maxele-63-maxvel-63-maxwvel-63-maxrs-63-minpr-63/

`maxwvel.63` - maximum vertical velocity (2D field with single time per-node)

class ensembleperturbation.parsing.adcirc.MaximumSurfaceWindOutput

Bases: FieldOutput

maxwvel.63 - Maximum Surface Wind Speed at All Nodes in the Model Grid

https://adcirc.org/home/documentation/users-manual-v52/output-file-descriptions/global-maximum-minimum-files-model-run-maxele-63-maxvel-63-maxwvel-63-maxrs-63-minpr-63/

`maxrs.63` - maximum sea-surface wave stress (2D field with single time per-node)

class ensembleperturbation.parsing.adcirc.MaximumSurfaceRadiationStressOutput

Bases: FieldOutput

maxrs.63 - Maximum Radiation Surface Stress at All Nodes in the Model Grid

https://adcirc.org/home/documentation/users-manual-v52/output-file-descriptions/global-maximum-minimum-files-model-run-maxele-63-maxvel-63-maxwvel-63-maxrs-63-minpr-63/

`fort.67` / `fort.68` - hot start continuation storage

class ensembleperturbation.parsing.adcirc.HotStartOutput

Bases: FieldOutput

fort.67 - Hot Start Output

https://adcirc.org/home/documentation/users-manual-v52/input-file-descriptions/hot-start-files-fort-67-fort-68/

class ensembleperturbation.parsing.adcirc.HotStartOutput2

Bases: HotStartOutput

fort.68 - Hot Start Output

https://adcirc.org/home/documentation/users-manual-v52/input-file-descriptions/hot-start-files-fort-67-fort-68/

`fort.73` - sea-surface atmospheric pressure (2D field over time series)

class ensembleperturbation.parsing.adcirc.SurfacePressureTimeSeriesOutput

Bases: FieldTimeSeriesOutput

fort.73 - Sea-level Pressure Time Series at All Nodes in the Model Grid

https://adcirc.org/home/documentation/output-file-descriptions/atmospheric-pressure-time-series-nodes-model-grid-fort-73

`fort.74` - sea-surface atmospheric wind stress + wind velocity (2D field over time series)

class ensembleperturbation.parsing.adcirc.SurfaceWindTimeSeriesOutput

Bases: FieldTimeSeriesOutput

fort.74 - Surface Wind Velocity Time Series at All Nodes in the Model Grid

https://adcirc.org/home/documentation/users-manual-v52/output-file-descriptions/wind-stress-velocity-time-series-nodes-model-grid-fort-74

abstract classes

class ensembleperturbation.parsing.adcirc.AdcircOutput

Bases: ABC

classmethod read_directory(directory: PathLike, variables: List[str] | None = None, parallel: bool = False) → Dataset

Compile a dataset from output files in the given directory.

Parameters:

directory – directory containing output files
variables – variables to return
parallel – load data concurrently with Dask

Returns:

dataset of output data

class ensembleperturbation.parsing.adcirc.TimeSeriesOutput: Bases: ABC

class ensembleperturbation.parsing.adcirc.StationTimeSeriesOutput: Bases: AdcircOutput, TimeSeriesOutput, ABC

class ensembleperturbation.parsing.adcirc.FieldOutput

Bases: AdcircOutput, ABC

classmethod read(filename: PathLike, names: List[str] | None = None) → DataFrame | DataArray

Parse ADCIRC output files

Parameters:

filename – file path to ADCIRC NetCDF output
names – list of data variables to extract

Returns:

parsed data

class ensembleperturbation.parsing.adcirc.FieldTimeSeriesOutput: Bases: FieldOutput, TimeSeriesOutput, ABC

Output Parsing

ADCIRC outputs

fort.61 - sea-surface elevation at stations (specific stations over time series)

fort.62 - sea-surface horizontal velocity at stations (specific stations over time series)

fort.63 - sea-surface elevation (2D field over time series)

fort.64 - sea-surface horizontal velocity (2D field over time series)

maxele.63 - maximum sea-surface elevation (2D field with single time per-node)

maxvel.63 - maximum sea-surface horizontal velocity (2D field with single time per-node)

minpr.63 - minimum sea-surface atmospheric pressure (2D field with single time per-node)

maxwvel.63 - maximum vertical velocity (2D field with single time per-node)

maxrs.63 - maximum sea-surface wave stress (2D field with single time per-node)

fort.67 / fort.68 - hot start continuation storage

fort.73 - sea-surface atmospheric pressure (2D field over time series)

fort.74 - sea-surface atmospheric wind stress + wind velocity (2D field over time series)

abstract classes

`fort.61` - sea-surface elevation at stations (specific stations over time series)

`fort.62` - sea-surface horizontal velocity at stations (specific stations over time series)

`fort.63` - sea-surface elevation (2D field over time series)

`fort.64` - sea-surface horizontal velocity (2D field over time series)

`maxele.63` - maximum sea-surface elevation (2D field with single time per-node)

`maxvel.63` - maximum sea-surface horizontal velocity (2D field with single time per-node)

`minpr.63` - minimum sea-surface atmospheric pressure (2D field with single time per-node)

`maxwvel.63` - maximum vertical velocity (2D field with single time per-node)

`maxrs.63` - maximum sea-surface wave stress (2D field with single time per-node)

`fort.67` / `fort.68` - hot start continuation storage

`fort.73` - sea-surface atmospheric pressure (2D field over time series)

`fort.74` - sea-surface atmospheric wind stress + wind velocity (2D field over time series)