bedrock-ge 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

bedrock_ge/gi/write.py

@@ -0,0 +1,105 @@
+from pathlib import Path
+from typing import Dict, Union
+
+import geopandas as gpd
+import pandas as pd
+
+
+def write_gi_db_to_gpkg(
+    brgi_db: Dict[str, gpd.GeoDataFrame],
+    gpkg_path: Union[str, Path],
+) -> None:
+    """
+    Write a database, i.e. a dictionary of DataFrames, with Bedrock Ground Investigation data to a GeoPackage file.
+
+    Each DataFrame will be saved in a separate table named after the keys of the dictionary.
+
+    Args:
+        brgi_dfs (dict): A dictionary where keys are brgi table names and values are DataFrames with brgi data.
+        gpkg_path (str): The name of the output GeoPackage file.
+
+    Returns:
+        None: This function does not return any value. It writes the DataFrames to a GeoPackage file.
+    """
+
+    # Create a GeoDataFrame from the dictionary of DataFrames
+    for sheet_name, brgi_table in brgi_db.items():
+        sanitized_table_name = sanitize_table_name(sheet_name)
+
+        if isinstance(brgi_table, pd.DataFrame):
+            brgi_table = gpd.GeoDataFrame(brgi_table)
+
+        if isinstance(brgi_table, gpd.GeoDataFrame):
+            brgi_table.to_file(
+                gpkg_path, driver="GPKG", layer=sanitized_table_name, overwrite=True
+            )
+
+    print(f"Ground Investigation data has been written to '{gpkg_path}'.")
+
+
+def write_gi_db_to_excel(
+    gi_db: Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]],
+    excel_path: Union[str, Path],
+) -> None:
+    """
+    Write a database, i.e. a dictionary of DataFrames, with Ground Investigation data to an Excel file.
+
+    Each DataFrame will be saved in a separate sheet named after the keys of the dictionary.
+    Function can be used on any GI database, whether in AGS, Bedrock, or another format.
+
+    Args:
+        gi_dfs (dict): A dictionary where keys are GI table names and values are DataFrames with GI data.
+        excel_path (str): The name of the output Excel file.
+
+    Returns:
+        None: This function does not return any value. It writes the DataFrames to an Excel file.
+    """
+
+    # Create an Excel writer object
+    with pd.ExcelWriter(excel_path, engine="openpyxl") as writer:
+        for sheet_name, df in gi_db.items():
+            sanitized_sheet_name = sanitize_table_name(sheet_name)
+            if isinstance(df, pd.DataFrame) or isinstance(df, gpd.GeoDataFrame):
+                df.to_excel(writer, sheet_name=sanitized_sheet_name, index=False)
+
+    print(f"Ground Investigation data has been written to '{excel_path}'.")
+
+
+def sanitize_table_name(sheet_name):
+    """
+    Replace invalid characters and spaces in GI table names with underscores,
+    such that the name is consistent with SQL, GeoPackage and Excel naming conventions.
+
+    Args:
+        sheet_name (str): The original sheet name.
+
+    Returns:
+        str: A sanitized sheet name with invalid characters and spaces replaced.
+    """
+    # Trim to a maximum length of 31 characters
+    trimmed_name = sheet_name.strip()[:31]
+
+    # Define invalid characters and replace with underscores
+    invalid_chars = [":", "/", "\\", "?", "*", "[", "]"]
+    sanitized_name = trimmed_name
+    for char in invalid_chars:
+        sanitized_name = sanitized_name.replace(char, "_")
+
+    # Replace spaces with underscores
+    sanitized_name = sanitized_name.replace(" ", "_")
+
+    # Collapse multiple underscores to one
+    sanitized_name = "_".join(filter(None, sanitized_name.split("_")))
+
+    if trimmed_name != sanitized_name:
+        print(
+            f"Table names shouldn't contain {invalid_chars} or spaces and shouldn't be longer than 31 characters.\n",
+            f"Replaced '{sheet_name}' with '{sanitized_name}'.",
+        )
+
+    # Ensure name isn't empty after sanitization
+    if not sanitized_name:
+        sanitized_name = "Table1"
+        print("The table name was completely invalid or empty. Replaced with 'Table1'.")
+
+    return sanitized_name

