Skip to main content
Ctrl+K
Geological Subsurface Toolbox  documentation - Home Geological Subsurface Toolbox  documentation - Home
  • Home
  • About
  • Getting started
  • Documentation
  • Examples
  • Community
    • Changelog
    • Deltares website
  • GitHub
  • PyPI
  • Home
  • About
  • Getting started
  • Documentation
  • Examples
  • Community
  • Changelog
  • Deltares website
  • GitHub
  • PyPI

Section Navigation

Documentation

  • User guide
    • Data structures
    • Survey data
    • Model data
    • Data validation
    • Reading XML files
    • BRO GeoTOP
  • API Reference
    • Input/Output
      • geost.bro_api_read
      • geost.read_borehole_table
      • geost.read_cpt_table
      • geost.read_nlog_cores
      • geost.read_uullg_tables
      • geost.read_table
      • geost.base.Collection.to_csv
      • geost.base.Collection.to_parquet
      • geost.read_bhrgt
      • geost.read_bhrgt_samples
      • geost.read_bhrg
      • geost.read_bhrp
      • geost.read_cpt
      • geost.read_gef_cpts
      • geost.read_sfr
      • geost.read_xml_boris
      • geost.read_collection_geopackage
      • geost.base.Collection.to_geopackage
      • geost.base.Collection.to_geoparquet
      • geost.base.Collection.to_shape
      • geost.io.Geopackage
      • geost.read_pickle
    • Generic functions
      • geost.add_positional_columns
      • geost.delete_user_positional_column_aliases
    • Collection
      • geost.base.Collection
      • geost.base.Collection.get_cumulative_thickness
      • geost.base.Collection.get_layer_base
      • geost.base.Collection.get_layer_top
      • geost.base.Collection.set_crs
      • geost.base.Collection.set_vertical_datum
      • geost.base.Collection.to_crs
      • geost.base.Collection.to_vertical_datum
      • geost.base.Collection.to_csv
      • geost.base.Collection.to_geopackage
      • geost.base.Collection.to_geoparquet
      • geost.base.Collection.to_kingdom
      • geost.base.Collection.to_pyvista_cylinders
      • geost.base.Collection.to_pyvista_grid
      • geost.base.Collection.to_parquet
      • geost.base.Collection.to_qgis3d
      • geost.base.Collection.to_shape
      • geost.base.Collection.add_header_column_to_data
      • geost.base.Collection.check_header_to_data_alignment
      • geost.base.Collection.reset_header
      • geost.base.Collection.get
      • geost.base.Collection.select_by_condition
      • geost.base.Collection.select_by_elevation
      • geost.base.Collection.select_by_length
      • geost.base.Collection.select_by_values
      • geost.base.Collection.slice_by_values
      • geost.base.Collection.slice_depth_interval
      • geost.base.Collection.select_with_lines
      • geost.base.Collection.select_with_points
      • geost.base.Collection.select_within_bbox
      • geost.base.Collection.select_within_polygons
      • geost.base.Collection.spatial_join
      • geost.base.Collection.crs
      • geost.base.Collection.data
      • geost.base.Collection.has_inclined
      • geost.base.Collection.header
      • geost.base.Collection.n_points
      • geost.base.Collection.vertical_datum
    • Accessor
      • geost.accessor.GeostFrame
      • geost.accessor.GeostFrame.get_cumulative_thickness
      • geost.accessor.GeostFrame.get_layer_base
      • geost.accessor.GeostFrame.get_layer_top
      • geost.accessor.GeostFrame.to_crs
      • geost.accessor.GeostFrame.to_vertical_datum
      • geost.accessor.GeostFrame.transform_coordinates
      • geost.accessor.GeostFrame.calculate_thickness
      • geost.accessor.GeostFrame.standardize_column_names
      • geost.accessor.GeostFrame.to_collection
      • geost.accessor.GeostFrame.to_header
      • geost.accessor.GeostFrame.validate
      • geost.accessor.GeostFrame.to_kingdom
      • geost.accessor.GeostFrame.to_pyvista_cylinders
      • geost.accessor.GeostFrame.to_pyvista_grid
      • geost.accessor.GeostFrame.to_qgis3d
      • geost.accessor.GeostFrame.select_by_condition
      • geost.accessor.GeostFrame.select_by_elevation
      • geost.accessor.GeostFrame.select_by_length
      • geost.accessor.GeostFrame.select_by_values
      • geost.accessor.GeostFrame.slice_by_values
      • geost.accessor.GeostFrame.slice_depth_interval
      • geost.accessor.GeostFrame.select_with_lines
      • geost.accessor.GeostFrame.select_with_points
      • geost.accessor.GeostFrame.select_within_bbox
      • geost.accessor.GeostFrame.select_within_polygons
      • geost.accessor.GeostFrame.spatial_join
      • geost.accessor.GeostFrame.first_row_survey
      • geost.accessor.GeostFrame.has_depth_columns
      • geost.accessor.GeostFrame.has_geometry
      • geost.accessor.GeostFrame.has_xy_columns
      • geost.accessor.GeostFrame.last_row_survey
      • geost.accessor.GeostFrame.is_layered
    • VoxelModel
      • geost.models.VoxelModel
      • geost.models.VoxelModel.from_netcdf
      • geost.models.VoxelModel.from_opendap
      • geost.models.VoxelModel.get_thickness
      • geost.models.VoxelModel.most_common
      • geost.models.VoxelModel.isel
      • geost.models.VoxelModel.sel
      • geost.models.VoxelModel.select_bottom
      • geost.models.VoxelModel.select_by_values
      • geost.models.VoxelModel.select_surface_level
      • geost.models.VoxelModel.select_top
      • geost.models.VoxelModel.select_with_line
      • geost.models.VoxelModel.select_with_points
      • geost.models.VoxelModel.select_within_bbox
      • geost.models.VoxelModel.select_within_polygons
      • geost.models.VoxelModel.slice_depth_interval
      • geost.models.VoxelModel.to_pyvista_grid
      • geost.models.VoxelModel.value_counts
      • geost.models.VoxelModel.zslice_to_tiff
      • geost.models.VoxelModel.crs
      • geost.models.VoxelModel.horizontal_bounds
      • geost.models.VoxelModel.resolution
      • geost.models.VoxelModel.shape
      • geost.models.VoxelModel.sizes
      • geost.models.VoxelModel.variables
      • geost.models.VoxelModel.vertical_bounds
      • geost.models.VoxelModel.xmax
      • geost.models.VoxelModel.xmin
      • geost.models.VoxelModel.ymax
      • geost.models.VoxelModel.ymin
      • geost.models.VoxelModel.zmax
      • geost.models.VoxelModel.zmin
    • GeoTop
      • geost.bro.bro_geotop.GeoTop
      • geost.bro.bro_geotop.GeoTop.from_netcdf
      • geost.bro.bro_geotop.GeoTop.from_opendap
      • geost.bro.bro_geotop.GeoTop.isel
      • geost.bro.bro_geotop.GeoTop.sel
      • geost.bro.bro_geotop.GeoTop.select_bottom
      • geost.bro.bro_geotop.GeoTop.select_by_values
      • geost.bro.bro_geotop.GeoTop.select_surface_level
      • geost.bro.bro_geotop.GeoTop.select_top
      • geost.bro.bro_geotop.GeoTop.select_with_line
      • geost.bro.bro_geotop.GeoTop.select_with_points
      • geost.bro.bro_geotop.GeoTop.select_within_bbox
      • geost.bro.bro_geotop.GeoTop.select_within_polygons
      • geost.bro.bro_geotop.GeoTop.slice_depth_interval
      • geost.bro.bro_geotop.GeoTop.zslice_to_tiff
      • geost.bro.bro_geotop.GeoTop.crs
      • geost.bro.bro_geotop.GeoTop.horizontal_bounds
      • geost.bro.bro_geotop.GeoTop.resolution
      • geost.bro.bro_geotop.GeoTop.shape
      • geost.bro.bro_geotop.GeoTop.sizes
      • geost.bro.bro_geotop.GeoTop.variables
      • geost.bro.bro_geotop.GeoTop.vertical_bounds
      • geost.bro.bro_geotop.GeoTop.xmax
      • geost.bro.bro_geotop.GeoTop.xmin
      • geost.bro.bro_geotop.GeoTop.ymax
      • geost.bro.bro_geotop.GeoTop.ymin
      • geost.bro.bro_geotop.GeoTop.zmax
      • geost.bro.bro_geotop.GeoTop.zmin
    • GeoTop selection
      • geost.bro.bro_geotop.StratGeotop
      • geost.bro.bro_geotop.StratGeotop.select_units
      • geost.bro.bro_geotop.StratGeotop.select_values
      • geost.bro.bro_geotop.StratGeotop.to_dict
      • geost.bro.bro_geotop.Lithology
      • geost.bro.bro_geotop.Lithology.select_units
      • geost.bro.bro_geotop.Lithology.select_values
      • geost.bro.bro_geotop.Lithology.to_dict
    • Analysis
      • geost.analysis.layers.get_layer_base
      • geost.analysis.layers.get_layer_top
      • geost.analysis.cpt.calc_ic
      • geost.analysis.cpt.calc_lithology
      • geost.analysis.grainsize.calculate_bhrgt_grainsize_percentiles
      • geost.analysis.grainsize.calculate_bhrgt_grainsize_fractions
      • geost.analysis.combine.add_nearest_voxelmodel_variable
      • geost.analysis.combine.add_voxelmodel_variable
    • BroApi
      • geost.bro.BroApi
      • geost.bro.BroApi.get_objects
      • geost.bro.BroApi.search_objects_in_bbox
      • geost.bro.BroApi.apis
    • Readers
      • geost.io.Geopackage
      • geost.io.Geopackage.close
      • geost.io.Geopackage.get_column_names
      • geost.io.Geopackage.get_connection
      • geost.io.Geopackage.layers
      • geost.io.Geopackage.query
      • geost.io.Geopackage.read_table
      • geost.io.Geopackage.table_head
      • geost.bro.BroCptGeopackage
      • geost.bro.BroCptGeopackage.from_geopackage
      • geost.bro.BroCptGeopackage.select_location_info
    • Validation
      • geost.validation.validate.ValidationResult.add
      • geost.validation.validate.ValidationResult.handle_errors
      • geost.validation.validate.ValidationResult.display_warnings
      • geost.validation.validate.ValidationResult.has_errors
      • geost.validation.validate.ValidationResult.error_nrs
      • geost.validation.validate.ValidationResult.error_indices
    • Utils
      • geost.utils.spatial.get_raster_values
      • geost.utils.spatial.select_points_near_lines
      • geost.utils.spatial.select_points_near_points
      • geost.utils.spatial.select_points_within_bbox
      • geost.utils.spatial.select_points_within_polygons
      • geost.utils.projections.horizontal_reference_transformer
      • geost.utils.projections.vertical_reference_transformer
      • geost.models.model_utils.label_consecutive_2d
      • geost.models.model_utils.sample_with_coords
      • geost.models.model_utils.sample_along_line
    • Enums
      • geost.enums.UnitEnum
      • geost.enums.UnitEnum.select_units
      • geost.enums.UnitEnum.select_values
      • geost.enums.UnitEnum.to_dict
  • Documentation
  • User guide

User guide#

Table of contents

  • Data structures
    • Collection
    • Overview of attributes and methods
    • GeoST accessor
    • Model data
  • Survey data
    • Reading survey data
    • Positional columns
    • Use with generic Geopandas/Pandas
  • Model data
    • Reading model data
    • Data reading examples
  • Data validation
    • Validation settings
    • Examples
    • Advanced: The ValidationResult object
  • Reading XML files
    • Reading with default schema
    • Schema
    • Retrieving additional attributes
    • Extending the schema
    • Very specific needs
  • BRO GeoTOP
    • Reading GeoTop
    • Working with GeoTop

previous

Documentation

next

Data structures

Show Source

© Copyright 2026, Deltares.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.17.1.