hydroflows.methods.fiat.fiat_visualize#

Method for visualizing FIAT model results.

class hydroflows.methods.fiat.fiat_visualize.FIATVisualize(fiat_output_csv: Path, fiat_cfg: Path, scenario_name: str | None = None, spatial_joins_cfg: Path = 'models/fiat/spatial_joins.toml', output_dir: Path = PosixPath('output/fiat'), **params)[source]#

Method for visualizing FIAT model results.

Parameters:

  • fiat_output_csv (Path) – The file path to the output csv of the FIAT model.

  • fiat_cfg (Path) – The file path to the FIAT configuration (toml) file from the FIAT model simulation.

  • spatial_joins_cfg (Path = "models/fiat/spatial_joins.toml") – The path to the spatial joins configuration file.

  • **params – Additional parameters to pass to the FIATVisualize instance. See fiat_visualize Params.

See also

fiat_visualize Input fiat_visualize Output fiat_visualize Params

pydantic model hydroflows.methods.fiat.fiat_visualize.Input[source]#

Input parameters.

This class represents the input data required for the FIATVisualize method.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Fields:
field fiat_cfg: Annotated[Path, AfterValidator(func=filedir_validator)] [Required]#

The file path to the FIAT configuration (toml) file from the FIAT model simulation.

field fiat_output_csv: Path [Required]#

The file path to the output.csv file of the FIAT model.

field spatial_joins_cfg: Annotated[Path, AfterValidator(func=filedir_validator)] = 'models/fiat/spatial_joins.toml'#

The path to the spatial joins configuration file.

model_post_init(context: Any, /) → None#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self – The BaseModel instance.

  • context – The context.

pydantic model hydroflows.methods.fiat.fiat_visualize.Output[source]#

Output parameters.

This class represents the output data generated by the FIATVisualize method.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Fields:
field fiat_infographics: Path [Required]#

The file path to the FIAT infographics output.

field fiat_infometrics: Path [Required]#

The file path to the FIAT infometrics output.

model_post_init(context: Any, /) → None#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self – The BaseModel instance.

  • context – The context.

pydantic model hydroflows.methods.fiat.fiat_visualize.Params[source]#

Parameters for the FIATBuild.

Instances of this class are used in the FIATBuild method to define the required settings.

See also

hydromt_fiat.fiat.FiatModel

For more details on the FiatModel used in hydromt_fiat.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Fields:
field infographic_images: Annotated[Path, PathType(path_type=dir)] = PosixPath('/home/runner/work/HydroFlows/HydroFlows/hydroflows/cfg/infographics/images')#

The path to the directory where the images for the infographics are saved.

field infographics_template: Annotated[Path, PathType(path_type=file)] = PosixPath('/home/runner/work/HydroFlows/HydroFlows/hydroflows/cfg/infographics/config_charts.toml')#

The path to the infographics template file.

field infographics_template_risk: Annotated[Path, PathType(path_type=file)] = PosixPath('/home/runner/work/HydroFlows/HydroFlows/hydroflows/cfg/infographics/config_risk_charts.toml')#

The path to the infographics template file.

field infometrics_template: Annotated[Path, PathType(path_type=file)] = PosixPath('/home/runner/work/HydroFlows/HydroFlows/hydroflows/cfg/infometrics/metrics_config.toml')#

The path to the infometrics template file.

field output_dir: Annotated[Path, AfterValidator(func=outputdirpath_validator)] = PosixPath('output/fiat')#

The path to the directory where the infometrics and infographics output can be saved.

field scenario_name: str [Required]#

The name of the simulation scenario.

model_post_init(context: Any, /) → None#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self – The BaseModel instance.

  • context – The context.