You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-19Lines changed: 27 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,16 +24,16 @@
24
24
25
25
> **Definition of Bedrock**
26
26
>
27
-
> In an abstract sense, the main principles on which something is based. [1]
27
+
> In an abstract sense, the bedrock refers to the main principles something is based on. [1]
28
28
>
29
29
> In the real world, the bedrock is the hard area of rock in the ground that holds up the loose soil above. [1]
30
30
>
31
-
> 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]
31
+
> 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]
Valuable ground investigation data is often trapped in legacy formats that limit analysis and visualization.
36
-
`bedrock-ge` lets you transforms this data from specialized geotechnical formats and common formats (Excel, CSV) into standardized geospatial data.
35
+
Ground Investigation (GI) data is often trapped in legacy formats that limit analysis and visualization possibilities.
36
+
`bedrock-ge` lets you transform this data from specialized geotechnical formats and common tabular formats (Excel, CSV) into standardized geospatial data.
37
37
`bedrock-ge` validates the data for consistency and converts it into modern geospatial formats that can be stored in industry-standard databases.
38
38
39
39
This standardization lets you bridge the gap between raw geotechnical data and modern Python (geo)scientific ecosystem and modern geospatial tools.
@@ -66,17 +66,27 @@ Also, if you have a project with publicly available GI data, please share that i
66
66
67
67
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.
68
68
69
-
### 🗺️ Put your GI data from multiple files into a single 3D GIS database
69
+
### 🗺️ Put your GI data from multiple files into a single 3D geospatial database
70
70
71
71
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:
<imgsrc="https://bedrock.engineer/public/images/KaiTak_BrGI_ArcGIS.gif"alt="GI data visualization .gif in 3D in ArcGIS"width="80%"/>
74
+
<imgsrc="https://bedrock.engineer/public/images/KaiTak_BrGI_ArcGIS.gif"alt="GI data visualization .gif in 3D in ArcGIS"width="90%"/>
75
+
<figcaption>
76
+
<ahref="https://arcg.is/0r9DG9">Click here to explore this visualization in your browser</a>
77
+
</figcaption>
75
78
</figure>
76
79
77
80
### 🟦 Put your GI data into Speckle
78
81
79
-
Once you have your GI data inside [Speckle](https://speckle.systems/), it's easy to visualize GI data together with civil engineering designs:
82
+
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:
<imgsrc="https://bedrock.engineer/public/images/KaiTak_BrGI_ArcGIS.gif"alt="GI data visualization .gif in 3D in ArcGIS"width="90%"/>
86
+
<figcaption>
87
+
<ahref="https://arcg.is/0r9DG9">Click here to explore this visualization in your browser</a>
88
+
</figcaption>
89
+
</figure>
80
90
81
91
<divstyle="margin-inline: block;">
82
92
<imgsrc="https://bedrock.engineer/public/images/KaiTak_BrGI_Speckle.png"alt="Kai Tak, Hong Kong, data from many sources."width="56%" />
@@ -92,11 +102,11 @@ Moreover, your GI data becomes available in all the software that [Speckle has c
92
102
93
103
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.
94
104
95
-
You can give [feedback](#-feedback) and [contribute](#-contributing), such that together we together can build the tools we've always wanted and needed.
105
+
You can give [feedback](#-feedback) and [contribute](#-contributing), such that together we can build the tools we've always wanted and needed.
96
106
97
107
## ⬇️ Installation
98
108
99
-
We recommend to use [`uv`](https://docs.astral.sh/uv/) as a package manager.
109
+
We recommend to use [`uv`](https://docs.astral.sh/uv/) as your package manager.
100
110
Using `uv`, you can add `bedrock-ge` to your Python project and install it in your project's virtual environment by running:
101
111
102
112
```bash
@@ -125,36 +135,34 @@ All feedback and engagement with the Bedrock community is welcome.
125
135
126
136
Contributing isn't scary. Contributing isn't just about writing code:
127
137
138
+
- Spread the word about Bedrock
128
139
- Use Bedrock and provide [feedback](#-feedback)
129
140
- Share how you use Bedrock
130
141
- 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)
131
-
- Spread the word about Bedrock
132
142
- Documentation and tutorials
133
143
- 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.
134
144
135
145
<figurestyle="margin-inline: block;">
136
-
<imgsrc="https://bedrock.engineer/public/images/EditThisPage.png"alt="Edit this page on GitHub button on bedrock.engineer"width="20%"/>
146
+
<imgsrc="https://bedrock.engineer/public/images/EditThisPage.png"alt="Edit this page on GitHub button on bedrock.engineer"width="25%"/>
137
147
</figure>
138
148
139
149
- If you would like to contribute code, awesome!
140
-
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.
150
+
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.
141
151
142
152
## Maintainers
143
153
144
154
### Joost
145
155
146
-
> Hi, I'm Joost Gevaert 👋
147
-
148
156
> 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/).
149
-
157
+
>
150
158
> 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).
151
-
159
+
>
152
160
> Bedrock is the Free and Open Source Software (FOSS) that I wish existed when I worked as a geotechnical engineer at Arup.
153
161
154
162
### Jules
155
163
156
-
> Hi, my name is 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.
157
-
164
+
> 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.
165
+
>
158
166
> Over the past 5 years, I’ve worked on data-rich applications across various domains, specifically in frontend development.
159
167
> My primary interest is figuring out how to build tools for more thoughtful display and processing of technical information, for geoscience in particular.
160
168
@@ -164,4 +172,4 @@ Please take a look at the [contributors page](https://github.com/bedrock-enginee
164
172
165
173
## Professional Support
166
174
167
-
While `bedrock-ge` is an Open Source project, you might be looking for professional support implementing it, contact [email protected].
175
+
While `bedrock-ge` is an Free Open Source Software (FOSS) project, you might be looking for professional support implementing it, contact <[email protected]> for more information.
0 commit comments