environmentaltools.processes.read_cshore

environmentaltools.processes.read_cshore(file_, path)[source]

Load CSHORE model output files.

Parameters:

  • file (str) – Output file type: ‘bprof’, ‘bsusl’, ‘cross’, ‘crvol’, ‘energ’, ‘longs’, ‘lovol’, ‘param’, ‘rolle’, ‘setup’, ‘swase’, ‘timse’, ‘xmome’, ‘xvelo’, ‘ymome’, ‘yvelo’

  • path (str) – Directory path containing CSHORE output files

Returns:

DataFrame with output data, indexed by cross-shore position (meters)

Return type:

pd.DataFrame

Notes

CSHORE output file structure:

  • Files named as ‘O’ + file_.upper() (e.g., ‘OBPROF’)

  • First row contains metadata (number of points for ‘bprof’)

  • Data is whitespace-delimited

Variable definitions: - bprof: Beach profile elevation - bsusl: Bed load and suspended load probabilities and velocities - cross: Cross-shore sediment transport rates - energ: Energy flux and dissipation - longs: Longshore sediment transport rates - param: Wave parameters (period, bed load, sigma) - rolle: Roller energy flux - setup: Wave setup, depth, and standard deviation - swase: Swash zone parameters - timse: Time series of overtopping and transport - xmome: Cross-shore momentum (radiation stress, bed shear) - xvelo: Cross-shore velocities - ymome: Longshore momentum - yvelo: Longshore velocities

Examples

>>> df_profile = read_cshore('bprof', './cshore_run')
>>> df_setup = read_cshore('setup', './cshore_run')