bedrock-ge 0.2.3__py3-none-any.whl → 0.3.0__py3-none-any.whl

bedrock_ge/gi/validate.py

@@ -1,151 +1,88 @@
-from typing import Dict, Union
-
 import geopandas as gpd  # type: ignore
 import pandas as pd
 
 from bedrock_ge.gi.schemas import (
-    BaseInSitu,
-    BaseLocation,
-    BaseSample,
-    InSitu,
-    Location,
-    Project,
-    Sample,
+    BedrockGIDatabase,
+    BedrockGIGeospatialDatabase,
 )
 
 
-# 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).
+def check_brgi_geodb(
+    brgi_geodb: BedrockGIGeospatialDatabase,
+):
+    """Validates the structure and relationships of a 'Bedrock Ground Investigation' (BrGI) geospatial database.
 
-    This function checks that all tables in the BRGI database conform to their respective schemas
+    This function checks that all tables in the BrGI geospatialdatabase conform to their respective schemas
     and that all foreign key relationships are properly maintained. It validates the following tables:
     - Project
     - Location
+    - LonLatHeight
+    - All In-Situ test tables
     - Sample
-    - InSitu_TESTX
-    - Lab_TESTY (not yet implemented)
+    - All Lab test tables
 
     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).
+        brgi_geodb (BedrockGIGeospatialDatabase): Bedrock GI geospatial database object.
 
     Returns:
-        bool: True if all tables are valid and relationships are properly maintained.
+        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)
+        brgi_geodb = BedrockGIGeospatialDatabase(
+            Project=project_df,
+            Location=location_geodf,
+            LonLatHeight=lon_lat_height_geodf,
+            InSituTests={"ISPT": ispt_geodf},
+            Sample=sample_geodf,
+            LabTests={"LLPL": llpl_df},
+        )
+        check_brgi_geodb(brgi_db)
         ```
     """
-    for table_name, table in brgi_db.items():
-        if table_name == "Project":
-            Project.validate(table)
-            print("'Project' table aligns with Bedrock's 'Project' table schema.")
-        elif table_name == "Location":
-            Location.validate(table)
-            check_foreign_key("project_uid", brgi_db["Project"], table)
-            print("'Location' table aligns with Bedrock's 'Location' table schema.")
-        elif table_name == "Sample":
-            Sample.validate(table)
-            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)
-            check_foreign_key("location_uid", brgi_db["Location"], table)
-            print(
-                f"'{table_name}' table aligns with Bedrock's table schema for In-Situ measurements."
-            )
-        elif table_name.startswith("Lab_"):
-            print(
-                "🚨 !NOT IMPLEMENTED! We haven't come across Lab data yet. !NOT IMPLEMENTED!"
-            )
-
+    # TODO: implement this
     return True
 
 
-# TODO: rename to check_brgi_db
-def check_no_gis_brgi_database(
-    brgi_db: Dict[str, Union[pd.DataFrame, gpd.GeoDataFrame]],
+def check_brgi_db(
+    brgi_db: BedrockGIDatabase,
 ):
-    """Validates the structure and relationships of a 'Bedrock Ground Investigation' (BGI) database without GIS geometry.
+    """Validates the structure and relationships of a 'Bedrock Ground Investigation' (BrGI) database.
 
-    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)
+    This function performs the same validation as `check_brgi_geodb`, but uses schemas
+    that don't require geospatial geometry. It validates the following tables:
+    - Project (never has geospatial geometry)
+    - Location (without geospatial geometry)
+    - All In-Situ test tables (without geospatial geometry)
+    - Sample (without geospatial geometry)
+    - All Lab test tables (never has geospatial geometry)
 
     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).
+        brgi_db (BedrockGIDatabase): A Bedrock GI database object.
 
     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)
