wakatools.read_borehole_xml#
- wakatools.read_borehole_xml(files: str | Path | Iterable[str | Path], type_: Literal['geotechnical', 'geological', 'pedological'] = 'geotechnical', **kwargs) BoreholeCollection[source]#
Read XML files containing borehole information. The type of data can be one of “geotechnical”, “geological”, or “pedological” borehole XML files.
- Parameters:
files (str | Path | Iterable[str | Path]) – XML file or files containing the borehole data to read.
type (BoreholeType, optional) – The type of borehole data to read. Can be one of “geotechnical”, “geological”, or “pedological”. The default is “geotechnical”. Each different data type use the specific reader function from the GeoST library. See the relevant documentation for more information and usage details.
**kwargs –
Additional keyword arguments to pass to the specific reader function.
GeoST readers: - geost.read_bhrgt: for “geotechnical” borehole XML files. - geost.read_bhrg: for “geological” borehole XML files. - geost.read_bhrp: for “pedological” borehole XML files.
- Returns:
GeoST BoreholeCollection containing the borehole data.
- Return type:
geost.BoreholeCollection
- Raises:
ValueError – If an unsupported borehole type is provided.
Examples
For reading geotechnical borehole XML files from the Basis Registratie Ondergrond (BRO):
>>> files = ["borehole1.xml", "borehole2.xml"] # list of XML files from the BRO >>> cores = read_borehole_xml(files, type_="geotechnical")
See the GeoST documentation for more details on the specific reader functions and for options for files from other sources than the BRO.