bedrock-ge 0.2.2__tar.gz → 0.2.4__tar.gz

bedrock_ge-0.2.4/.github/workflows/python-tests.yml

@@ -0,0 +1,33 @@
+name: Run Python tests
+
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ['3.9']
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install bedrock-ge with testing dependencies
+      run: uv sync --locked --group tests   
+
+    - name: Run tests
+      run: uv run pytest tests

{bedrock_ge-0.2.2 → bedrock_ge-0.2.4}/.gitignore

@@ -117,3 +117,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
+
+# Mac
+.DS_Store

bedrock_ge-0.2.4/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "python.testing.pytestArgs": [
+    "tests"
+  ],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}

bedrock_ge-0.2.4/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+info@bedrock.engineer.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

bedrock_ge-0.2.4/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,175 @@
+<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.2 → bedrock_ge-0.2.4}/RELEASE.md

@@ -1,4 +1,4 @@
-# Releasing a new version of `bedrock-gi`
+# Releasing a new version of `bedrock-ge`
 
 ## 1. Update the Version Number
 
@@ -11,7 +11,8 @@ Follow [Semantic Versioning](https://semver.org/) (e.g., `1.0.0`, `1.1.0`, `1.1.
 Update the version number in:
 
 - [`pyproject.toml`](pyproject.toml)
-- [`/src/bedrock/__init__.py`](/src/bedrock/__init__.py)
+- [`/src/bedrock/__init__.py`](/src/bedrock_ge/__init__.py)
+- Inline script dependencies of marimo notebooks in [`examples`](/examples/)
 
 ## 2. Update the Changelog
 
@@ -75,14 +76,14 @@ uv publish
 ## 10. Verify the Release
 
 Check that the new version is available on PyPI:  
-<https://pypi.org/project/bedrock-gi/>
+<https://pypi.org/project/bedrock-ge/>
 
 Install the new Python package version in a clean environment to verify it works:
 
 ```bash
-uv run --with bedrock-gi --no-project -- python -c "import bedrock; print(f'bedrock-gi version: {bedrock.__version__}')"
+uv run --with bedrock-ge --no-project -- python -c "import bedrock_ge; print(f'bedrock-ge version: {bedrock_ge.__version__}')"
 ```
 
 ## 11. Create a GitHub Release
 
-Create a new release based on the tag: [github.com/bedrock-gi/bedrock-gi/releases](https://github.com/bedrock-gi/bedrock-gi/releases).
+Create a new release based on the tag: [github.com/bedrock-engineer/bedrock-ge/releases](https://github.com/bedrock-engineer/bedrock-ge/releases).

{bedrock_ge-0.2.2 → bedrock_ge-0.2.4}/examples/README.md

@@ -69,6 +69,12 @@ I think that if people don't know how to run a Jupyter notebook they should simp
 marimo export ipynb --sandbox --sort top-down --include-outputs hk_kaitak_ags3_to_brgi_geodb.py -o hk_kaitak_ags3_to_brgi_geodb.ipynb
 ```
 
+After or before exporting a marimo notebook to a Jupyter notebook, the cell with the import statements and the cell(s) with function definitions have to be moved to the top of the Jupyter notebook for it to work. Additionally, in order for Google Colab to be able to run the notebook, you need to install `bedrock-ge` and a few other Python libraries by adding the following cell to the very top of the Jupyter notebook:
+
+```bash
+! pip install bedrock-ge folium mapclassify marimo --quiet
+```
+
 ### HTML WebAssembly (WASM)
 
 ```bash