bedrock-ge 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

bedrock_ge/__init__.py

@@ -1,3 +1,3 @@
 """Bedrock, the open source foundation for ground engineering."""
 
-__version__ = "0.2.2"
+__version__ = "0.2.4"

bedrock_ge/gi/ags/read.py

@@ -8,8 +8,7 @@ from bedrock_ge.gi.ags.validate import check_ags_proj_group
 
 
 def ags_to_dfs(ags_data: str) -> Dict[str, pd.DataFrame]:
-    """
-    Convert AGS 3 or AGS 4 data to a dictionary of pandas DataFrames.
+    """Converts AGS 3 or AGS 4 data to a dictionary of pandas DataFrames.
 
     Args:
         ags_data (str): The AGS data as a string.
@@ -19,7 +18,7 @@ def ags_to_dfs(ags_data: str) -> Dict[str, pd.DataFrame]:
 
     Returns:
         Dict[str, pd.DataFrame]]: A dictionary where keys represent AGS group
-        names with corresponding DataFrames for the corresponding group data.
+            names with corresponding DataFrames for the corresponding group data.
     """
     # Process each line to find the AGS version and delegate parsing
     for line in ags_data.splitlines():
@@ -52,16 +51,16 @@ def ags_to_dfs(ags_data: str) -> Dict[str, pd.DataFrame]:
 
 
 def ags3_to_dfs(ags3_data: str) -> Dict[str, pd.DataFrame]:
-    """Convert AGS 3 data to a dictionary of pandas DataFrames.
+    """Converts AGS 3 data to a dictionary of pandas DataFrames.
 
     Args:
-        ags_data (str): The AGS 3 data as a string.
+        ags3_data (str): The AGS 3 data as a string.
 
     Returns:
-        Dict[str, pd.DataFrame]: A dictionary of pandas DataFrames, where each key represents a group name from AGS 3 data,
-        and the corresponding value is a pandas DataFrame containing the data for that group.
+        Dict[str, pd.DataFrame]: A dictionary of pandas DataFrames, where each key
+            represents a group name from AGS 3 data, and the corresponding value is a
+            pandas DataFrame containing the data for that group.
     """
-
     # Initialize dictionary and variables used in the AGS 3 read loop
     ags3_dfs = {}
     line_type = "line_0"
@@ -152,14 +151,15 @@ def ags3_to_dfs(ags3_data: str) -> Dict[str, pd.DataFrame]:
 
 
 def ags4_to_dfs(ags4_data: str) -> Dict[str, pd.DataFrame]:
-    """Convert AGS 4 data to a dictionary of pandas DataFrames.
+    """Converts AGS 4 data to a dictionary of pandas DataFrames.
 
     Args:
-        ags_data (str): The AGS 4 data as a string.
+        ags4_data (str): The AGS 4 data as a string.
 
     Returns:
-        Dict[str, pd.DataFrame]: A dictionary of pandas DataFrames, where each key represents a group name from AGS 4 data,
-        and the corresponding value is a pandas DataFrame containing the data for that group.
+        Dict[str, pd.DataFrame]: A dictionary of pandas DataFrames, where each key 
+            represents a group name from AGS 4 data, and the corresponding value is a
+            pandas DataFrame containing the data for that group.
     """
     # AGS4.AGS4_to_dataframe accepts the file, not the data string
     ags4_file = io.StringIO(ags4_data)

bedrock_ge/gi/ags/transform.py

@@ -1,4 +1,4 @@
-"""Transforms, i.e. maps, AGS data to Bedrock's schema"""
+"""Transforms, i.e. maps, AGS data to Bedrock's schema."""
 
 from typing import Dict
 
@@ -12,9 +12,43 @@ from bedrock_ge.gi.schemas import BaseInSitu, BaseLocation, BaseSample, Project
 from bedrock_ge.gi.validate import check_foreign_key
 
 
+# What this function really does, is add the CRS and Bedrock columns:
+# - `project_uid`
+# - `location_uid`
+# - `sample_id`
+# - `sample_uid`
+# - `depth_to_`
+# There really isn't any mapping going on here...
+# TODO: Make sure that the name of the function and docstrings reflect this.
 def ags3_db_to_no_gis_brgi_db(
     ags3_db: Dict[str, pd.DataFrame], crs: CRS
 ) -> Dict[str, pd.DataFrame]:
+    """Maps a database with GI data from a single AGS 3 file to a database with Bedrock's schema.
+
+    This function converts an AGS 3 formatted geotechnical database into Bedrock's
+    internal database format, maintaining data relationships and structure. It handles
+    various types of geotechnical data including project information, locations,
+    samples, lab tests, and in-situ measurements.
+
+    The mapping process:
+    1. Project Data: Converts AGS 3 'PROJ' group to Bedrock's 'Project' table
+    2. Location Data: Converts AGS 3 'HOLE' group to Bedrock's 'Location' table
+    3. Sample Data: Converts AGS 3 'SAMP' group to Bedrock's 'Sample' table
+    4. Other Data: Handles lab tests, in-situ measurements, and miscellaneous tables
+
+    Args:
+        ags3_db (Dict[str, pd.DataFrame]): A dictionary containing AGS 3 data tables,
+            where keys are table names and values are pandas DataFrames.
+        crs (CRS): Coordinate Reference System for the project data.
+
+    Returns:
+        Dict[str, pd.DataFrame]: A dictionary containing Bedrock GI database tables,
+            where keys are table names and values are transformed pandas DataFrames.
+
+    Note:
+        The function creates a copy of the input database to avoid modifying the original data.
+        It performs foreign key checks to maintain data integrity during the mapping.
+    """
     # Make sure that the AGS 3 database is not changed outside this function.
     ags3_db = ags3_db.copy()
 
@@ -134,7 +168,7 @@ def ags3_samp_to_brgi_sample(
 def ags3_in_situ_to_brgi_in_situ(
     group_name: str, ags3_in_situ: pd.DataFrame, project_uid: str
 ) -> DataFrame[BaseInSitu]:
-    """Transform, i.e. map, AGS 3 in-situ measurement data to Bedrock's in-situ data schema.
+    """Maps AGS 3 in-situ measurement data to Bedrock's in-situ data schema.
 
     Args:
         group_name (str): The AGS 3 group name.

bedrock_ge/gi/ags/validate.py

@@ -5,7 +5,7 @@ def check_ags_proj_group(ags_proj: pd.DataFrame) -> bool:
     """Checks if the AGS 3 or AGS 4 PROJ group is correct.
 
     Args:
-        proj_df (pd.DataFrame): The DataFrame with the PROJ group.
+        ags_proj (pd.DataFrame): The DataFrame with the PROJ group.
 
     Raises:
         ValueError: If AGS 3 of AGS 4 PROJ group is not correct.
@@ -13,7 +13,6 @@ def check_ags_proj_group(ags_proj: pd.DataFrame) -> bool:
     Returns:
         bool: Returns True if the AGS 3 or AGS 4 PROJ group is correct.
     """
-
     if len(ags_proj) != 1:
         raise ValueError("The PROJ group must contain exactly one row.")
 

bedrock_ge/gi/concatenate.py

@@ -8,20 +8,20 @@ def concatenate_databases(
     db1: Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]],
     db2: Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]],
 ) -> Dict[str, pd.DataFrame]:
