@@ -96,8 +96,9 @@ def get_surface_water(ds, gdf=None, da_basename="rws_oppwater"):
9696
9797@cache .cache_netcdf (coords_3d = True )
9898def discretize_surface_water (ds , gdf , da_basename = "rws_oppwater" ):
99- """Create 3 data-arrays from the shapefile with surface water:
99+ """Create 3 data-arrays from the shapefile with surface water.
100100
101+ These data arrays are:
101102 - area: area of the shape in the cell
102103 - cond: conductance based on the area and "bweerstand" column in shapefile
103104 - stage: surface water level based on the "peil" column in the shapefile
@@ -150,8 +151,9 @@ def discretize_surface_water(ds, gdf, da_basename="rws_oppwater"):
150151
151152@cache .cache_netcdf (coords_2d = True )
152153def get_northsea (ds , gdf = None , da_name = "northsea" ):
153- """Get Dataset which is 1 at the northsea and 0 everywhere else. Sea is defined by
154- rws surface water shapefile.
154+ """Get Dataset which is 1 at the northsea and 0 everywhere else.
155+
156+ Sea is defined by rws surface water shapefile.
155157
156158 .. deprecated:: 0.10.0
157159 `get_northsea` will be removed in nlmod 1.0.0, it is replaced by
@@ -174,7 +176,6 @@ def get_northsea(ds, gdf=None, da_name="northsea"):
174176 Dataset with a single DataArray, this DataArray is 1 at sea and 0
175177 everywhere else. Grid dimensions according to ds.
176178 """
177-
178179 warnings .warn (
179180 "'get_northsea' is deprecated and will be removed in a future version. "
180181 "Use 'nlmod.read.rws.discretize_northsea' to project the northsea on the model grid" ,
@@ -186,8 +187,9 @@ def get_northsea(ds, gdf=None, da_name="northsea"):
186187
187188@cache .cache_netcdf (coords_2d = True )
188189def discretize_northsea (ds , gdf = None , da_name = "northsea" ):
189- """Get Dataset which is 1 at the northsea and 0 everywhere else. Sea is defined by
190- rws surface water shapefile.
190+ """Get Dataset which is 1 at the northsea and 0 everywhere else.
191+
192+ Sea is defined by rws surface water shapefile.
191193
192194 Parameters
193195 ----------
@@ -249,7 +251,7 @@ def calculate_sea_coverage(
249251 filled by the minial value of dtm.
250252 ds : xr.Dataset, optional
251253 Dataset with model information. When ds is not None, the sea DataArray is
252- transformed to the model grid. THe default is None.
254+ transformed to the model grid. The default is None.
253255 zmax : float, optional
254256 Locations thet become sea when the sea level reaches a level of zmax will get a
255257 value of 1 in the resulting DataArray. The default is 0.0.
0 commit comments