Add rename_layers_to_old_names to get_regis

nlmod/data/regis/Tabellen.bij.naamgevingsreleases.REGIS.II.csv

@@ -0,0 +1,172 @@
+Naam (REGIS II),Oude code,Groepscode,Wijziging,Nieuwe code,Toelichting
+Maaiveld,mv,,,mv,
+Antropogene afzettingen,AA,NU,,NUAA,
+"Holocene afzettingen, complexe eenheid",HLc,NU,hlc,NUhlc,1
+"Formatie van Boxtel, zandige eenheid",BXz,NU,,NUBXz,
+"Formatie van Boxtel, eerste zandige eenheid",BXz1,NU,,NUBXz1,
+"Formatie van Boxtel, Laagpakket van Schimmert, eerste kleiige eenheid",BXSCk1,NU,,NUBXSCk1,
+"Formatie van Boxtel, tweede zandige eenheid",BXz2,NU,,NUBXz2,
+"Formatie van Boxtel, Laagpakket van Liempde, eerste kleiige eenheid",BXLMk1,NU,,NUBXLMk1,
+"Formatie van Boxtel, eerste kleiige eenheid",BXk1,NU,,NUBXk1,
+"Formatie van Boxtel, derde zandige eenheid",BXz3,NU,,NUBXz3,
+"Formatie van Boxtel, tweede kleiige eenheid",BXk2,NU,,NUBXk2,
+"Formatie van Boxtel, vierde zandige eenheid",BXz4,NU,,NUBXz4,
+"Formatie van Kreftenheye, zandige eenheid",KRz,NU,,NUKRz,
+"Formatie van Kreftenheye, eerste zandige eenheid",KRz1,NU,,NUKRz1,
+"Formatie van Kreftenheye, Laag van Wijchen, eerste kleiige eenheid",KRWYk1,NU,,NUKRWYk1,
+"Formatie van Kreftenheye, tweede zandige eenheid",KRz2,NU,,NUKRz2,
+"Formatie van Kreftenheye, eerste kleiige eenheid",KRk1,NU,,NUKRk1,
+"Formatie van Kreftenheye, derde zandige eenheid",KRz3,NU,,NUKRz3,
+"Formatie van Beegden, zandige eenheid",BEz,NU,,NUBEz,
+"Formatie van Beegden, eerste zandige eenheid",BEz1,NU,,NUBEz1,
+"Formatie van Beegden, Laag van Rosmalen, eerste kleiige eenheid",BEROk1,NU,,NUBEROk1,
+"Formatie van Beegden, eerste kleiige eenheid",BEk1,NU,,NUBEk1,
+"Formatie van Beegden, tweede zandige eenheid",BEz2,NU,,NUBEz2,
+"Formatie van Beegden, tweede kleiige eenheid",BEk2,NU,,NUBEk2,
+"Formatie van Beegden, derde zandige eenheid",BEz3,NU,,NUBEz3,
+"Formatie van Koewacht, zandige eenheid",KWz,NU,,NUKWz,
+"Formatie van Koewacht, eerste zandige eenheid",KWz1,NU,,NUKWz1,
+"Formatie van Woudenberg, eerste venige eenheid",WBv1,NU,,NUWBv1,
+"Eem Formatie, zandige eenheid",EEz,NU,,NUEEz,
+"Eem Formatie, eerste zandige eenheid",EEz1,NU,,NUEEz1,
+"Eem Formatie, eerste kleiige eenheid",EEk1,NU,,NUEEk1,
+"Eem Formatie, tweede zandige eenheid",EEz2,NU,,NUEEz2,
+"Eem Formatie, tweede kleiige eenheid",EEk2,NU,,NUEEk2,
+"Eem Formatie, derde zandige eenheid",EEz3,NU,,NUEEz3,
+"Formatie van Kreftenheye, Laagpakket van Zutphen, eerste kleiige eenheid",KRZUk1,NU,,NUKRZUk1,
+"Formatie van Kreftenheye, vierde zandige eenheid",KRz4,NU,,NUKRz4,
+"Formatie van Kreftenheye, Laagpakket van Twello, eerste kleiige eenheid",KRTWk1,NU,,NUKRTWk1,
+"Formatie van Kreftenheye, vijfde zandige eenheid",KRz5,NU,,NUKRz5,
+"Formatie van Drente, zandige eenheid",DRz,NU,,NUDRz,
+"Formatie van Drente, eerste zandige eenheid",DRz1,NU,,NUDRz1,
+"Formatie van Drente, Laagpakket van Uitdam, eerste kleiige eenheid",DRUIk1,NU,,NUDRUIk1,
+"Formatie van Drente, tweede zandige eenheid",DRz2,NU,,NUDRz2,
+"Formatie van Drente, Laagpakket van Gieten, eerste kleiige eenheid",DRGIk1,NU,,NUDRGIk1,
+"Formatie van Drente, derde zandige eenheid",DRz3,NU,,NUDRz3,
+"Formatie van Drente, Laagpakket van Gieten, tweede kleiige eenheid",DRGIk2,NU,,NUDRGIk2,
+"Gestuwde afzettingen, complexe eenheid",DTc,NU,gsc,NUgsc,2
+"Formatie van Drachten, zandige eenheid",DNz,NU,,NUDNz,
+"Formatie van Drachten, eerste zandige eenheid",DNz1,NU,,NUDNz1,
+"Formatie van Urk, zandige eenheid",URz,NU,,NUURz,
+"Formatie van Urk, eerste zandige eenheid",URz1,NU,,NUURz1,
+"Formatie van Urk, eerste kleiige eenheid",URk1,NU,,NUURk1,
+"Formatie van Urk, tweede zandige eenheid",URz2,NU,,NUURz2,
+"Formatie van Urk, tweede kleiige eenheid",URk2,NU,,NUURk2,
+"Formatie van Urk, derde zandige eenheid",URz3,NU,,NUURz3,
+"Formatie van Peelo, zandige eenheid",PEz,NU,,NUPEz,
+"Formatie van Peelo, eerste zandige eenheid",PEz1,NU,,NUPEz1,
+"Formatie van Peelo, eerste kleiige eenheid",PEk1,NU,,NUPEk1,
+"Formatie van Peelo, tweede zandige eenheid",PEz2,NU,,NUPEz2,
+"Formatie van Peelo, tweede kleiige eenheid",PEk2,NU,,NUPEk2,
+"Formatie van Peelo, derde zandige eenheid",PEz3,NU,,NUPEz3,
+"Formatie van Urk, vierde zandige eenheid",URz4,NU,,NUURz4,
+"Formatie van Urk, derde kleiige eenheid",URk3,NU,,NUURk3,
+"Formatie van Urk, vijfde zandige eenheid",URz5,NU,,NUURz5,
+"Formatie van Sterksel, zandige eenheid",STz,NU,,NUSTz,
+"Formatie van Sterksel, eerste zandige eenheid",STz1,NU,,NUSTz1,
+"Formatie van Sterksel, eerste kleiige eenheid",STk1,NU,,NUSTk1,
+"Formatie van Sterksel, tweede zandige eenheid",STz2,NU,,NUSTz2,
+"Formatie van Appelscha, zandige eenheid",APz,NU,,NUAPz,
+"Formatie van Appelscha, eerste zandige eenheid",APz1,NU,,NUAPz1,
+"Formatie van Stramproy, zandige eenheid",SYz,NU,,NUSYz,
+"Formatie van Stramproy, eerste zandige eenheid",SYz1,NU,,NUSYz1,
+"Formatie van Stramproy, eerste kleiige eenheid",SYk1,NU,,NUSYk1,
+"Formatie van Stramproy, tweede zandige eenheid",SYz2,NU,,NUSYz2,
+"Formatie van Stramproy, tweede kleiige eenheid",SYk2,NU,,NUSYk2,
+"Formatie van Stramproy, derde zandige eenheid",SYz3,NU,,NUSYz3,
+"Formatie van Stramproy, derde kleiige eenheid",SYk3,NU,,NUSYk3,
+"Formatie van Stramproy, vierde zandige eenheid",SYz4,NU,,NUSYz4,
+"Formatie van Peize en Formatie van Waalre, zandige eenheid",PZWAz,NU,PZ-WAz,NUPZ-WAz,3
+"Formatie van Peize en Formatie van Waalre, eerste zandige eenheid",PZWAz1,NU,PZ-WAz1,NUPZ-WAz1,3
+"Formatie van Waalre, eerste kleiige eenheid",WAk1,NU,,NUWAk1,
+"Formatie van Peize en Formatie van Waalre, tweede zandige eenheid",PZWAz2,NU,PZ-WAz2,NUPZ-WAz2,3
+"Formatie van Waalre, tweede kleiige eenheid",WAk2,NU,,NUWAk2,
+"Formatie van Peize, eerste kleiige eenheid",PZk1,NU,,NUPZk1,
+"Formatie van Peize en Formatie van Waalre, derde zandige eenheid",PZWAz3,NU,PZ-WAz3,NUPZ-WAz3,3
+"Formatie van Waalre, derde kleiige eenheid",WAk3,NU,,NUWAk3,
+"Formatie van Peize, complexe eenheid",PZc,NU,,NUPZc,
+"Formatie van Peize en Formatie van Waalre, vierde zandige eenheid",PZWAz4,NU,PZ-WAz4,NUPZ-WAz4,3
+"Formatie van Maassluis, zandige eenheid",MSz,NU,,NUMSz,
+"Formatie van Maassluis, eerste zandige eenheid",MSz1,NU,,NUMSz1,
+"Formatie van Maassluis, eerste kleiige eenheid",MSk1,NU,,NUMSk1,
+"Formatie van Maassluis, tweede zandige eenheid",MSz2,NU,,NUMSz2,
+"Formatie van Maassluis, tweede kleiige eenheid",MSk2,NU,,NUMSk2,
+"Formatie van Maassluis, derde zandige eenheid",MSz3,NU,,NUMSz3,
+"Formatie van Maassluis, complexe eenheid",MSc,NU,,NUMSc,
+"Formatie van Maassluis, vierde zandige eenheid",MSz4,NU,,NUMSz4,
+"Kiezelooliet Formatie, zandige eenheid",KIz,NU,,NUKIz,
+"Kiezelooliet Formatie, eerste zandige eenheid",KIz1,NU,,NUKIz1,
+"Kiezelooliet Formatie, eerste kleiige eenheid",KIk1,NU,,NUKIk1,
+"Kiezelooliet Formatie, tweede zandige eenheid",KIz2,NU,,NUKIz2,
+"Kiezelooliet Formatie, tweede kleiige eenheid",KIk2,NU,,NUKIk2,
+"Kiezelooliet Formatie, derde zandige eenheid",KIz3,NU,,NUKIz3,
+"Kiezelooliet Formatie, derde kleiige eenheid",KIk3,NU,,NUKIk3,
+"Kiezelooliet Formatie, vierde zandige eenheid",KIz4,NU,,NUKIz4,
+"Kiezelooliet Formatie, vierde kleiige eenheid",KIk4,NU,,NUKIk4,
+"Kiezelooliet Formatie, vijfde zandige eenheid",KIz5,NU,,NUKIz5,
+"Formatie van Oosterhout, zandige eenheid",OOz,NU,,NUOOz,
+"Formatie van Oosterhout, eerste zandige eenheid",OOz1,NU,,NUOOz1,
+"Formatie van Oosterhout, eerste kleiige eenheid",OOk1,NU,,NUOOk1,
+"Formatie van Oosterhout, tweede zandige eenheid",OOz2,NU,,NUOOz2,
+"Formatie van Oosterhout, complexe eenheid",OOc,NU,,NUOOc,
+"Formatie van Inden, zandige eenheid",IEz,NU,,NUIEz,
+"Formatie van Inden, eerste zandige eenheid",IEz1,NU,,NUIEz1,
+"Formatie van Inden, eerste kleiige eenheid",IEk1,NU,,NUIEk1,
+"Formatie van Inden, tweede zandige eenheid",IEz2,NU,,NUIEz2,
+"Formatie van Inden, tweede kleiige eenheid",IEk2,NU,,NUIEk2,
+"Formatie van Inden, derde zandige eenheid",IEz3,NU,,NUIEz3,
+"Formatie van Breda, zandige eenheid",BRz,NU,,NUBRz,
+"Formatie van Breda, eerste zandige eenheid",BRz1,NU,,NUBRz1,
+"Formatie van Breda, eerste kleiige eenheid",BRk1,NU,,NUBRk1,
+"Formatie van Breda, tweede zandige eenheid",BRz2,NU,,NUBRz2,
+"Formatie van Ville, eerste bruinkooleenheid",VIb1,NU,,NUVIb1,
+"Formatie van Breda, derde zandige eenheid",BRz3,NU,,NUBRz3,
+"Formatie van Ville, tweede bruinkooleenheid",VIb2,NU,,NUVIb2,
+"Formatie van Breda, vierde zandige eenheid",BRz4,NU,,NUBRz4,
+"Formatie van Veldhoven, Laagpakket van Voort, complexe eenheid",VEVOc,NM,,NMVEVOc,
+"Rupel Formatie, zandige eenheid",RUz,NM,,NMRUz,
+"Rupel Formatie, eerste zandige eenheid",RUz1,NM,,NMRUz1,
+"Rupel Formatie, Laagpakket van Boom, eerste kleiige eenheid",RUBOk1,NM,,NMRUBOk1,
+"Rupel Formatie, tweede zandige eenheid",RUz2,NM,,NMRUz2,
+"Rupel Formatie, eerste kleiige eenheid",RUk1,NM,,NMRUk1,
+"Rupel Formatie, derde zandige eenheid",RUz3,NM,,NMRUz3,
+"Rupel Formatie, tweede kleiige eenheid",RUk2,NM,,NMRUk2,
+"Rupel Formatie, vierde zandige eenheid",RUz4,NM,,NMRUz4,
+"Formatie van Tongeren, zandige eenheid",TOz,NM,,NMTOz,
+"Formatie van Tongeren, eerste zandige eenheid",TOz1,NM,,NMTOz1,
+"Formatie van Tongeren, Laagpakket van Goudsberg, eerste kleiige eenheid",TOGOk1,NM,,NMTOGOk1,
+"Formatie van Tongeren, tweede zandige eenheid",TOz2,NM,,NMTOz2,
+"Formatie van Tongeren, Laagpakket van Watervliet, eerste kleiige eenheid",TOZEWAk1,NM,TOWAk1,NMTOWAk1,4
+"Formatie van Tongeren, derde zandige eenheid",TOz3,NM,,NMTOz3,
+"Formatie van Dongen, zandige eenheid",DOz,NL,,NLDOz,
+"Formatie van Dongen, eerste zandige eenheid",DOz1,NL,,NLDOz1,
+"Formatie van Dongen, Laagpakket van Asse, eerste kleiige eenheid",DOASk1,NL,,NLDOASk1,
+"Formatie van Dongen, tweede zandige eenheid",DOz2,NL,,NLDOz2,
+"Formatie van Dongen, eerste kleiige eenheid",DOk1,NL,,NLDOk1,
+"Formatie van Dongen, derde zandige eenheid",DOz3,NL,,NLDOz3,
+"Formatie van Dongen, Laagpakket van Ieper, eerste kleiige eenheid",DOIEk1,NL,,NLDOIEk1,
+"Formatie van Dongen, vierde zandige eenheid",DOz4,NL,,NLDOz4,
+"Formatie van Landen, complexe eenheid",LAc,NL,,NLLAc,
+"Formatie van Heijenrath, complexe eenheid",HTc,NU,,NUHTc,
+"Formatie van Houthem, kalksteeneenheid",HOq,CK,HMq,CKHMq,5
+"Formatie van Maastricht, kalksteeneenheid",MTq,CK,MAq,CKMAq,5
+"Formatie van Gulpen, kalksteeneenheid",GUq,CK,GPq,CKGPq,5
+"Formatie van Vaals, complexe eenheid",VAc,CK,,CKVAc,
+"Formatie van Aken, complexe eenheid",AKc,CK,,CKAKc,
+,,,,,
+"Toelichting bij de wijzigingen in REGIS II, anders dan het toevoegen van de groepscode:",,,,,
+,,,,,
+"1.    De Holocene afzettingen zijn niet als zodanig gedefinieerd in de Nomenclator. Het formatiedeel van de code (‘hl’) wordt daarom met kleine letters geschreven, gevolgd door de ‘c’ van complexe eenheid. De eenheid omvat de formaties van Naaldwijk, Echteld, Nieuwkoop en Kreekrak, de antropogene afzettingen en delen van de formaties van Boxtel en Beegden.",,,,,
+"2.    De door landijs gestuwde afzettingen zijn niet als zodanig gedefinieerd in de Nomenclator. Het formatiedeel van de code (‘gs’) wordt daarom met kleine letters geschreven wordt, gevolgd door de ‘c’ van complexe eenheid. De eenheid bestaat uit gestuwd materiaal van één of meerdere oudere formaties.",,,,,
+3.    De formaties van Peize en Waalre zijn gecombineerd in één eenheid waarbij beide codes gescheiden door een koppelstreepje worden opgenomen (‘NUPZ-WA’).,,,,,
+4.    Het Laagpakket van Zelzate van de Formatie van Tongeren is vervallen; de Laag van Watervliet is een laagpakket geworden. De code verandert daarom van ‘TOZEWAk1’ naar ‘TOWAk1’.,,,,,
+"5.    De formaties van Houthem, Maastricht en Gulpen hebben een nieuwe formatiecode gekregen.",,,,,
+,,,,,
+Toelichting op de algemene lithologische karakteristiek van de hydrogeologische eenheden van REGIS II (ongewijzigd in deze release):,,,,,
+,,,,,
+"        k - Kleiige hydrogeologische eenheid, overwegend bestaande uit klei, zandige klei en/of kleiig zand of leem.",,,,,
+"        c - Complexe hydrogeologische eenheid, bestaande uit een afwisseling van zandige, kleiige en organogene afzettingen.",,,,,
+"        v - Venige hydrogeologische eenheid, overwegend bestaande uit veen en/of bruinkool en andere organogene afzettingen.",,,,,
+"        b - Hydrogeologische bruinkooleenheid, overwegend bestaande uit bruinkool.",,,,,
+"        q - Kalksteen hydrogeologische eenheid, overwegend bestaande uit kalksteen, al dan niet afgewisseld met vuursteenbanken.",,,,,
+"        z - Zandige hydrogeologische eenheid, overwegend bestaande uit zand (fijn tot en met grof zand), grind en/of schelpen.",,,,,