-    """
-    Concatenate two dictionaries of pandas dataframes into one dict of dfs.
+    """Concatenates two dictionaries of DataFrames into one dict of DataFrames.
 
-    The function concatenates the pandas dataframes of the second dict of dfs to the first dict of df for the keys that they have in common.
-    Keys that don't occur in either of the dict of dfs need to end up in the final dict of dfs.
+    The function concatenates the pandas DataFrames of the second dict of
+    DataFrames to the first dict of DataFrames for the keys they have in common.
+    Keys that are unique to either dictionary will be included in the final
+    concatenated dictionary.
 
     Args:
         db1 (Dict[str, pd.DataFrame]): A dictionary of pandas DataFrames, i.e. a database.
         db2 (Dict[str, pd.DataFrame]): A dictionary of pandas DataFrames, i.e. a database.
 
     Returns:
-        dict: A dictionary of concatenated pandas DataFrames.
+        concatenated_dict (Dict[str, pd.DataFrame]): A dictionary of concatenated pandas DataFrames.
     """
-
     # Create a new dict to store the concatenated dataframes
     concatenated_dict = {key: df.dropna(axis=1, how="all") for key, df in db1.items()}
 

bedrock_ge/gi/gis_geometry.py

@@ -12,11 +12,42 @@ from shapely.geometry import LineString, Point
 
 def calculate_gis_geometry(
     no_gis_brgi_db: Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]],
+    verbose: bool = True,
 ) -> Dict[str, gpd.GeoDataFrame]:
+    """Calculates GIS geometry for tables in a Bedrock Ground Investigation database.
+
+    This function processes a dictionary of DataFrames containing Ground Investigation (GI) data,
+    adding appropriate GIS geometry to each table. It handles both 2D and 3D geometries,
+    including vertical boreholes and sampling locations.
+
+    Args:
+        no_gis_brgi_db (Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]]): Dictionary containing
+            the Bedrock GI database tables without GIS geometry. Keys are table names,
+            values are either pandas DataFrames or GeoDataFrames.
+        verbose (bool, optional): Whether to print progress information. Defaults to True.
+
+    Returns:
+        Dict[str, gpd.GeoDataFrame]: Dictionary containing the Bedrock GI database tables
+            with added GIS geometry. All tables are converted to GeoDataFrames with
+            appropriate CRS and geometry columns.
+
+    Raises:
+        ValueError: If the projects in the database use different Coordinate Reference Systems (CRS).
+
+    Note:
+        The function performs the following operations:
+
+        1. Verifies all projects use the same CRS
+        2. Calculates GIS geometry for the 'Location' table
+        3. Creates a 'LonLatHeight' table for 2D visualization
+        4. Processes 'Sample' table if present
+        5. Processes all tables starting with "InSitu_"
+    """
     # Make sure that the Bedrock database is not changed outside this function.
     brgi_db = no_gis_brgi_db.copy()
 
-    print("Calculating GIS geometry for the Bedrock GI database tables...")
+    if verbose:
+        print("Calculating GIS geometry for the Bedrock GI database tables...")
 
     # Check if all projects have the same CRS
     if not brgi_db["Project"]["crs_wkt"].nunique() == 1:
@@ -28,7 +59,8 @@ def calculate_gis_geometry(
     crs = CRS.from_wkt(brgi_db["Project"]["crs_wkt"].iloc[0])
 
     # Calculate GIS geometry for the 'Location' table
-    print("Calculating GIS geometry for the Bedrock GI 'Location' table...")
+    if verbose:
+        print("Calculating GIS geometry for the Bedrock GI 'Location' table...")
     brgi_db["Location"] = calculate_location_gis_geometry(brgi_db["Location"], crs)
 
     # Create the 'LonLatHeight' table.
@@ -36,11 +68,12 @@ def calculate_gis_geometry(
     # because vertical lines are often very small or completely hidden in 2D.
     # This table only contains the 3D of the GI locations at ground level,
     # in WGS84 (Longitude, Latitude, Height) coordinates.
-    print(
-        "Creating 'LonLatHeight' table with GI locations in WGS84 geodetic coordinates...",
-        "    WGS84 geodetic coordinates: (Longitude, Latitude, Ground Level Ellipsoidal Height)",
-        sep="\n",
-    )
+    if verbose:
+        print(
+            "Creating 'LonLatHeight' table with GI locations in WGS84 geodetic coordinates...",
+            "    WGS84 geodetic coordinates: (Longitude, Latitude, Ground Level Ellipsoidal Height)",
+            sep="\n",
+        )
     brgi_db["LonLatHeight"] = create_lon_lat_height_table(brgi_db["Location"], crs)
 
     # Create GIS geometry for tables that have In-Situ GIS geometry.
@@ -48,16 +81,18 @@ def calculate_gis_geometry(
     # These tables are children of the Location table,
     # i.e. have the 'Location' table as the parent table.
     if "Sample" in brgi_db.keys():
-        print("Calculating GIS geometry for the Bedrock GI 'Sample' table...")
+        if verbose:
+            print("Calculating GIS geometry for the Bedrock GI 'Sample' table...")
         brgi_db["Sample"] = calculate_in_situ_gis_geometry(
             brgi_db["Sample"], brgi_db["Location"], crs
         )
 
     for table_name, table in brgi_db.items():
         if table_name.startswith("InSitu_"):
-            print(
-                f"Calculating GIS geometry for the Bedrock GI '{table_name}' table..."
-            )
+            if verbose:
+                print(
+                    f"Calculating GIS geometry for the Bedrock GI '{table_name}' table..."
+                )
             brgi_db[table_name] = calculate_in_situ_gis_geometry(
                 table, brgi_db["Location"], crs
             )
@@ -68,20 +103,19 @@ def calculate_gis_geometry(
 def calculate_location_gis_geometry(
     brgi_location: Union[pd.DataFrame, gpd.GeoDataFrame], crs: CRS
 ) -> gpd.GeoDataFrame:
-    """
-    Calculate GIS geometry for a set of Ground Investigation locations.
+    """Calculates GIS geometry for a set of Ground Investigation locations.
 
     Args:
         brgi_location (Union[pd.DataFrame, gpd.GeoDataFrame]): The GI locations to calculate GIS geometry for.
         crs (pyproj.CRS): The Coordinate Reference System (CRS) to use for the GIS geometry.
 
     Returns:
-        gpd.GeoDataFrame: The GIS geometry for the given GI locations, with *additional* columns:
-            longitude: The longitude of the location in the WGS84 CRS.
-            latitude: The latitude of the location in the WGS84 CRS.
-            wgs84_ground_level_height: The height of the ground level of the location in the WGS84 CRS.
-            elevation_at_base: The elevation at the base of the location.
-            geometry: The GIS geometry of the location.
+        gpd.GeoDataFrame: The GIS geometry for the given GI locations, with additional columns:
+            - longitude: The longitude of the location in the WGS84 CRS.
+            - latitude: The latitude of the location in the WGS84 CRS.
+            - wgs84_ground_level_height: The height of the ground level of the location in the WGS84 CRS.
+            - elevation_at_base: The elevation at the base of the location.
+            - geometry: The GIS geometry of the location.
     """
     # Calculate Elevation at base of GI location
     brgi_location["elevation_at_base"] = (
@@ -122,9 +156,8 @@ def calculate_location_gis_geometry(
 
 def calculate_wgs84_coordinates(
     from_crs: CRS, easting: float, northing: float, elevation: Union[float, None] = None
-) -> Tuple:
-    """Transform coordinates from an arbitrary Coordinate Reference System (CRS) to
-    the WGS84 CRS, which is the standard for geodetic coordinates.
+) -> Tuple[float, float, (float | None)]:
+    """Transforms coordinates from an arbitrary Coordinate Reference System (CRS) to the WGS84 CRS, which is the standard for geodetic coordinates.
 
     Args:
         from_crs (pyproj.CRS): The pyproj.CRS object of the CRS to transform from.
@@ -134,9 +167,10 @@ def calculate_wgs84_coordinates(
             transform. Defaults to None.
 
     Returns:
-        tuple: A tuple containing the longitude, latitude and WGS84 height of the
-            transformed point, in that order. The height is None if no elevation was
-            given, or if the provided CRS doesn't have a proper datum defined.
+        Tuple[float, float, (float | None)]: A tuple containing the longitude, latitude
+            and WGS84 height of the transformed point, in that order.
+            The height is None if no elevation was given, or if the provided CRS doesn't
+            have a proper datum defined.
     """
     transformer = Transformer.from_crs(from_crs, 4326, always_xy=True)
     if elevation:
@@ -145,13 +179,13 @@ def calculate_wgs84_coordinates(
         lon, lat = transformer.transform(easting, northing)
         wgs84_height = None
 
-    return lon, lat, wgs84_height
+    return (lon, lat, wgs84_height)
 
 
 def create_lon_lat_height_table(
     brgi_location: gpd.GeoDataFrame, crs: CRS
 ) -> gpd.GeoDataFrame:
-    """Create a GeoDataFrame with GI locations in WGS84 (lon, lat, height) coordinates.
+    """Creates a GeoDataFrame with GI locations in WGS84 (lon, lat, height) coordinates.
 
     The 'LonLatHeight' table makes it easier to visualize the GIS geometry on 2D maps,
     because vertical lines are often very small or completely hidden in 2D. This table
@@ -165,7 +199,7 @@ def create_lon_lat_height_table(
         crs (CRS): The Coordinate Reference System of the GI locations.
 
     Returns:
-        GeoDataFrame: The 'LonLatHeight' GeoDataFrame.
+        gpd.GeoDataFrame: The 'LonLatHeight' GeoDataFrame.
     """
     lon_lat_height = gpd.GeoDataFrame(
         brgi_location[
@@ -190,6 +224,19 @@ def calculate_in_situ_gis_geometry(
     brgi_location: Union[pd.DataFrame, gpd.GeoDataFrame],
     crs: CRS,
 ) -> gpd.GeoDataFrame:
+    """Calculates GIS geometry for a set of Ground Investigation in-situ data.
+
+    Args:
+        brgi_in_situ (Union[pd.DataFrame, gpd.GeoDataFrame]): The in-situ data to calculate GIS geometry for.
+        brgi_location (Union[pd.DataFrame, gpd.GeoDataFrame]): The location data to merge with the in-situ data.
+        crs (CRS): The Coordinate Reference System of the in-situ data.
+
+    Returns:
+        gpd.GeoDataFrame: The GIS geometry for the given in-situ data, with additional columns:
+            - elevation_at_top: The elevation at the top of the in-situ data.
+            - elevation_at_base: The elevation at the base of the in-situ data.
+            - geometry: The GIS geometry of the in-situ data.
+    """
     location_child = brgi_in_situ.copy()
 
     # Merge the location data into the in-situ data to get the location coordinates

bedrock_ge/gi/validate.py

@@ -14,7 +14,38 @@ from bedrock_ge.gi.schemas import (
 )
 
 
-def check_brgi_database(brgi_db: Dict):
+# TODO: rename to check_brgi_geodb
+# TODO: make this check actually work...
+def check_brgi_database(brgi_db: Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]]):
+    """Validates the structure and relationships of a 'Bedrock Ground Investigation' (BRGI) database (which is a dictionary of DataFrames).
+
+    This function checks that all tables in the BRGI database conform to their respective schemas
+    and that all foreign key relationships are properly maintained. It validates the following tables:
+    - Project
+    - Location
+    - Sample
+    - InSitu_TESTX
+    - Lab_TESTY (not yet implemented)
+
+    Args:
+        brgi_db (Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]]): A dictionary
+            containing the BRGI database tables, where keys are table names and
+            values are the corresponding data tables (DataFrame or GeoDataFrame).
+
+    Returns:
+        is_valid (bool): True if all tables are valid and relationships are properly maintained.
+
+    Example:
+        ```python
+        brgi_db = {
+            "Project": project_df,
+            "Location": location_gdf,
+            "Sample": sample_gdf,
+            "InSitu_ISPT": in_situ_ispt_gdf,
+        }
+        check_brgi_database(brgi_db)
+        ```
+    """
     for table_name, table in brgi_db.items():
         if table_name == "Project":
             Project.validate(table)
@@ -28,6 +59,9 @@ def check_brgi_database(brgi_db: Dict):
             check_foreign_key("project_uid", brgi_db["Project"], table)
             check_foreign_key("location_uid", brgi_db["Location"], table)
             print("'Sample' table aligns with Bedrock's 'Sample' table schema.")
+        # ! JG is pretty sure that this doesn't work
+        # ! The line below should be:
+        # ! elif table_name.startswith("InSitu_"):
         elif table_name == "InSitu":
             InSitu.validate(table)
             check_foreign_key("project_uid", brgi_db["Project"], table)
@@ -43,7 +77,39 @@ def check_brgi_database(brgi_db: Dict):
     return True
 
 
-def check_no_gis_brgi_database(brgi_db: Dict):
+# TODO: rename to check_brgi_db
+def check_no_gis_brgi_database(
+    brgi_db: Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]],
+):
+    """Validates the structure and relationships of a 'Bedrock Ground Investigation' (BGI) database without GIS geometry.
+
+    This function performs the same validation as `check_brgi_database` but uses schemas
+    that don't require GIS geometry. It validates the following tables:
+    - Project (never has GIS geometry)
+    - Location (without GIS geometry)
+    - Sample (without GIS geometry)
+    - InSitu_TESTX (without GIS geometry)
+    - Lab_TESTY (not yet implemented)
+
+    Args:
+        brgi_db (Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]]): A dictionary
+            containing the Bedrock GI database tables, where keys are table names
+            and values are the corresponding data tables (DataFrame or GeoDataFrame).
+
+    Returns:
+        bool: True if all tables are valid and relationships are properly maintained.
+
+    Example:
+        ```python
+        brgi_db = {
+            "Project": projects_df,
+            "Location": locations_df,
+            "Sample": samples_df,
+            "InSitu_measurements": insitu_df,
+        }
+        check_no_gis_brgi_database(brgi_db)
+        ```
+    """
     for table_name, table in brgi_db.items():
         if table_name == "Project":
             Project.validate(table)
@@ -81,26 +147,26 @@ def check_foreign_key(
     parent_table: Union[pd.DataFrame, gpd.GeoDataFrame],
     table_with_foreign_key: Union[pd.DataFrame, gpd.GeoDataFrame],
 ) -> bool:
-    """
-    Checks if a foreign key in a table exists in the parent table.
+    """Validates referential integrity between two tables by checking foreign key relationships.
 
-    Foreign keys describe the relationship between tables in a relational database.
-    For example, all GI Locations belong to a project.
-    All GI Locations are related to a project with the project_uid (Project Unique IDentifier).
-    The project_uid is the foreign key in the Location table.
-    This implies that the project_uid in the foreign key in the Location table must exist in the Project parent table.
-    That is what this function checks.
+    This function ensures that all foreign key values in a child table exist in the corresponding
+    parent table, maintaining data integrity in the GIS database.
 
     Args:
-        foreign_key (str): The name of the column of the foreign key.
-        parent_table (Union[pd.DataFrame, gpd.GeoDataFrame]): The parent table.
-        table_with_foreign_key (Union[pd.DataFrame, gpd.GeoDataFrame]): The table with the foreign key.
+        foreign_key (str): The name of the column that serves as the foreign key.
+        parent_table (Union[pd.DataFrame, gpd.GeoDataFrame]): The parent table containing the primary keys.
+        table_with_foreign_key (Union[pd.DataFrame, gpd.GeoDataFrame]): The child table containing the foreign keys.
+
+    Returns:
+        bool: True if all foreign keys exist in the parent table.
 
     Raises:
-        ValueError: If the table with the foreign key contains foreign keys that don't occur in the parent table.
+        ValueError: If any foreign key values in the child table do not exist in the parent table.
 
-    Returns:
-        bool: True if the foreign keys all exist in the parent table.
+    Example:
+        ```python
+        check_foreign_key("project_uid", projects_df, locations_df)
+        ```
     """
     # Get the foreign keys that are missing in the parent group
     missing_foreign_keys = table_with_foreign_key[

bedrock_ge/gi/write.py

@@ -9,19 +9,21 @@ 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.
+    """Writes a database 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.
+    Writes a dictionary of DataFrames containing Bedrock Ground Investigation data to a
+    [GeoPackage file](https://www.geopackage.org/). Each DataFrame will be saved in a
+    separate table named by the keys of the dictionary.
 
     Args:
-        brgi_dfs (dict): A dictionary where keys are brgi table names and values are DataFrames with brgi data.
+        brgi_db (Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]]): A dictionary where
+            keys are brgi table names and values are pandas DataFrames or GeoDataFrames
+            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.
+        None
     """
-
     # 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)
@@ -38,26 +40,27 @@ def write_gi_db_to_gpkg(
 
 
 def write_gi_db_to_excel(
-    gi_db: Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]],
+    gi_dfs: 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.
+    """Writes a database 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.
+    Each DataFrame in the database dictionary will be saved in a separate Excel sheet named
+    after the dictionary keys. This 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.
+        gi_dfs (Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]]): A dictionary where
+            keys are GI table names and values are DataFrames with GI data.
+        excel_path (Union[str, Path]): Path to the output Excel file. Can be provided as a
+            string or Path object.
 
     Returns:
