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

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

@@ -1,8 +1,11 @@
 # marimo
 __marimo__/
 
-# Outputs
+# Outputs, logs, tmp, etc.
 **/output
+**/log
+**/tmp
+**/temp
 
 # SQLite Databases
 *.sqlite
@@ -91,10 +94,6 @@ ENV/
 env.bak/
 venv.bak/
 
-# Spyder project settings
-.spyderproject
-.spyproject
-
 # Rope project settings
 .ropeproject
 

{bedrock_ge-0.2.0 → bedrock_ge-0.2.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: bedrock-ge
-Version: 0.2.0
-Summary: Bedrock, the Open Source Foundation for Ground Engineering
+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/
@@ -9,18 +9,26 @@ 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,ags,bedrock,bim,engineering geology,geo-bim,geotech,geotechnical data,geotechnical engineering,gi data,gis,ground engineering,ground investigation,ground investigation data
-Classifier: Development Status :: 2 - Pre-Alpha
+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 :: 3
+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: duckdb~=1.0
 Requires-Dist: geopandas~=1.0
 Requires-Dist: openpyxl~=3.0
 Requires-Dist: pandera>=0.23.0
 Requires-Dist: python-ags4~=1.0
-Requires-Dist: sqlglot>=26.12.0
 Requires-Dist: sqlmodel>=0.0.22
 Description-Content-Type: text/markdown
 
@@ -209,7 +217,7 @@ Please start a [discussion](https://github.com/orgs/bedrock-gi/discussions) or c
 
 Hi, I'm Joost Gevaert 👋
 
-I studied geotechnical engineering and applied geophysics and then worked for [Arup](https://www.arup.com/) for 4 as a geotechnical engineer an computational designer.
+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_ge-0.2.0 → bedrock_ge-0.2.2}/README.md

@@ -183,7 +183,7 @@ Please start a [discussion](https://github.com/orgs/bedrock-gi/discussions) or c
 
 Hi, I'm Joost Gevaert 👋
 
-I studied geotechnical engineering and applied geophysics and then worked for [Arup](https://www.arup.com/) for 4 as a geotechnical engineer an computational designer.
+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_ge-0.2.2/examples/README.md

@@ -0,0 +1,76 @@
+# `bedrock-ge` examples
+
+This folder contains example notebooks that guide you how to use Bedrock's Geotechnical Engineering Python package `bedrock-ge`.
+
+## How to run the example notebooks
+
+The notebooks are available as [marimo](https://marimo.io/) (`.py` extension) as well as [Jupyter](https://jupyter.org/) notebooks (`.ipynb` extension). However, it is **STRONGLY** recommended to use the marimo notebooks, as they are more user-friendly and have [several other advantages over Jupyter notebooks](https://docs.marimo.io/#highlights).
+
+Both the marimo notebooks as well as the Jupyter notebooks can be run online, i.e. remotely, or on your own computer, i.e. locally.
+
+### marimo
+
+marimo notebooks are normal Python files, and therefore have the `.py` extension.
+
+#### Remotely: marimo playground
+
+marimo notebooks on GitHub can directly be run remotely in the [marimo playground](https://docs.marimo.io/guides/publishing/playground/#open-notebooks-hosted-on-github). To open the notebooks in this repository:
+
+1. Navigate to one of them, e.g.  
+   The Kai Tak, Hong Kong AGS 3 example: [hk_kaitak_ags3/hk_kaitak_ags3_to_brgi_geodb.py](https://github.com/bedrock-engineer/bedrock-ge/blob/main/examples/hk_kaitak_ags3/hk_kaitak_ags3_to_brgi_geodb.py)
+2. Copy the GitHub URL of the notebook you want to try, e.g.  
+    https://github.com/bedrock-engineer/bedrock-ge/blob/main/examples/hk_kaitak_ags3/hk_kaitak_ags3_to_brgi_geodb.py
+3. Open a new tab and go to `marimo.app/<Ctrl + V the copied GitHub URL>`, e.g.
+    https://marimo.app/https://github.com/bedrock-engineer/bedrock-ge/blob/dev/examples/hk_kaitak_ags3/hk_kaitak_ags3_to_brgi_geodb.py
+
+#### Locally: on your own computer
+
+Running the marimo notebooks in this repo locally is very easy if you're using [`uv`](https://docs.astral.sh/uv/) to manage Python. In case you're not usinng `uv` to manage Python yet, make sure to give it a try! (INCLUDE A LINK TO BEDROCK DOCS ON HOW TO INSTALL `uv`.)
+
+Managing Python with `uv` will save you many many headaches w.r.t. managing virtual environments, Python packages, etc. etc. etc. Probably the greatest thing about `uv` is that you don't really need to understand what a virtual environment is...
+
+To run a marimo notebook from this repo locally:
+
+1. Download the notebook
+2. Open the terminal
+3. Navigate to the directory where you downloaded the marimo notebook with `cd` (change directory). On Windows this could be:
+   ```bash
+   cd %USERPROFILE%\Downloads
+   ```
+4. Run the marimo notebook with:
+   ```bash
+   uvx marimo edit --sandbox marimo_notebook.py
+   ```
+
+### Jupyter
+
+Jupyter notebooks have the `.ipynb` extension, which is short for Interactive Python NoteBook.
+
+#### Remotely: Google Colab
+
+1. Navigate to one of them, e.g.  
+   The Kai Tak, Hong Kong AGS 3 example: [hk_kaitak_ags3/hk_kaitak_ags3_to_brgi_geodb.ipynb](https://github.com/bedrock-engineer/bedrock-ge/blob/main/examples/hk_kaitak_ags3/hk_kaitak_ags3_to_brgi_geodb.ipynb)
+2. Copy the GitHub URL of the notebook you want to try, e.g.  
+    https://github.com/bedrock-engineer/bedrock-ge/blob/main/examples/hk_kaitak_ags3/hk_kaitak_ags3_to_brgi_geodb.ipynb
+3. Navigate to [colab.research.google.com](https://colab.research.google.com/)
+4. Paste the GitHub URL in the GitHub > Enter a GitHub URL... field
+
+#### Locally: on your own computer
+
+How much do we need to go into detail on how to run a Jupyter Notebook?
+
+I think that if people don't know how to run a Jupyter notebook they should simply use the marimo notebook. The only reason to not use marimo, is when a company uses some deployed Jupyter service like Google Colab, Jupyter Hub or something like that, in which case they should run the Jupyter notebook remotely.
+
+## Eporting marimo notebooks to other formats
+
+### Jupyter Notebook
+
+```bash
+marimo export ipynb --sandbox --sort top-down --include-outputs hk_kaitak_ags3_to_brgi_geodb.py -o hk_kaitak_ags3_to_brgi_geodb.ipynb
+```
+
+### HTML WebAssembly (WASM)
+
+```bash
+marimo export html-wasm --sandbox --mode edit hk_kaitak_ags3_to_brgi_geodb.py -o output
+```