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
    • Reading data
    • BRO GeoTOP
  • API Reference
    • PointHeader
      • geost.base.PointHeader
      • geost.base.PointHeader.change_horizontal_reference
      • geost.base.PointHeader.change_vertical_reference
      • geost.base.PointHeader.get
      • geost.base.PointHeader.get_area_labels
      • geost.base.PointHeader.select_by_depth
      • geost.base.PointHeader.select_by_length
      • geost.base.PointHeader.select_with_lines
      • geost.base.PointHeader.select_with_points
      • geost.base.PointHeader.select_within_bbox
      • geost.base.PointHeader.select_within_polygons
      • geost.base.PointHeader.to_csv
      • geost.base.PointHeader.to_geopackage
      • geost.base.PointHeader.to_geoparquet
      • geost.base.PointHeader.to_parquet
      • geost.base.PointHeader.to_shape
      • geost.base.PointHeader.gdf
      • geost.base.PointHeader.horizontal_reference
      • geost.base.PointHeader.vertical_reference
    • DiscreteData
      • geost.base.DiscreteData
      • geost.base.DiscreteData.get_cumulative_thickness
      • geost.base.DiscreteData.get_layer_top
      • geost.base.DiscreteData.select_by_condition
      • geost.base.DiscreteData.select_by_values
      • geost.base.DiscreteData.slice_by_values
      • geost.base.DiscreteData.slice_depth_interval
      • geost.base.DiscreteData.to_collection
      • geost.base.DiscreteData.to_csv
      • geost.base.DiscreteData.to_datafusiontools
      • geost.base.DiscreteData.to_header
      • geost.base.DiscreteData.to_multiblock
      • geost.base.DiscreteData.to_parquet
      • geost.base.DiscreteData.to_vtm
      • geost.base.DiscreteData.datatype
      • geost.base.DiscreteData.df
    • LayeredData
      • geost.base.LayeredData
      • geost.base.LayeredData.get_cumulative_thickness
      • geost.base.LayeredData.get_layer_top
      • geost.base.LayeredData.select_by_condition
      • geost.base.LayeredData.select_by_values
      • geost.base.LayeredData.slice_by_values
      • geost.base.LayeredData.slice_depth_interval
      • geost.base.LayeredData.to_collection
      • geost.base.LayeredData.to_csv
      • geost.base.LayeredData.to_datafusiontools
      • geost.base.LayeredData.to_header
      • geost.base.LayeredData.to_kingdom
      • geost.base.LayeredData.to_multiblock
      • geost.base.LayeredData.to_parquet
      • geost.base.LayeredData.to_qgis3d
      • geost.base.LayeredData.to_vtm
      • geost.base.LayeredData.datatype
      • geost.base.LayeredData.df
    • BoreholeCollection
      • geost.base.BoreholeCollection
      • geost.base.BoreholeCollection.add_header_column_to_data
      • geost.base.BoreholeCollection.change_horizontal_reference
      • geost.base.BoreholeCollection.change_vertical_reference
      • geost.base.BoreholeCollection.check_header_to_data_alignment
      • geost.base.BoreholeCollection.get
      • geost.base.BoreholeCollection.get_area_labels
      • geost.base.BoreholeCollection.get_cumulative_thickness
      • geost.base.BoreholeCollection.get_layer_top
      • geost.base.BoreholeCollection.reset_header
      • geost.base.BoreholeCollection.select_by_condition
      • geost.base.BoreholeCollection.select_by_depth
      • geost.base.BoreholeCollection.select_by_length
      • geost.base.BoreholeCollection.select_by_values
      • geost.base.BoreholeCollection.select_with_lines
      • geost.base.BoreholeCollection.select_with_points
      • geost.base.BoreholeCollection.select_within_bbox
      • geost.base.BoreholeCollection.select_within_polygons
      • geost.base.BoreholeCollection.slice_by_values
      • geost.base.BoreholeCollection.slice_depth_interval
      • geost.base.BoreholeCollection.to_csv
      • geost.base.BoreholeCollection.to_datafusiontools
      • geost.base.BoreholeCollection.to_geopackage
      • geost.base.BoreholeCollection.to_geoparquet
      • geost.base.BoreholeCollection.to_kingdom
      • geost.base.BoreholeCollection.to_multiblock
      • geost.base.BoreholeCollection.to_parquet
      • geost.base.BoreholeCollection.to_qgis3d
      • geost.base.BoreholeCollection.to_shape
      • geost.base.BoreholeCollection.to_vtm
      • geost.base.BoreholeCollection.data
      • geost.base.BoreholeCollection.has_inclined
      • geost.base.BoreholeCollection.header
      • geost.base.BoreholeCollection.horizontal_reference
      • geost.base.BoreholeCollection.n_points
      • geost.base.BoreholeCollection.vertical_reference
    • CptCollection
      • geost.base.CptCollection
      • geost.base.CptCollection.add_header_column_to_data
      • geost.base.CptCollection.change_horizontal_reference
      • geost.base.CptCollection.change_vertical_reference
      • geost.base.CptCollection.check_header_to_data_alignment
      • geost.base.CptCollection.get
      • geost.base.CptCollection.get_area_labels
      • geost.base.CptCollection.get_cumulative_thickness
      • geost.base.CptCollection.get_layer_top
      • geost.base.CptCollection.reset_header
      • geost.base.CptCollection.select_by_condition
      • geost.base.CptCollection.select_by_depth
      • geost.base.CptCollection.select_by_length
      • geost.base.CptCollection.select_by_values
      • geost.base.CptCollection.select_with_lines
      • geost.base.CptCollection.select_with_points
      • geost.base.CptCollection.select_within_bbox
      • geost.base.CptCollection.select_within_polygons
      • geost.base.CptCollection.slice_by_values
      • geost.base.CptCollection.slice_depth_interval
      • geost.base.CptCollection.to_csv
      • geost.base.CptCollection.to_datafusiontools
      • geost.base.CptCollection.to_geopackage
      • geost.base.CptCollection.to_geoparquet
      • geost.base.CptCollection.to_multiblock
      • geost.base.CptCollection.to_parquet
      • geost.base.CptCollection.to_shape
      • geost.base.CptCollection.to_vtm
      • geost.base.CptCollection.data
      • geost.base.CptCollection.has_inclined
      • geost.base.CptCollection.header
      • geost.base.CptCollection.horizontal_reference
      • geost.base.CptCollection.n_points
      • geost.base.CptCollection.vertical_reference
    • Input/Output
      • geost.get_bro_objects_from_bbox
      • geost.get_bro_objects_from_geometry
      • geost.read_borehole_table
      • geost.read_cpt_table
      • geost.read_nlog_cores
      • geost.read_uullg_tables
      • geost.base.Collection.to_csv
      • geost.base.Collection.to_parquet
      • geost.read_gef_cpts
      • geost.read_collection_geopackage
      • geost.base.Collection.to_geopackage
      • geost.base.Collection.to_geoparquet
      • geost.base.Collection.to_shape
      • geost.read_pickle
    • VoxelModel
      • geost.models.VoxelModel
      • geost.models.VoxelModel.from_netcdf
      • 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.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
    • BroApi
      • geost.bro.BroApi
      • geost.bro.BroApi.get_objects
      • geost.bro.BroApi.search_objects_in_bbox
      • geost.bro.BroApi.apis
      • geost.bro.BroApi.document_types
    • 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.cumulative_thickness
      • geost.analysis.find_top_sand
      • geost.analysis.layer_top
      • geost.analysis.top_of_sand
      • geost.analysis.interpret_cpt.calc_ic
      • geost.analysis.interpret_cpt.calc_lithology
      • geost.analysis.combine.add_voxelmodel_variable
    • Utils
      • geost.spatial.find_area_labels
      • geost.spatial.get_raster_values
      • geost.spatial.select_points_near_lines
      • geost.spatial.select_points_near_points
      • geost.spatial.select_points_within_bbox
      • geost.spatial.select_points_within_polygons
      • geost.projections.horizontal_reference_transformer
      • geost.projections.vertical_reference_transformer
      • geost.projections.xy_to_ll
      • 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#

User guide

  • Data structures
    • Point and line data
    • Model data
  • Reading data
    • Supported subsurface data
    • Data reading examples
  • BRO GeoTOP
    • Reading GeoTop
    • Working with GeoTop

This is the user guide.

previous

Documentation

next

Data structures
Show Source

© Copyright 2024, Deltares.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.0.