Skip to content

Commit bb246c7

Browse files
committed
Some corrections and additions
1 parent 45cf535 commit bb246c7

File tree

1 file changed

+27
-19
lines changed

1 file changed

+27
-19
lines changed

README.md

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@
2424

2525
> **Definition of Bedrock**
2626
>
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]
2828
>
2929
> In the real world, the bedrock is the hard area of rock in the ground that holds up the loose soil above. [1]
3030
>
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]
3232
>
3333
> Sources: [[1] Bedrock | Cambridge Dictionary](https://dictionary.cambridge.org/us/dictionary/english/bedrock), [[2] Bedrock | Wikipedia](https://en.wikipedia.org/wiki/Bedrock)
3434
35-
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.
3737
`bedrock-ge` validates the data for consistency and converts it into modern geospatial formats that can be stored in industry-standard databases.
3838

3939
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
6666

6767
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.
6868

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
7070

7171
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:
7272

7373
<figure style="margin-inline: block; display: block;">
74-
<img src="https://bedrock.engineer/public/images/KaiTak_BrGI_ArcGIS.gif" alt="GI data visualization .gif in 3D in ArcGIS" width="80%"/>
74+
<img src="https://bedrock.engineer/public/images/KaiTak_BrGI_ArcGIS.gif" alt="GI data visualization .gif in 3D in ArcGIS" width="90%"/>
75+
<figcaption>
76+
<a href="https://arcg.is/0r9DG9">Click here to explore this visualization in your browser</a>
77+
</figcaption>
7578
</figure>
7679

7780
### 🟦 Put your GI data into Speckle
7881

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:
83+
84+
<figure style="margin-inline: block; display: block;">
85+
<img src="https://bedrock.engineer/public/images/KaiTak_BrGI_ArcGIS.gif" alt="GI data visualization .gif in 3D in ArcGIS" width="90%"/>
86+
<figcaption>
87+
<a href="https://arcg.is/0r9DG9">Click here to explore this visualization in your browser</a>
88+
</figcaption>
89+
</figure>
8090

8191
<div style="margin-inline: block;">
8292
<img src="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
92102

93103
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.
94104

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.
96106

97107
## ⬇️ Installation
98108

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.
100110
Using `uv`, you can add `bedrock-ge` to your Python project and install it in your project's virtual environment by running:
101111

102112
```bash
@@ -125,36 +135,34 @@ All feedback and engagement with the Bedrock community is welcome.
125135

126136
Contributing isn't scary. Contributing isn't just about writing code:
127137

138+
- Spread the word about Bedrock
128139
- Use Bedrock and provide [feedback](#-feedback)
129140
- Share how you use Bedrock
130141
- 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
132142
- Documentation and tutorials
133143
- 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.
134144

135145
<figure style="margin-inline: block;">
136-
<img src="https://bedrock.engineer/public/images/EditThisPage.png" alt="Edit this page on GitHub button on bedrock.engineer" width="20%"/>
146+
<img src="https://bedrock.engineer/public/images/EditThisPage.png" alt="Edit this page on GitHub button on bedrock.engineer" width="25%"/>
137147
</figure>
138148

139149
- 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.
141151

142152
## Maintainers
143153

144154
### Joost
145155

146-
> Hi, I'm Joost Gevaert 👋
147-
148156
> 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+
>
150158
> 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+
>
152160
> Bedrock is the Free and Open Source Software (FOSS) that I wish existed when I worked as a geotechnical engineer at Arup.
153161
154162
### Jules
155163

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+
>
158166
> Over the past 5 years, I’ve worked on data-rich applications across various domains, specifically in frontend development.
159167
> My primary interest is figuring out how to build tools for more thoughtful display and processing of technical information, for geoscience in particular.
160168
@@ -164,4 +172,4 @@ Please take a look at the [contributors page](https://github.com/bedrock-enginee
164172

165173
## Professional Support
166174

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

Comments
 (0)