bedrock_ge/plot.py

@@ -0,0 +1,2 @@
+def hello_plt() -> None:
+    print("Hello from src/bedrock/plot.py!")

{bedrock_ge-0.2.0.dist-info → bedrock_ge-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bedrock-ge
-Version: 0.2.0
+Version: 0.2.1
 Summary: Bedrock, the Open Source Foundation for Ground Engineering
 Project-URL: Homepage, https://bedrock.engineer/
 Project-URL: Source, https://github.com/bedrock-engineer/bedrock-ge

bedrock_ge-0.2.1.dist-info/RECORD

@@ -0,0 +1,21 @@
+bedrock_ge/__init__.py,sha256=TiCwiii4nnwQ5cVDKNEfUCwTzspLkydhtOtFuHA68yw,89
+bedrock_ge/plot.py,sha256=hUxpZXWlUmf2Ec5CKkGkOBJ_TfC1KM8yUeuMtsqk7A0,70
+bedrock_ge/gi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bedrock_ge/gi/bedrock-gi-schema.json,sha256=XaumYqouiflu4Nc8ChyFSHpmpJW4YPG0hsyeSxkuIWQ,850
+bedrock_ge/gi/concatenate.py,sha256=kdK6TRu6dzUKeRALAqP3Az75PDTROe3rXfUaMXrCu-c,1462
+bedrock_ge/gi/gis_geometry.py,sha256=f-J0OYQoi-ZXGslbo5qSXaBYphIpDB_igtUVMKi3Rzw,9316
+bedrock_ge/gi/schemas.py,sha256=ZA2wFQOevXtN57XglY-M70TzbZY2RyLHJDRUkmz47_M,2871
+bedrock_ge/gi/sqlmodels.py,sha256=_h3H9UP91I_1Ya_SZuL6gZbqL7uNCd5Y-u-yTf7CNto,2253
+bedrock_ge/gi/validate.py,sha256=km5PeAUDRQr_RhwUG606I0SAdNrHmMA0RYpg7TU95Dc,4664
+bedrock_ge/gi/write.py,sha256=vSHcj3xfWTyFJCa065Xfu4PBZddCPrYZ7MeW9M8PoUM,3863
+bedrock_ge/gi/ags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bedrock_ge/gi/ags/ags3_data_dictionary.json,sha256=Wx20_oJRdAlzEo-cKD6FgN9B9zOMDTcsp5dgc8QWofI,188588
+bedrock_ge/gi/ags/ags4_data_dictionary.json,sha256=XE5XJNo8GBPZTUPgvVr3QgO1UfEIAxzlSeXi-P1VLTs,609670
+bedrock_ge/gi/ags/read.py,sha256=ebBHfU-w0BkjvcfmmmBxJx-PyziBRNm_4Okzvvqime8,7078
+bedrock_ge/gi/ags/schemas.py,sha256=y36n9SCKqFfoIQ_7-MTEdfArA5vAqZdRpY3wC4fdjy4,7451
+bedrock_ge/gi/ags/transform.py,sha256=EFCVnxRkLUT4mpmG5y_Bz4rNeTAAgolVfGGANMf29-E,8015
+bedrock_ge/gi/ags/validate.py,sha256=Wghxm0dFGQB-6qrsbxOf68YalnPdJ6oeCXZJ7xrYVHI,703
+bedrock_ge-0.2.1.dist-info/METADATA,sha256=PInDVd89ZxniGjAgO3Na0AUp9UaDP4ZJKFkgE268_FU,13712
+bedrock_ge-0.2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bedrock_ge-0.2.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+bedrock_ge-0.2.1.dist-info/RECORD,,

bedrock_ge-0.2.0.dist-info/RECORD

@@ -1,4 +0,0 @@
-bedrock_ge-0.2.0.dist-info/METADATA,sha256=D3sGpuyeQc2RhQeAYUTPFROyZRhBlKkdIMkv6dB1hnY,13712
-bedrock_ge-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-bedrock_ge-0.2.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-bedrock_ge-0.2.0.dist-info/RECORD,,