-        None: This function does not return any value. It writes the DataFrames to an Excel file.
+        None
     """
-
     # Create an Excel writer object
     with pd.ExcelWriter(excel_path, engine="openpyxl") as writer:
-        for sheet_name, df in gi_db.items():
+        for sheet_name, df in gi_dfs.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)
@@ -65,16 +68,18 @@ def write_gi_db_to_excel(
     print(f"Ground Investigation data has been written to '{excel_path}'.")
 
 
+# TODO: Make the 31 character table name length truncation a separate function. Only necessary for Excel.
 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.
+    """Replaces invalid characters and spaces in GI table names with underscores and truncates to 31 characters.
+
+    Makes table names consistent with SQL, GeoPackage and Excel naming conventions by
+    replacing invalid characters and spaces with underscores.
 
     Args:
         sheet_name (str): The original sheet name.
 
     Returns:
-        str: A sanitized sheet name with invalid characters and spaces replaced.
+        sanitized_name (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]
@@ -98,6 +103,7 @@ def sanitize_table_name(sheet_name):
         )
 
     # Ensure name isn't empty after sanitization
+    # ! "Table1" doesn't make a lot of sense?!? It could be that there are more than 1 table without a name...
     if not sanitized_name:
         sanitized_name = "Table1"
         print("The table name was completely invalid or empty. Replaced with 'Table1'.")