+        brgi_db = BedrockGIDatabase(
+            Project=project_df,
+            Location=location_df,
+            InSituTests={"ISPT": ispt_df},
+            Sample=sample_df,
+            LabTests={"LLPL": llpl_df},
+        )
+        check_brgi_db(brgi_db)
         ```
     """
-    for table_name, table in brgi_db.items():
-        if table_name == "Project":
-            Project.validate(table)
-            print("'Project' table aligns with Bedrock's 'Project' table schema.")
-        elif table_name == "Location":
-            BaseLocation.validate(table)
-            check_foreign_key("project_uid", brgi_db["Project"], table)
-            print(
-                "'Location' table aligns with Bedrock's 'Location' table schema without GIS geometry."
-            )
-        elif table_name == "Sample":
-            BaseSample.validate(table)
-            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 without GIS geometry."
-            )
-        elif table_name.startswith("InSitu_"):
-            BaseInSitu.validate(table)
-            check_foreign_key("project_uid", brgi_db["Project"], table)
-            check_foreign_key("location_uid", brgi_db["Location"], table)
-            print(
-                f"'{table_name}' table aligns with Bedrock's '{table_name}' table schema without GIS geometry."
-            )
-        elif table_name.startswith("Lab_"):
-            print(
-                "🚨 !NOT IMPLEMENTED! We haven't come across Lab data yet. !NOT IMPLEMENTED!"
-            )
-
+    # TODO: implement this
     return True
 
 
 def check_foreign_key(
     foreign_key: str,
-    parent_table: Union[pd.DataFrame, gpd.GeoDataFrame],
-    table_with_foreign_key: Union[pd.DataFrame, gpd.GeoDataFrame],
+    parent_table: pd.DataFrame | gpd.GeoDataFrame,
+    table_with_foreign_key: pd.DataFrame | gpd.GeoDataFrame,
 ) -> bool:
     """Validates referential integrity between two tables by checking foreign key relationships.
 
@@ -154,8 +91,8 @@ def check_foreign_key(
 
     Args:
         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.
+        parent_table (pd.DataFrame| gpd.GeoDataFrame): The parent table containing the primary keys.
+        table_with_foreign_key (pd.DataFrame| gpd.GeoDataFrame): The child table containing the foreign keys.
 
     Returns:
         bool: True if all foreign keys exist in the parent table.

bedrock_ge/gi/write.py

@@ -1,13 +1,44 @@
 from pathlib import Path
-from typing import Dict, Union
+from typing import Literal
 
 import geopandas as gpd
 import pandas as pd
 
+from bedrock_ge.gi.io_utils import brgi_db_to_dfs, geodf_to_df
+from bedrock_ge.gi.schemas import BedrockGIDatabase, BedrockGIGeospatialDatabase
+
+
+# ? Should this function be made a to_file(s) method of BedrockGIDatabase?
+def write_brgi_db_to_file(
+    brgi_db: BedrockGIDatabase | BedrockGIGeospatialDatabase,
+    path: str | Path,
+    driver: Literal["EXCEL", "GPKG"] = "GPKG",
+) -> None:
+    """Writes a Bedrock GI (geospatial) database to a file.
+
+    Writes a Bedrock GI (geospatial) database to a file. The file type is
+    determined by the `driver` argument. Possible values are "GPKG" and "EXCEL".
+
+    Args:
+        brgi_db (BedrockGIDatabase | BedrockGIGeospatialDatabase): The Bedrock GI (geospatial) database.
+        path (str | Path): The path of the output file.
+        driver (str): The type of the output file. Possible values are "GPKG" and "EXCEL".
+
+    Returns:
+        None
+    """
+    dict_of_dfs = brgi_db_to_dfs(brgi_db)
+    if driver.upper() == "GPKG":
+        write_gi_db_to_gpkg(dict_of_dfs, path)
+    elif driver.upper() == "EXCEL":
+        write_gi_db_to_excel(dict_of_dfs, path)
+    else:
+        raise ValueError(f"Invalid driver: {driver}")
+
 
 def write_gi_db_to_gpkg(
-    brgi_db: Dict[str, gpd.GeoDataFrame],
-    gpkg_path: Union[str, Path],
+    dict_of_dfs: dict[str, pd.DataFrame | gpd.GeoDataFrame],
+    gpkg_path: str | Path,
 ) -> None:
     """Writes a database with Bedrock Ground Investigation data to a GeoPackage file.
 
@@ -16,31 +47,28 @@ def write_gi_db_to_gpkg(
     separate table named by the keys of the dictionary.
 
     Args:
-        brgi_db (dict): A dictionary where keys are brgi table names and values are DataFrames
+        dict_of_dfs (dict[str, 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.
+        gpkg_path (str | Path): The name of the output GeoPackage file.
 
     Returns:
         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)
-
-        if isinstance(brgi_table, pd.DataFrame):
-            brgi_table = gpd.GeoDataFrame(brgi_table)
+    for table_name, df in dict_of_dfs.items():
+        sanitized_table_name = sanitize_table_name(table_name)
+        if isinstance(df, pd.DataFrame):
+            df = gpd.GeoDataFrame(df)
 
-        if isinstance(brgi_table, gpd.GeoDataFrame):
-            brgi_table.to_file(
-                gpkg_path, driver="GPKG", layer=sanitized_table_name, overwrite=True
-            )
+        df.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],
+    dict_of_dfs: dict[str, pd.DataFrame | gpd.GeoDataFrame],
+    excel_path: str | Path,
 ) -> None:
     """Writes a database with Ground Investigation data to an Excel file.
 
@@ -49,25 +77,27 @@ def write_gi_db_to_excel(
     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.
+        dict_of_dfs (dict[str, pd.DataFrame | gpd.GeoDataFrame]): A dictionary where
+            keys are GI table names and values are DataFrames with GI data.
+        excel_path (str | Path): Path to the output Excel file. Can be provided as a
+            string or Path object.
 
     Returns:
         None
     """
-    # 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)
+        for sheet_name, df in dict_of_dfs.items():
+            sanitized_sheet_name = sanitize_table_name(sheet_name)[:31]
+            if isinstance(df, gpd.GeoDataFrame):
+                df = geodf_to_df(df)
+
+            df.to_excel(writer, sheet_name=sanitized_sheet_name, index=False)
 
     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):
-    """Replaces invalid characters and spaces in GI table names with underscores and truncates to 31 characters.
+    """Replaces invalid characters and spaces in GI table names with underscores.
 
     Makes table names consistent with SQL, GeoPackage and Excel naming conventions by
     replacing invalid characters and spaces with underscores.
@@ -76,14 +106,10 @@ def sanitize_table_name(sheet_name):
         sheet_name (str): The original sheet name.
 
     Returns:
-        sanitized_name: 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]
-
-    # Define invalid characters and replace with underscores
     invalid_chars = [":", "/", "\\", "?", "*", "[", "]"]
-    sanitized_name = trimmed_name
+    sanitized_name = sheet_name.strip()
     for char in invalid_chars:
         sanitized_name = sanitized_name.replace(char, "_")
 
@@ -93,16 +119,10 @@ def sanitize_table_name(sheet_name):
     # Collapse multiple underscores to one
     sanitized_name = "_".join(filter(None, sanitized_name.split("_")))
 
-    if trimmed_name != sanitized_name:
+    if sheet_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
-    # ! "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'.")
-
     return sanitized_name

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.3.0.dist-info/METADATA

@@ -0,0 +1,208 @@
+Metadata-Version: 2.4
+Name: bedrock-ge
+Version: 0.3.0
+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.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.10
+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.3.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+bedrock_ge/__init__.py,sha256=F4CYyFSMweApwDS139REvy262QKShDMRdP739NOv9Co,89
+bedrock_ge/plot.py,sha256=C95aj8CXjFVZRGYYBssJMm5MyljLbdt_TKyvmQyWZBE,149
+bedrock_ge/gi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bedrock_ge/gi/ags.py,sha256=k2ZotuEt08hGvLAjKCDFR_HLFCRHVuMej1dnw-T6WI4,4388
+bedrock_ge/gi/ags3.py,sha256=HNdX1avwzzZsrkTm54aqs9neUrTXa2e784Q8mSy6Zso,10161
+bedrock_ge/gi/ags3_data_dictionary.json,sha256=Wx20_oJRdAlzEo-cKD6FgN9B9zOMDTcsp5dgc8QWofI,188588
+bedrock_ge/gi/ags4.py,sha256=pDKf-l1jheeQAU2bHkiJiIgjUGvD3Iv8of77rYDwUQA,916
+bedrock_ge/gi/ags4_data_dictionary.json,sha256=XE5XJNo8GBPZTUPgvVr3QgO1UfEIAxzlSeXi-P1VLTs,609670
+bedrock_ge/gi/ags_schemas.py,sha256=R5yubnRacAlQBqb7W7Rj_Y4canhg6Tls38e66xXQNRA,8065
+bedrock_ge/gi/db_operations.py,sha256=Pjtslv9syB-_xumH38F2XWt6XLsvrT8MHLgwAGCYEw0,5153
+bedrock_ge/gi/geospatial.py,sha256=w9sP3SIZZceSW98z3LQT_aJKqs0rSd4DDunTFFSJygY,13739
+bedrock_ge/gi/io_utils.py,sha256=Yd1RGEo_DbYoOklJbEKWdaeTw7KckkHDfKZrr91fu1o,9456
+bedrock_ge/gi/mapper.py,sha256=8vFVPlgLY37iNw_5pkSyze6zOmeQjlBHGY4OAFdx5B0,8665
+bedrock_ge/gi/mapping_models.py,sha256=cvepeKwqwdmVqbNBORkgIDgHq0eOPiRIERjO4RYeAQo,1876
+bedrock_ge/gi/schemas.py,sha256=w0tb3c6YBTXdvpdFWWIGmlE7CYsJfo352nWnD9bmXfM,6883
+bedrock_ge/gi/sqlmodels.py,sha256=_h3H9UP91I_1Ya_SZuL6gZbqL7uNCd5Y-u-yTf7CNto,2253
+bedrock_ge/gi/validate.py,sha256=hgT5qZHLeeXR_cgXf1bhzJnJ-wMhE0_0if_H1rtwsiM,3918
+bedrock_ge/gi/write.py,sha256=N8i1oerOaR7-XJnycmN9gXLkpjMdT5PFFB3GduogyKs,4749
+bedrock_ge-0.3.0.dist-info/METADATA,sha256=dGqh8KV7QCwnhi67RrQOfGtj5USY8Ml6Pr627jDKeMA,11678
+bedrock_ge-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bedrock_ge-0.3.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+bedrock_ge-0.3.0.dist-info/RECORD,,