environmentaltools.spatiotemporal.raster.check_inputs
- environmentaltools.spatiotemporal.raster.check_inputs(info)[source]
Validate and prepare input configuration for marine spatial analysis processing.
Performs comprehensive validation of input parameters, file paths, and configuration settings required for the marine tools spatial analysis workflow. Sets up default values, creates necessary directory structures, and validates data availability.
- Parameters:
info (dict) –
Configuration dictionary containing project parameters, file paths, and processing settings. Expected keys include:
- ”input_dtm”Path
Path to the input Digital Terrain Model file
- ”no_sims”int
Number of simulations to process
- ”project”dict
Dictionary with paths for input/output project
- ”index”list
List of indices for processing
- ”region_name”str
Name of the region being processed
- ”fld_portion”int, optional
Flood portion parameter (default: 3)
- ”seasons”dict, optional
Seasonal month definitions
- Returns:
Function modifies the input dictionary in-place.
- Return type:
None
- Raises:
FileNotFoundError – If required input files or project do not exist.
ValueError – If fld_portion parameter is not a positive integer.
Notes
The function performs the following validations and setup: 1. Verifies existence of input DTM file 2. Checks simulation project and catalogs available TIFF files 3. Sets default values for optional parameters 4. Defines seasonal month groupings if not provided 5. Creates auxiliary output directory structure 6. Validates flood portion parameter
TODO items: - Check that level series files exist - Validate that max_level has data for all months and years