bedrock_ge/plot.py

@@ -1,2 +1,4 @@
 def hello_plt() -> None:
-    print("Hello from src/bedrock/plot.py!")
+    print(
+        "Hi Bedrock engineer! bedrock_ge.plot is a placeholder module for Geotechnical Engineering plots."
+    )

bedrock_ge-0.2.4.dist-info/METADATA

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: bedrock-ge
+Version: 0.2.4
+Summary: Bedrock's Python library for geotechnical engineering.
+Project-URL: Homepage, https://bedrock.engineer/
+Project-URL: Source, https://github.com/bedrock-engineer/bedrock-ge
+Project-URL: Documentation, https://bedrock.engineer/docs/
+Project-URL: Tracker, https://github.com/bedrock-engineer/bedrock-ge/issues
+Author-email: Bedrock <info@bedrock.engineer>
+License: Apache Software License (Apache 2.0)
+License-File: LICENSE
+Keywords: aec,aeco,ags,ags3,ags4,bedrock,bim,borehole,borehole-data,civil-engineering,engineering-geology,geo-bim,geoscience-bim,geosciences,geospatial,geospatial-data,geostatistics,geotech,geotechnical,geotechnical-data,geotechnical-engineering,geotechnics,gi-data,gis,ground-engineering,ground-investigation,ground-investigation-data,subsurface,underground
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.9
+Requires-Dist: geopandas~=1.0
+Requires-Dist: openpyxl~=3.0
+Requires-Dist: pandera>=0.23.0
+Requires-Dist: python-ags4~=1.0
+Requires-Dist: sqlmodel>=0.0.22
+Description-Content-Type: text/markdown
+
+<figure style="margin-inline: block;">
+  <img src="https://bedrock.engineer/public/Bedrock_TextRight.png" alt="Bedrock logo" width="75%"/>
+</figure>
+
+<h3 style="margin-inline: block;">Bedrock, the Open Source Foundation for Geotechnical Engineering</h3>
+
+---
+
+🌐 **Website:** <https://bedrock.engineer/>
+
+📃 **Documentation:** <https://bedrock.engineer/docs>
+
+📃 **API Reference:** <https://bedrock.engineer/reference/>
+
+🖥️ **Source Code:** <https://github.com/bedrock-engineer/bedrock-ge>
+
+🐍 **`bedrock-ge` on PyPI:** <https://pypi.org/project/bedrock-ge/>
+
+🔗 **LinkedIn:** <https://www.linkedin.com/company/bedrock-engineer>
+
+---
+
+## Overview
+
+> **Definition of Bedrock**
+>
+> In an abstract sense, the bedrock refers to the main principles something is based on. [1]
+>
+> In the real world, the bedrock is the hard area of rock in the ground that holds up the loose soil above. [1]
+>
+> In many civil engineering projects, the identification of the bedrock through digging, drilling or geophysical methods is an important task, which greatly influences (geotechnical) design. [2]
+>
+> Sources: [[1] Bedrock | Cambridge Dictionary](https://dictionary.cambridge.org/us/dictionary/english/bedrock), [[2] Bedrock | Wikipedia](https://en.wikipedia.org/wiki/Bedrock)
+
+Ground Investigation (GI) data is often trapped in legacy formats that limit analysis and visualization possibilities.
+`bedrock-ge` lets you transform this data from specialized geotechnical formats and common tabular formats (Excel, CSV) into modern, standardized geospatial data.
+
+This standardization lets you bridge the gap between raw geotechnical data, the modern Python (geo)scientific ecosystem and modern geospatial tools.
+This gives geotechnical engineers greater flexibility in visualization, modeling, and integration across different software environments while avoiding vendor lock-in.
+For example, this enables connecting your GI data with GIS as well as BIM environments through [platforms like Speckle](#-put-your-gi-data-into-speckle).
+
+The purpose of Bedrock is NOT to become THE standard for geotechnical data, because [we don't need 15 instead of 14 competing standards](https://xkcd.com/927/). 
+
+## Highlights
+
+### 📖 Read / write Ground Investigation (GI) data in different formats
+
+| Data Format | Read | Write |
+| ----------- | ---- | ----- |
+| AGS 3       | ✅   | ❌    |
+| AGS 4       | ✅   | ✅    |
+| Excel       | ✅   | ✅    |
+| CSV         | ✅   | ✅    |
+| JSON        | ✅   | ✅    |
+| GeoJSON     | ✅   | ✅    |
+
+Do you need another format? Like [DIGGS](https://diggsml.org/), [NADAG](https://www.ngu.no/geologisk-kartlegging/om-nadag-nasjonal-database-grunnundersokelser), [GEF](https://publicwiki.deltares.nl/display/STREAM/Dutch+National+GEF+Standards), or something else?
+Let us know by creating an [issue](https://github.com/bedrock-engineer/bedrock-ge/issues) or starting a [discussion](https://github.com/orgs/bedrock-engineer/discussions).
+
+Also, if you have a project with publicly available GI data, please share that in a [discussion](https://github.com/orgs/bedrock-engineer/discussions), such that we can create a tutorial from it.
+
+### ✅ Validate your GI data
+
+`bedrock-ge` comes with data validation to make sure that you can combine Ground Investigation data from multiple files into a single geospatial database with consistent relationships between GI locations, samples, in-situ measurements and lab tests.
+
+This data validation mechanism (based on [`pandera`](https://pandera.readthedocs.io/en/stable/)) is easily extensible, giving you the power to add your own data validation criteria.
+
+### 🗺️ Put your GI data from multiple files into a single 3D geospatial database
+
+For example, you can take GI data from 100 AGS files and combine them into a single a [GeoPackage](https://en.wikipedia.org/wiki/GeoPackage) ([like a Shapefile, but then waaay better](http://switchfromshapefile.org/)). Such a GeoPackage can then be loaded into ArcGIS, where you can visualize your GI data in 3D:
+
+<figure style="margin-inline: block; display: block;">
+  <img src="https://bedrock.engineer/public/images/KaiTak_BrGI_ArcGIS.webp" alt="Kai Tak, Hong Kong, 3D GI data visualization in ArcGIS" width="90%"/> 
+  <figcaption>
+  GI data in Kai Tak, Hong Kong. <a href="https://arcg.is/0r9DG9">Click here to explore for yourself.</a>
+</figcaption>
+</figure>
+
+### 🟦 Put your GI data into Speckle
+
+From ArcGIS or QGIS you can publish your GI data to [Speckle](https://speckle.systems/) and then visualize it together with your ground models and civil engineering designs:
+
+<figure style="margin-inline: block; display: block;">
+  <img src="https://bedrock.engineer/public/images/KaiTak_BrGI_Speckle.png" alt="Kai Tak, Hong Kong, data from many sources in Speckle." width="90%"/> 
+  <figcaption>
+  Models from Rhino, Revit, Civil3D + context & GI data from Q/ArcGIS. <a href="https://app.speckle.systems/projects/013aaf06e7/models/0fa0287ba8,1cbe68ed69,44c8d1ecae,7f9d99cae2,9535541c2b,a739490298,ff81bfa02b">Click here to explore for yourself.</a>
+</figcaption>
+</figure>
+
+<figure style="margin-inline: block; display: block;">
+  <img src="https://bedrock.engineer/public/images/WekaHills_Speckle.webp" alt="GI data, the derived Leapfrog ground model and a tunnel in Speckle." width="90%"/> 
+  <figcaption>
+  GI data, the derived Leapfrog ground model and a tunnel in Speckle. <a href="https://app.speckle.systems/projects/7a489ac0d4/models/$epsg:2193-7839%2Fgeo%2Fgeology-model,65b4cf97d5,9069ef2b2b">Click here to explore for yourself.</a>
+</figcaption>
+</figure>
+
+Moreover, your GI data becomes available in all the software that [Speckle has connectors for](https://app.speckle.systems/downloads).
+
+### 🔓 Free and Open Source Software
+
+`bedrock-ge` is Free and Open Source Software (FOSS), meaning it gives you full access to the code, and you can customize `bedrock-ge` to integrate with other tools and fit your workflows and project needs.
+
+As the name implies, FOSS is free to use, so you're not tied to expensive software licenses or locked into a specific software vendor.
+
+You can give [feedback](#-feedback) and [contribute](#-contributing), such that together we can build the tools we've always wanted and needed.
+
+## Installation
+
+We recommend to use [`uv`](https://docs.astral.sh/uv/) to manage Python for you.
+Using `uv`, you can add `bedrock-ge` to your Python project and install it in your project's virtual environment by running:
+
+```bash
+uv add bedrock-ge
+```
+
+It's also possible to install `bedrock-ge` from [PyPI](https://pypi.org/project/bedrock-ge/) (Python Packaging Index) using `pip`:
+
+```bash
+pip install bedrock-ge
+```
+
+## Feedback
+
+Got some feedback, a great idea, running into problems when working with Bedrock or just want to ask some questions?
+
+Please feel free to:
+
+1. Open an issue for feature requests or bug reports: [`bedrock-ge` issues](https://github.com/bedrock-engineer/bedrock-ge/issues),
+2. Start a discussion in this GitHub repo: [Bedrock discussions](https://github.com/orgs/bedrock-engineer/discussions),
+3. Or start a discussion on the Speckle community forum if that's more appropriate: [Speckle community forum](https://speckle.community/)
+
+All feedback and engagement with the Bedrock community is welcome.
+
+## Contributing
+
+Contributing isn't scary. Contributing isn't just about writing code:
+
+- Spread the word about Bedrock
+- Use Bedrock and provide [feedback](#-feedback)
+- Share how you use Bedrock
+- Help each other out, e.g. by replying to questions in the [discussions](https://github.com/orgs/bedrock-engineer/discussions) or [`bedrock-ge` issues](https://github.com/bedrock-engineer/bedrock-ge/issues)
+- Documentation and tutorials
+- Most pages on the [bedrock.engineer](https://bedrock.engineer/) website can be edited, so if you see a spelling mistake or have a suggestion on how to explain something better, click this button to make a contribition.
+
+<figure style="margin-inline: block;">
+  <img src="https://bedrock.engineer/public/images/EditThisPage.png" alt="Edit this page on GitHub button on bedrock.engineer" width="25%"/>
+</figure>
+
+- If you would like to contribute code, awesome!
+  Please create an [issue](https://github.com/bedrock-engineer/bedrock-ge/issues) for what you'd like to contribute. If you don't know how to get started, please indicate this in your issue, and we'll help you out.
+
+## Maintainers
+
+### Joost
+
+> I studied geotechnical engineering and applied geophysics and then worked for [Arup](https://www.arup.com/) for 4 years as a geotechnical engineer and [computational designer](https://www.arup.com/services/computational-and-parametric-design/).
+>
+> During my time at Arup I worked a lot on bringing computational design into the world of geotechnical engineering, and on [bridging the gaps between geotechnical engineering and structural engineering](https://www.linkedin.com/posts/joost-gevaert_lightbim-lightbim-lightbim-activity-7234726439835549697-3xdO).
+>
+> Bedrock is the Free and Open Source Software (FOSS) that I wish existed when I worked as a geotechnical engineer at Arup.
+
+### Jules
+
+> I studied Applied Geoscience (Petroleum Engineering Reservoir Geology) but frustration with technical software led me to learn to code and as a result, I mostly worked in software development.
+>
+> Over the past 5 years, I’ve worked on data-rich applications across various domains, specifically in frontend development.
+> My primary interest is figuring out how to build tools for more thoughtful display and processing of technical information, for geoscience in particular.
+
+## Contributors
+
+Please take a look at the [contributors page](https://github.com/bedrock-engineer/bedrock-ge/graphs/contributors).
+
+## Professional Support
+
+While `bedrock-ge` is an Free Open Source Software (FOSS) project, you might be looking for professional support implementing it, contact <info@bedrock.engineer> for more information.

bedrock_ge-0.2.4.dist-info/RECORD

@@ -0,0 +1,21 @@
+bedrock_ge/__init__.py,sha256=9zw1B8qBymbOqc4p2OJ3e8chmXEihHSBt1Fs1BtnvkQ,89
+bedrock_ge/plot.py,sha256=C95aj8CXjFVZRGYYBssJMm5MyljLbdt_TKyvmQyWZBE,149
+bedrock_ge/gi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bedrock_ge/gi/brgi-schema.json,sha256=XaumYqouiflu4Nc8ChyFSHpmpJW4YPG0hsyeSxkuIWQ,850
+bedrock_ge/gi/concatenate.py,sha256=ewPXau86yDTGE92DlbNlQ7gprBHkqBottzHsPbXbEg0,1519
+bedrock_ge/gi/gis_geometry.py,sha256=QXNjWIGANh_M035Lbc94eOZnNry9f778E8wg_7KgAQo,11669
+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=riUa9AaHngJDX0VtUrOEKKfr-sZxybrGqJFmq4kRFnA,7080
+bedrock_ge/gi/write.py,sha256=eCfijylreJ5oNMJqqx_k-Y30FNIHys2NccHilrFm0X4,4319
+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=FCeMX1R7IGcZY0heqrHPzs13rytelkmmFaJRklPB7EM,7114
+bedrock_ge/gi/ags/schemas.py,sha256=y36n9SCKqFfoIQ_7-MTEdfArA5vAqZdRpY3wC4fdjy4,7451
+bedrock_ge/gi/ags/transform.py,sha256=NeeR6e3awDf3ITWSxAUW1bXspUXaj-dM7xi1g-Ppxhc,9988
+bedrock_ge/gi/ags/validate.py,sha256=ZfBS7AP_CTguLQCbGeyy4Krz32th2yCmtdG9rvX0MOU,703
+bedrock_ge-0.2.4.dist-info/METADATA,sha256=T2dwdFOQ2OLLEN_vNY_HQ_UVfX_iq1ATlbgDLVmXk7E,11727
+bedrock_ge-0.2.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bedrock_ge-0.2.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+bedrock_ge-0.2.4.dist-info/RECORD,,

bedrock_ge-0.2.2.dist-info/METADATA

@@ -1,227 +0,0 @@
-Metadata-Version: 2.4
-Name: bedrock-ge
-Version: 0.2.2
-Summary: Bedrock's Python library for geotechnical engineering.
-Project-URL: Homepage, https://bedrock.engineer/
-Project-URL: Source, https://github.com/bedrock-engineer/bedrock-ge
-Project-URL: Documentation, https://bedrock.engineer/docs/
-Project-URL: Tracker, https://github.com/bedrock-engineer/bedrock-ge/issues
-Author-email: Bedrock <info@bedrock.engineer>
-License: Apache Software License (Apache 2.0)
-License-File: LICENSE
-Keywords: aec,aeco,ags,ags3,ags4,bedrock,bim,borehole,borehole-data,civil-engineering,engineering-geology,geo-bim,geoscience-bim,geosciences,geospatial,geospatial-data,geostatistics,geotech,geotechnical,geotechnical-data,geotechnical-engineering,geotechnics,gi-data,gis,ground-engineering,ground-investigation,ground-investigation-data,subsurface,underground
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Education
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Scientific/Engineering :: GIS
-Requires-Python: >=3.9
-Requires-Dist: geopandas~=1.0
-Requires-Dist: openpyxl~=3.0
-Requires-Dist: pandera>=0.23.0
-Requires-Dist: python-ags4~=1.0
-Requires-Dist: sqlmodel>=0.0.22
-Description-Content-Type: text/markdown
-
-<p align="center">
-  <img src="https://bedrock.engineer/public/Bedrock_TextRight.png" alt="Bedrock logo" width="75%"/>
-</p>
-
-<h3 align="center">Bedrock, the Open Source Foundation for Ground Investigation Data</h3>
-
----
-
-📃 **Documentation:** <https://bedrock.engineer/docs>
-
-🖥️ **Source Code:** <https://github.com/bedrock-gi/bedrock-gi>
-
-🐍 **`bedrock-gi` on PyPI:** <https://pypi.org/project/bedrock-gi/>
-
-🌐 **Website:** <https://bedrock.engineer/>
-
-🔗 **LinkedIn:** <https://www.linkedin.com/company/bedrock-gi>
-
----
-
-## 🌟 Highlights
-
-### 📖 Read / write Ground Investigation (GI) data in different formats
-
-| Data Format | Read | Write |
-|-------------|------|-------|
-| AGS 3       | ✅  | ❌    |
-| AGS 4       | Soon | [python-ags4](https://pypi.org/project/python-AGS4/) |
-| Excel       | ✅  | ✅    |
-| CSV         | ✅  | ✅    |
-| JSON        | ✅  | ✅    |
-| GeoJSON     | ✅  | ✅    |
-
-What do you need? [DIGGS](https://diggsml.org/)? [NADAG](https://www.ngu.no/geologisk-kartlegging/om-nadag-nasjonal-database-grunnundersokelser)? [GEF](https://publicwiki.deltares.nl/display/STREAM/Dutch+National+GEF+Standards)?  Something else?  
-Let us know by creating an [issue](https://github.com/bedrock-gi/bedrock-gi/issues) or starting a [discussion](https://github.com/orgs/bedrock-gi/discussions) 💭
-
-Also, if you have a project with publicly available GI data, please share that in a [discussion](https://github.com/orgs/bedrock-gi/discussions), such that we can create a tutorial from it 🤩
-
-### ✅ Validate your GI data
-
-`bedrock-gi` comes with data validation to make sure that you can combine Ground Investigation data from multiple files into a single GIS database with consistent relationships between GI locations, samples, in-situ measurements and lab tests.
-
-This data validation mechanism (based on [`pandera`](https://pandera.readthedocs.io/en/stable/)) is easily extensible, giving you the power to add your own data validation criteria 💪
-
-### 🗺️ Put your GI data from multiple files into a single 3D GIS database
-
-For example, you can take GI data from 100 AGS files and combine them into a single a [GeoPackage](https://en.wikipedia.org/wiki/GeoPackage) ([like a Shapefile, but then waaay better](http://switchfromshapefile.org/)). Such a GeoPackage can then be loaded into ArcGIS, such that you can visualize your GI data in 3D:
-
-<p align="center">
-  <img src="https://bedrock.engineer/public/images/KaiTak_BrGI_ArcGIS.gif" alt="GI data visualization .gif in 3D in ArcGIS" width="90%"/>
-</p>
-
-### 🟦 Put your GI data into Speckle
-
-Once you have your GI data inside [Speckle](https://speckle.systems/), it's super easy to visualize GI data together with civil engineering designs:
-
-<p align="center">
-  <img src="https://bedrock.engineer/public/images/KaiTak_BrGI_Speckle.png" alt="Kai Tak, Hong Kong, data from many sources." width="56%" />
-  <img src="https://bedrock.engineer/public/images/BPFoundation.png" alt="Bored Pile foundation design." width="40%" />
-  <a href="https://app.speckle.systems/projects/013aaf06e7/models/0fa0287ba8@dfbec71408,1cbe68ed69@d3c4a34cff,44c8d1ecae@b962e2f29d,7f9d99cae2@bbed7cf165,9535541c2b@fafe06f9c0,a739490298@e858cc8cb3,ff81bfa02b@dda7c2f981" target="_blank">Click here to go to the Kai Tak Speckle project from the left image</a>
-</p>
-
-Moreover, your GI data becomes available in all the software that [Speckle has connectors for](https://app.speckle.systems/downloads).
-
-### 🔓 Free and Open Source Software
-
-Free and Open Source Software (FOSS) gives you full access to the code, which means you can customize `bedrock-gi` to integrate with other tools and fit your workflows & project needs.
-
-As the name implies, FOSS is free to use, so you're not tied to expensive software licenses or locked into a specific software vendor ⛓️‍💥
-
-You can give [feedback](#-feedback) and [contribute](#-contributing), such that together we together can build the tools we've always wanted and needed 🤝
-
-## ℹ️ Overview
-
-> **Definition of Bedrock**
->
-> In an abstract sense, the main principles on which something is based. [1]
->
-> In the real world, the bedrock is the hard area of rock in the ground that holds up the loose soil above. [1]
->
-> In many civil engineering projects, the identification of the bedrock through digging, drilling or geophysical methods is an important task, which greatly influences (foundation) design. [2]  
->
-> Sources: [[1] Bedrock | Cambridge Dictionary](https://dictionary.cambridge.org/us/dictionary/english/bedrock), [[2] Bedrock | Wikipedia](https://en.wikipedia.org/wiki/Bedrock)
-
-Bedrock, this open source software project, forms the foundation for for ground investigation data, subsurface modelling and Geo-BIM.
-
-With Bedrock you can get your data from any Ground Investigation data format into a GIS database 🗺️, from a GIS database into Speckle 🟦, and from Speckle into all the software we work with in the AEC industry 🏗️.
-
-The purpose of Bedrock is NOT to become THE standard for geotechnical data, because we don't need 15 instead of 14 competing standards:
-
-<p align="center">
-  <img src="https://bedrock.engineer/public/images/14Become15Standards.png" alt="14 competing standards become 15 competing standards | xkcd.com/927" width="60%"/>
-  <br>
-  Source: <a href="https://xkcd.com/927/" target="_blank">https://xkcd.com/927</a>
-</p>  
-
-For example, us geotechnical engineers who are used to working with AGS data know that the "ISPT group" is a table that describes an In-Situ Standard Penetration Test and we know what headings, i.e. columns that AGS group, i.e. table has. Therefore, Bedrock doesn't change that the naming of those columns. Bedrock just makes sure that the data is structured in a sensible way, such that Ground Investigation data from multiple sources can be converted into a GIS database.
-
-A GIS database with Ground Investigation data contains tables that describe the Ground Investigation `'Project'`, the `'Location'`s where GI data was collected, the `'Sample'`s and `'InSitu'` measurements taken at these `'Location'`s, and the `'Lab'` tests that were performed on the collected `'Sample'`s.
-
-The `'Project'`, `'Location'`, `'Sample'`, `'InSitu'` measurement and `'Lab'` test tables are related to each other: each lab test belongs to a sample, which belongs to a GI location, which belongs to a project. These relationships can be visualized in a hierarchy like this:
-
-```bash
-'Project'
- └───'Location'
-     ├───'InSitu'
-     └───'Sample'
-          └───'Lab'
-```
-
-These relationships are represented in the database tables with so-called "foreign keys". For example, the results of an Atterberg Limits Lab test, i.e. Liquid Limit and Plastic Limit tests, that originated from an AGS file would be in stored in the `'Lab_LLPL'` table. Each row in this table represents the Atterberg Limit test results performed on a specific sample. Each row knows to which project, GI location and sample it belongs through its `project_uid`, `location_uid` and `sample_uid` respectively.
-
-This relational database ([linked tables](https://en.wikipedia.org/wiki/Relational_database)) with Ground Investigation data becomes a GIS database by assigning a (3D) GIS geometry to each of the rows in each of the database tables (except for the `'Project'` table).
-
-## ⬇️ Installation
-
-In case you're using `uv`, you can add `bedrock-gi` to your Python project and install it in your project's virtual environment by running:
-
-```bash
-uv add bedrock-gi
-```
-
-I would highly recommend anyone to start using [`uv`](https://docs.astral.sh/uv/) (Unified Virtual Environment Manager) if you're not already doing so. Some of the advantages (Source: [`uv`](https://docs.astral.sh/uv/)):
-
-- 🖥️ `uv` Python projects will work on Windows, macOS and Linux.
-- 🐍 `uv` [installs and manages](https://docs.astral.sh/uv/#python-management) Python versions.
-- 🗂️ `uv` provides [comprehensive project management](https://docs.astral.sh/uv/#project-management), with a [universal lockfile](https://docs.astral.sh/uv/concepts/projects/#project-lockfile). This means no more headaches about virtual environments (or having to explain what on earth a virtual env is), or people running different versions of Python or Python packages on the same project, causing errors and other problems.
-- In short, 🚀 `uv` is a single tool to replace `pip`, `pip-tools`, `pipx`, `poetry`, `pyenv`, `virtualenv`, `conda` and more...
-
-It's of course also possible to install `bedrock-gi` from [PyPI](https://pypi.org/project/bedrock-gi/) (Python Packaging Index) using `pip`:
-
-```bash
-pip install bedrock-gi
-```
-
-## 💭 Feedback
-
-Got some feedback, a great idea, running into problems when working with Bedrock or just want to ask some questions?
-
-Please feel free to:
-
-1. open an issue for feature requests or bug reports: [`bedrock-gi` issues](https://github.com/bedrock-gi/bedrock-gi/issues),
-2. start a discussion in this GitHub repo: [Bedrock discussions](https://github.com/orgs/bedrock-gi/discussions),
-3. or start a discussion on the Speckle community forum if that's more appropriate: [Speckle community forum](https://speckle.community/)
-
-All feedback and engagement with the Bedrock community is welcome 🤗
-
-## 👷 Contributing
-
-🛑 Wait, please read this too!
-
-Contributing isn't scary 😄
-
-Contributing isn't just about writing code:
-
-- Use Bedrock and provide [feedback](#-feedback) 🪲
-- Share how you use Bedrock 🏗️
-- Help each other out, e.g. by replying to questions in the [discussions](https://github.com/orgs/bedrock-gi/discussions) or [`bedrock-gi` issues](https://github.com/bedrock-gi/bedrock-gi/issues) 🤝
-- Spread the word about Bedrock 🤩
-- Documentation and tutorials 📃
-- Most pages on the [bedrock.engineer](https://bedrock.engineer/) website can be edited, so if you see a spelling mistake or have a suggestion on how to explain something better, please smash that button! 🖱️💥
-  
-<p align="center">
-  <img src="https://bedrock.engineer/public/images/EditThisPage.png" alt="Edit this page on GitHub button on bedrock.engineer" width="20%"/>
-</p>
-
-- If you would like to contribute code, AWESOME! 💖  
-  Please create an issue for what you'd like to contribute. If you don't know how to get started, please indicate this in your issue, and we'll help you out.
-
-## 🤔 Things to Consider
-
-### GIS Data, Projected vs Geodetic CRS's and Heights / Elevations
-
-Ground investigation data is initially measured in Easting, Northing, z-coordinate, i.e. in a projected Coordinate Reference System (CRS).
-
-If you want your ground investigation data to go into a GIS database, all GIS geometry needs to use the same CRS.
-
-Therefore, if you are dealing with GI data collected using different projected CRS's, you'll have to convert the Easting, Northing, z-coordinates to global longitude, latitude, ellipsoidal height coordinates in a geodetic CRS. ([Further reading](https://clover-animantarx-a3a.notion.site/Geomatics-36dfece2dece4358b44c44d08c9cded6))
-
-Please start a [discussion](https://github.com/orgs/bedrock-gi/discussions) or create an issue if want to be able to put data that were collected in different projected CRS's into a single GIS database. This is pretty easy with [`geopandas`](https://geopandas.org/en/stable/) / [`pyproj`](https://pyproj4.github.io/pyproj/stable/) transformations, but hasn't been necessary yet.
-
-## ✍️ Author
-
-Hi, I'm Joost Gevaert 👋
-
-I studied geotechnical engineering and applied geophysics and then worked for [Arup](https://www.arup.com/) for 4 years as a geotechnical engineer and computational designer.
-
-During my time at Arup I worked a lot on bringing computational design into the world of geotechnical engineering, and on [bridging the gaps between geotechnical engineering and structural engineering](https://www.linkedin.com/posts/joost-gevaert_lightbim-lightbim-lightbim-activity-7234726439835549697-3xdO).
-
-Bedrock is the Free and Open Source Software (FOSS) that I wish existed when I worked as a geotechnical engineer at Arup.
-
-> Computational design is a field that involves the use of computer algorithms, simulations, and data analysis to support and enhance the design process. It enables designers to explore vast design spaces, to find solutions to complex design problems, and to make informed decisions based on data-driven insights.  
-> Source: [Computational design | Arup](https://www.arup.com/services/computational-and-parametric-design/)

bedrock_ge-0.2.2.dist-info/RECORD

@@ -1,21 +0,0 @@
-bedrock_ge/__init__.py,sha256=F2GWz69tVD2wVnMHeHrp-TWuguF3xjlReB1CiPeK-lM,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=8szmnYiQfAg-DSDMC1vqDVtSEZOCUifKGKaTyrVSqa0,8351
-bedrock_ge/gi/ags/validate.py,sha256=Wghxm0dFGQB-6qrsbxOf68YalnPdJ6oeCXZJ7xrYVHI,703
-bedrock_ge-0.2.2.dist-info/METADATA,sha256=UylRTVrQB-2s_hzPLvNJvyazh0hEn35g8b2rH2IkpEQ,14317
-bedrock_ge-0.2.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-bedrock_ge-0.2.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-bedrock_ge-0.2.2.dist-info/RECORD,,