Skip to content

Generate computer-friendly soil descriptions from field notes

License

Notifications You must be signed in to change notification settings

stephenhillier/soildesc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

soildesc

Soil description parsing

Visual descriptions

Visual descriptions help engineering technologists and field engineers log soil conditions at a drilling site. A relatively plain-english, descriptive format is used :

sand, some gravel, wet

Soildesc parses these descriptions and returns data in a format that is easier to use with a database or programming language:

> sand, silty, wet

{
    "ordered": ["sand", "silt"],
    "primary": "sand",
    "secondary": "silt",
    "moisture": "wet"
}
> loose water bearing silts, sands

{
    "ordered": ["silt", "sand"],
    "primary": "silt",
    "secondary": "sand",
    "consistency": "loose",
    "moisture": "wet"
}

Methodology

The text string is scanned, looking for key terms. Note: Field descriptions are generally written with the most significant soil type first, unless a qualified term is used (e.g. in "silty sand", sand is the most significant term). Soildesc handles these cases by looking for the first "non qualified" term and putting the "-ey" term second.

Usage

Running the unit tests:

go test

Building the binary:

go build

Running the server:

./soildesc

Send a test request:

curl -X POST localhost:8000/describe -d desc="very wet sand and gravel"

About

Generate computer-friendly soil descriptions from field notes

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages