Code

GemPy API

activate_interactive_df(geo_model[, plot_object])

Experimental: Activate the use of the QgridProjectIntegration: TODO evaluate the use of this functionality

compute_model(model[, output, at, …])

Computes the geological model and any extra output given in the additional data option.

compute_model_at(new_grid, model, **kwargs)

This function creates a new custom grid and deactivate all the other grids and compute the model there:

create_data([project_name, extent, resolution])

Create a gempy.core.model.Project object and initialize some of the main functions such as:

create_model([project_name])

Create a Project object.

init_data(geo_model[, extent, resolution])

Initialize some of the main functions such as:

map_series_to_surfaces(geo_model[, …])

Mapping which surfaces belongs to which geological feature

map_stack_to_surfaces(geo_model[, …])

Mapping which surfaces belongs to which geological feature

read_csv(geo_model[, path_i, path_o])

param geo_model

update_additional_data(model[, …])

param model

get_data(model[, itype, numeric, verbosity])

Method to return the data stored in pandas.DataFrame within a gempy.core.model.Project data object.

get_surfaces(model_solution)

Get vertices and simplices of the surface_points for its vtk visualization and further analysis.

get_additional_data(model)

get_interpolator(model)

get_th_fn(model)

Get the compiled theano function

Model

Project([project_name])

Container class of all objects that constitute a GemPy model.

ImplicitCoKriging()

This class handles all the mutation of the data objects of the model involved on the

Plot

plot_2d(model[, n_axis, section_names, …])

Plot 2-D sections of geomodel.

plot_3d(model[, plotter_type, show_data, …])

foobar

Data

Stack(features_names, fault_features, rel_matrix)

Class that encapsulates all type of geological features. So far is Series and

Series(faults, series_names)

Class that contains the functionality and attributes related to the series.

Faults([series_fault, rel_matrix])

Class that encapsulate faulting related content.

Surfaces(series[, surface_names, …])

Class that contains the surfaces of the model and the values of each of them.

Structure(surface_points, orientations, …)

The structure_data class analyse the different lengths of subset in the interface and orientations categories_df to pass them to the theano function.

KrigingParameters(grid, structure)

Class that stores and computes the default values for the kriging parameters used during the interpolation.

Options()

The class options contains the auxiliary user editable flags mainly independent to the model.

AdditionalData(surface_points, orientations, …)

Container class that encapsulate Structure, KrigingParameters, Options and

MetaData([project_name])

Class containing metadata of the project.

Grid(**kwargs)

Class to generate grids.

Grids

RegularGrid([extent, resolution])

Class with the methods and properties to manage 3D regular grids where the model will be interpolated.

CustomGrid(custom_grid)

Object that contains arbitrary XYZ coordinates.

Topography([regular_grid, …])

Object to include topography in the model.

Sections([regular_grid, z_ext, section_dict])

Object that creates a grid of cross sections between two points.

CenteredGrid([centers, radius, resolution])

Logarithmic spaced grid.

Geometric Data

SurfacePoints(surfaces[, coord, surface])

Data child with specific methods to manipulate interface data.

Orientations(surfaces[, coord, pole_vector, …])

Data child with specific methods to manipulate orientation data.

RescaledData(surface_points, orientations, …)

Auxiliary class to rescale the coordinates between 0 and 1 to increase float stability.

Interpolator

InterpolatorModel(surface_points, …)

Child class of Interpolator which set the shared variables and compiles the theano graph to compute the geological model, i.e. lithologies.

InterpolatorGravity()

Solution

Solution(grid, surfaces, series)

This class stores the output of the interpolation and the necessary objects to visualize and manipulate this data.