nlmod/read/geotop.py

@@ -383,7 +383,7 @@ def add_kh_and_kv(
         or "linear". Allowed values are "arithmetic_mean" and "harmonic_mean". The
         default is "arithmetic_mean".
     anisotropy : float, optional
-        THe anisotropy value used when there are no kv values in df. The default is 1.0.
+        The anisotropy value used when there are no kv values in df. The default is 1.0.
     kh : str, optional
         THe name of the new variable with kh values in gt. The default is "kh".
     kv : str, optional

nlmod/read/regis.py

@@ -100,6 +100,7 @@ def get_regis(
     drop_layer_dim_from_top=True,
     probabilities=False,
     nodata=-9999,
+    rename_layers_to_version_2_2_2=True,
 ):
     """Get a regis dataset projected on the modelgrid.
 
@@ -129,6 +130,10 @@ def get_regis(
     nodata : int or float, optional
         When nodata is not None, set values equal to nodata to nan. The default is
         -9999.
+    rename_layers_to_version_2_2_2 : bool, toptional
+        From version 2.2.3 of regis, the names of stratigraphic layers change, compared
+        to previous versions. If rename_layers_to_version_2_2_2 is True, the layer-names are
+        renamed back to their original names. The default is True.
 
     Returns
     -------
@@ -159,8 +164,13 @@ def get_regis(
     if (ds["y"].diff("y") > 0).all():
         ds = ds.isel(y=slice(None, None, -1))
 
+    if rename_layers_to_version_2_2_2 and ds.attrs["title"] == "REGIS v02r2s3":
+        df = get_table_name_changes()
+        layer = df.set_index("Nieuwe code")["Oude code"].loc[ds.layer]
+        ds = ds.assign_coords({"layer": layer})
+
     # slice layers
-    if botm_layer is not None:
+    if botm_layer is not None and botm_layer in ds.layer:
         ds = ds.sel(layer=slice(botm_layer))
 
     # rename bottom to botm, as it is called in FloPy
@@ -352,7 +362,7 @@ def get_legend(kind="REGIS"):
         raise (ValueError(f"Only allowed values for kind are {allowed_kinds}"))
     if kind in ["REGIS", "combined"]:
         dir_path = os.path.dirname(os.path.realpath(__file__))
-        fname = os.path.join(dir_path, "..", "data", "regis_2_2.gleg")
+        fname = os.path.join(dir_path, "..", "data", "regis", "regis_2_2.gleg")
         leg_regis = read_gleg(fname)
         if kind == "REGIS":
             return leg_regis
@@ -412,3 +422,27 @@ def read_voleg(fname):
     leg["color"] = clrs
     leg = leg.drop(["r", "g", "b", "a"], axis=1)
     return leg
+
+
+def get_table_name_changes():
+    """
+    Get the table with name changes of REGIS
+
+    Returns
+    -------
+    df : pd.DataFrame
+        A DataFrame containsing old and new names.
+
+    """
+    dir_path = os.path.dirname(os.path.realpath(__file__))
+    fname = "Tabellen.bij.naamgevingsreleases.REGIS.II.csv"
+    fname = os.path.join(dir_path, "..", "data", "regis", fname)
+    df = pd.read_csv(fname)
+
+    # remove (REGIS II) for the header of the first column, after "Naam"
+    df.columns = df.columns.str.replace(" (REGIS II)", "")
+
+    # drop the lines after the first empty row
+    first_empty_row = np.where(df.iloc[:, 0].isna())[0][0]
+    df = df.iloc[:first_empty_row]
+    return df

pyproject.toml

@@ -96,6 +96,7 @@ include-package-data = true
 [tool.setuptools.package-data]
 "nlmod.data" = ["*.gleg"]
 "nlmod.data.geotop" = ["*"]
+"nlmod.data.regis" = ["*"]
 "nlmod.data.shapes" = ["*"]
 "nlmod.data.ahn" = ["*"]
 "nlmod.data.bgt" = ["*"]