Code

GemPy API

compute_model(gempy_model[, engine_config])	Compute the geological model given the provided GemPy model.
create_geomodel(*[, project_name, extent, ...])	Initializes and returns a GeoModel instance with specified parameters.
map_stack_to_surfaces(gempy_model, ...[, ...])	Map stack (series) to surfaces by reorganizing elements between groups in a GeoModel's structural frame.
structural_elements_from_borehole_set(...)	Creates a list of StructuralElements from a BoreholeSet.
set_section_grid(grid, section_dict)
set_active_grid(grid, grid_type[, reset])
set_topography_from_random(grid[, ...])	Sets the topography of the grid using a randomly generated topography.
set_topography_from_file(grid, filepath[, ...])
set_topography_from_subsurface_structured_grid(...)
set_topography_from_arrays(grid, xyz_vertices)
set_custom_grid(grid, xyz_coord)
set_centered_grid(grid, centers, resolution, ...)
generate_example_model(example_model[, ...])
set_fault_relation(frame, rel_matrix)	Sets the fault relations in the structural frame of the GeoModel.
set_is_fault(frame, fault_groups[, ...])	Sets given groups as fault in the structural frame of the GeoModel.
set_is_finite_fault(self[, series_fault, toggle])
add_surface_points(geo_model, x, y, z, ...)	Add surface points to the geological model.
add_orientations(geo_model, x, y, z, ...[, ...])	Add orientation data to the geological model.
delete_surface_points()
delete_orientations()
create_orientations_from_surface_points_coords(...)
modify_surface_points(geo_model[, slice, ...])	Modifies specified fields of all surface points in the structural frame.
modify_orientations(geo_model[, slice])	Modifies specified fields of all orientations in the structural frame.
add_structural_group(model, group_index, ...)
remove_structural_group_by_index(model, ...)
remove_structural_group_by_name(model, ...)
remove_element_by_name(model, element_name)
calculate_gravity_gradient(centered_grid[, ugal])

Plot

plot_2d(model[, n_axis, section_names, ...])	Plot 2-D sections of the geomodel.
plot_3d(model[, plotter_type, ...])	Plot 3-D geomodel.

Data Classes

Modeling Classes

GeoModel(name, structural_frame, grid, ...)	Class representing a geological model.
StructuralFrame(structural_groups, color_gen)	Represents a structural frame, which is a collection of structural groups that constitute a geological model.
StructuralGroup(name, elements, ...[, ...])	An abstract base class that represents a structural group within a geological model.
StructuralElement(name, surface_points, ...)	Class that represents a structural element in a geological model.
SurfacePointsTable(data[, name_id_map, ...])	A dataclass to represent a table of surface points in a geological model.
OrientationsTable(data[, name_id_map, ...])	A dataclass to represent a table of orientations in a geological model.
InterpolationOptions(range, c_o, uni_degree, ...)
Grid([extent, resolution])
Topography(regular_grid[, values_2d])	Object to include topography in the model.
Solutions(octrees_output[, dc_meshes, ...])
RawArraysSolution(lith_block, fault_block, ...)
FaultsData([fault_values_everywhere, ...])
GeophysicsInput(tz, densities)
Transform(position, rotation, scale[, ...])

Helper Classes

ImporterHelper(path_to_surface_points, ...)
GemPyEngineConfig(backend, use_gpu, dtype)
ColorsGenerator()	Object that handles the color management.

Enumerators

StackRelationType(value)	An enumeration.
GlobalAnisotropy(value)	An enumeration.
AvailableBackends(value)	An enumeration.
FaultsRelationSpecialCase(value)	An enumeration.