environmentaltools.spectral.analysis.configure_tidal_model

environmentaltools.spectral.analysis.configure_tidal_model(model_name: str, database_path: str, model_format: str = None, auto_download: bool = True) → pyTMD.io.model[source]

Configure and initialize the tidal model with specified parameters.

Parameters:

  • model_name (str) – Name of the tidal model (e.g., ‘EOT20’, ‘FES2014’, ‘TPXO9’).

  • database_path (str) – Path to the model database directory.

  • model_format (str, optional) – Format of the model files (e.g., ‘FES’, ‘netcdf’, ‘OTIS’, ‘ATLAS’). If None, format is auto-detected based on model name.

  • auto_download (bool, default=True) – If True, attempt to download model files automatically if not found.

Returns:

Configured tidal model instance

Return type:

pyTMD.io.model

Raises:

  • FileNotFoundError – If model files are not found and cannot be downloaded

  • ValueError – If model configuration fails

Notes

The function will automatically download EOT20 model if files are missing and auto_download is True. Other models may require manual download.