environmentaltools.common.read_cshore

environmentaltools.common.read_cshore(file_type: str, path: str, skiprows: int = 1)[source]

Read CSHORE model output files.

Loads and parses output files from the CSHORE numerical model, supporting various output types (profiles, transport rates, energy, velocities, etc.).

Parameters:

  • file_type (str) – Type of CSHORE output file to read. Options include: ‘bprof’, ‘bsusl’, ‘cross’, ‘energ’, ‘longs’, ‘param’, ‘rolle’, ‘setup’, ‘swase’, ‘timse’, ‘xmome’, ‘xvelo’, ‘ymome’, ‘yvelo’.

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

  • skiprows (int) – Number of rows to skip when reading file. Defaults to 1.

Returns:

Parsed CSHORE output data with appropriate column names

and spatial index (x-distance in meters).

Return type:

pd.DataFrame