Skip to content

v1.0.0
Compare
Choose a tag to compare
@DirkEilander DirkEilander released this 17 Apr 16:01
· 262 commits to main since this release
v1.0.0
43c24b2
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

This release is a major update of the SfincsModel interface. It contains many new features,
such as support for rotated grids, subgrid and improved support for building models from Python scripts.
The documentation and exmaples have been updated to reflect these changes.

The release however also contains several breaking changes as we have tried to improve the
consistency of the interface and match it more closely to the SFINCS model itself.
Please carefully check the API reference for the new methods and arguments.

Main differences

  • setup_region has been replaced by setup_grid_from_region and setup_grid.
    This method actually creates an empty regular grid based on a region of interest or user-defined coordinates, shape, rotation, etc..
  • setup_dep has replaced setup_topobathy and setup_merge_topobathy.
    This method can now also be used to setup a bathymetry map from multiple sources at once.
  • setup_mask_active has replaced setup_mask.
  • setup_mask_bounds has replaced setup_bounds
  • setup_waterlevel_forcing has replaced setup_h_forcing and now supports merging fording from several data sources
  • setup_discharge_forcing has replaced setup_q_forcing and now supports merging fording from several data sources
  • setup_discharge_forcing_from_grid has replaces setup_q_forcing_from_grid
  • setup_precip_forcing has replaced setup_p_forcing
  • setup_precip_forcing_from_grid has replaced setup_p_forcing_from_grid
  • setup_observation_points has replace setup_gauges

New methods

  • setup_grid to setup a user-defined regular grid based coordinates, shape, rotation, etc.
  • setup_subgrid to setup subgrid tables (sbgfile) based on one ore more elevation and Manning roughness datasets
  • setup_constant_infiltration to setup a constant infiltration rate maps (qinffile)
  • setup_waterlevel_bnd_from_mask to setup water level boundary points (bndfile) based on the SFINCS model mask (mskfile)
  • setup_tiles to create tiles of the model for fast visualization

Changed methods

  • setup_river_inflow and setup_river_outflow are now based river centerline data (which can be derivded from hydrography data).
    This is more robust compared to the previous method which was based on reprojected flow direction data.

Removed methods (not replaced)

  • setup_basemaps This method was already deprecated in v0.2.1 and has now been removed.
  • setup_river_hydrography This method was removed as reprojection of the hydrography data is no longer required for river inflow/outflow.
  • setup_river_bathymetry This method was removed as river bathymetry should ideally be burned in the subgrid data of the model rather
    than the dep file itself to be able to include rivers with widths smaller than the model grid cell size. A new option to burn rivers
    in the subgrid data will be added in to setup_subgrid a future release.

New low-level classes

These classes are not intended to be used directly by the user, but are used internally by the SfincsModel class.

  • The SfincsInput class contains methods to generate, read and write SFINCS input files
  • The RegularGrid class contains methods to create and manipulate regular grids
  • The SubgridTableRegular class contains methods to create and manipulate subgrid tables for regular grids
Assets 2
Loading