Getting Started

Welcome to our introductory notebook on GemPy! Here, we will cover the essentials of GemPy, introducing you to the core concepts of geomodeling and demonstrating how you can leverage these to create your own geological models. We will guide you through building a model from scratch, based on a conceptual 2D cross-section with boreholes. This simple example will highlight key workflow steps and structural features that GemPy can model.

Installation

https://docs.gempy.org/installation.html

Setting Up Our Environment: Importing Libraries

To work with Python packages in our notebook, we need to import them first. Let’s start with that. In the following cell, we will import GemPy and its GemPy viewer module, which we will be using extensively. Additionally, we will use NumPy for various functions, as well as Matplotlib and some of its specific modules/functions for visualizing our data and results in 2D and 3D.

Set environmental variable DEFAULT_BACKEND = PYTORCH

import os

os.environ["DEFAULT_BACKEND"] = "PYTORCH"

# Importing GemPy and viewer
import gempy as gp
import gempy_viewer as gpv

# Auxiliary libraries
import numpy as np
import matplotlib.pyplot as plt
import matplotlib.image as mpimg

# sphinx_gallery_thumbnail_number = 11

Main Classes and Objects in GemPy

GemPy uses Python classes and objects to store and manipulate the data used for modeling. This object-oriented approach helps make the code more modular, reusable, and easier to understand. Each class represents a different aspect of the geological modeling process, and objects are instances of these classes that contain specific data and methods to operate on that data.

Here are the main data classes:

Setting Up a Model: Initializing Objects and Input Data

Before computing a geological model, we need to set up the relevant objects and input data on which the model will be based. Data can be input in various ways. One way is to start from scratch and manually input surface points and orientations. Another way is to import existing data from a file, such as a CSV. Here, we will start with the first method to showcase the essential elements and rules needed to build a model in GemPy.

Starting a Model from Scratch Based on a Cross-Section

This first example will be based on a conceptual cross-section that includes data from three boreholes in a line. Let’s start by loading the image of this cross-section and plotting it using Matplotlib. For this example, we assume that the size of the image corresponds to the real extent of the data. We will see that extent in the plot and also return it by looking at the shape of the image file:

img = mpimg.imread('boreholes_concept.png')
plt.imshow(img, origin='upper', alpha=.8)
img.shape[:2]
get started
(582, 780)

OK, so we will base our model creation on this cross-section. Let’s get started. To initialize our model, we create a gempy.Model object. This object will contain all other data structures and necessary functionality. Here’s what we will do:

  1. Name the Model: Assign a name to our model.

  2. Define Extent: Specify the extent in x, y, and z. The extent should make sense depending on your use case and should enclose all relevant data in a representative space. For this example, we align the extent with the cross-section we imported:

    • X is parallel to the section.

    • Y is perpendicular. Since we have no data along y, a narrow extent makes sense. We choose an extent of 400, defining it as -200 to 200, placing the cross-section at y=0 (in the middle).

    • Z representing depth, takes a negative value since we are modeling the subsurface.

  3. Initialize Structural Framework: Set up a default structural framework.

  4. Define either resolution or refinement: In GemPy 3, you can use either regular grids or octrees.
    • Regular grids: Define a resolution (and refinement=None). A medium resolution of 50x50x50, for example, results in 125,000 voxels. Model voxels are prisms, not cubes, so resolution can differ from extent. Avoid exceeding 100 cells in each direction (1,000,000 voxels) to prevent high computational costs.

    • Octrees: Define a level of refinement (and resolution=None). Higher refinement levels increase computational costs.

Note on choice of modeling grids

Which type of grid is used depends on the use case. Note that as of the current version of GemPy 3, the rendering of surfaces uses dual-contouring, which is based on octrees. So even if you choose regular grids, octree-based computing will be executed additionally in order to render the surfaces in 3D.

geo_model = gp.create_geomodel(
    project_name='Model1',
    extent=[0, 780, -200, 200, -582, 0],
    resolution=(50, 50, 50),
    # refinement=4, # We will use octrees
    structural_frame=gp.data.StructuralFrame.initialize_default_structure()
)

The geo_model Object

The gempy.core.data.GeoModel object we just initialized contains all the essential information for constructing our model, such as the parameters defined above, and the input data we will introduce further below. You can access different types of information by accessing the attributes. For instance, you can retrieve the coordinates of our modeling grid as follows:

Grid(values=array([[   7.8 , -196.  , -576.18],
       [   7.8 , -196.  , -564.54],
       [   7.8 , -196.  , -552.9 ],
       ...,
       [ 772.2 ,  196.  ,  -29.1 ],
       [ 772.2 ,  196.  ,  -17.46],
       [ 772.2 ,  196.  ,   -5.82]]), length=array([], dtype=float64), _octree_grid=None, _dense_grid=RegularGrid(resolution=array([50, 50, 50]), extent=array([   0.,  780., -200.,  200., -582.,    0.]), values=array([[   7.8 , -196.  , -576.18],
       [   7.8 , -196.  , -564.54],
       [   7.8 , -196.  , -552.9 ],
       ...,
       [ 772.2 ,  196.  ,  -29.1 ],
       [ 772.2 ,  196.  ,  -17.46],
       [ 772.2 ,  196.  ,   -5.82]]), mask_topo=array([], shape=(0, 3), dtype=bool), _transform=None), _custom_grid=None, _topography=None, _sections=None, _centered_grid=None, _transform=None, _octree_levels=-1)

The geo_model object also contains the structural frame of our model, i.e., information about our main structural groups (also referred to as series or stacks in our model), and their sequential and geological relationships with one another. Each group can contain several elements, which can be surfaces representing the bottom interfaces of lithological units or fault planes. Each structural group also has a relation type that defines the relation of the structural elements to others. The relation type is ‘erode’ by default but can also be ‘onlap’ or ‘fault’ (more about this later). The structural frame also contains information about fault relationships, i.e., which elements are affected by which faults. Let’s look at our default structural frame:

Structural Groups: StructuralGroup:
Name:default_formations
Structural Relation:StackRelationType.ERODE
Elements:
StructuralElement:
Name:surface1
Fault Relations:
default_fo...
default_formations
True
False


As you can see, by default, there is one element called ‘surface 1’ and no faults. However, by default, GemPy actually not only starts off with this ‘surface 1’ but also a ‘basement’ unit which is always present. We can see this using the following function:

[Element(
    name=surface1,
    color=#015482,
    is_active=True
), Element(
    name=basement,
    color=#9f0052,
    is_active=True
)]

We can also rename our structural elements and assign colors as needed. This will later become relevant for the legend in our plots of the data and generated model. Let’s assume we already know our uppermost surface, ‘surface 1,’ is a limestone unit. Let’s also ensure it is represented by the same color as displayed in the cross-section. For this, we input hex color codes.

geo_model.structural_frame.structural_elements[0].color = '#33ABFF'  # Set 'surface 1' color to blue.
geo_model.structural_frame.structural_elements[1].color = '#570987'  # Set basement color to purple.

geo_model.structural_frame.structural_elements[0].name = 'Limestone'  # Renaming 'surface 1' to 'Limestone'.
geo_model.structural_frame.structural_elements[0]
StructuralElement:
Name:Limestone


geo_model.structural_frame.structural_groups[0].name = 'Deposit. Series'

Manually Inputting Data

Now that the geo_model object has been created and our first structural element renamed, we can start inputting data by reading it from the cross-section. We start with location points that represent the boundaries between two lithological units. Let’s look at the cross-section again. This time we use a gempy_viewer function to create a plot that can include the cross-section image, as well as data in the object geo_model - which is for now empty but we will start adding data next. Let’s also add a grid to better read the location of points.

The image cross-section indicates that there are three lithological boundaries, with one dot for each boundary shown in the first two boreholes. The third borehole doesn’t go as deep and only provides one dot, i.e., information about the first boundary. These dots represent the location of a boundary surface in depth. Remember also that in GemPy, each surface represents the bottom of the unit it is assigned to.

p2d = gpv.plot_2d(geo_model, show=False)
p2d.axes[0].imshow(img, origin='upper', alpha=.8, extent=(0, 780, -582, 0))

# Enable grid with minor ticks
p2d.axes[0].grid(which='both')  # Enable both major and minor grids
p2d.axes[0].minorticks_on()  # Enable minor ticks

# Customize the appearance of the grid if needed
p2d.axes[0].grid(which='major', linestyle='--', linewidth='0.8', color='gray')
p2d.axes[0].grid(which='minor', linestyle=':', linewidth='0.4', color='gray')

plt.show()
Cell Number: mid Direction: y

Looking at the plot, we can read the location of the surface points and start adding them to our geo_model object. For now, let’s focus on only the uppermost layer, the limestone, with its bottom boundary represented by the blue dots. Using the function add_surface_points, we can start adding the positional points to our geo_model object. Let’s start with only one. From looking at the plot, the first blue point seems to be located at approximately 250 in the x direction and around 95 meters in depth. Since we assume the section to be at y=0, we can leave y as 0. We can input that as follows: %%

gp.add_surface_points(
    geo_model=geo_model,
    x=[225],
    y=[0],
    z=[-95],
    elements_names=['Limestone']
)
Structural Groups: StructuralGroup:
Name:Deposit. Series
Structural Relation:StackRelationType.ERODE
Elements:
StructuralElement:
Name:Limestone
Fault Relations:
Deposit. S...
Deposit. Series
True
False


Now let’s plot the data with the section and see how we did:

p2d = gpv.plot_2d(geo_model, show=False)
p2d.axes[0].imshow(img, origin='upper', alpha=.8, extent=(0, 780, -582, 0))

# Enable grid with minor ticks
p2d.axes[0].grid(which='both')  # Enable both major and minor grids
p2d.axes[0].minorticks_on()  # Enable minor ticks

# Customize the appearance of the grid if needed
p2d.axes[0].grid(which='major', linestyle='--', linewidth='0.8', color='gray')
p2d.axes[0].grid(which='minor', linestyle=':', linewidth='0.4', color='gray')

plt.show()
Cell Number: mid Direction: y

Great! As you can see, the data point we entered sits right on top of the blue dot on the borehole. Now let’s do the same for the other borehole dots. Conveniently, we can use the same function to add several points at a time:

gp.add_surface_points(
    geo_model=geo_model,
    x=[460, 617],
    y=[0, 0],
    z=[-100, -10],
    elements_names=['Limestone', 'Limestone']
)

p2d = gpv.plot_2d(geo_model, show=False)
p2d.axes[0].imshow(img, origin='upper', alpha=.8, extent=(0, 780, -582, 0))

# Enable grid with minor ticks
p2d.axes[0].grid(which='both')  # Enable both major and minor grids
p2d.axes[0].minorticks_on()  # Enable minor ticks

# Customize the appearance of the grid if needed
p2d.axes[0].grid(which='major', linestyle='--', linewidth='0.8', color='gray')
p2d.axes[0].grid(which='minor', linestyle=':', linewidth='0.4', color='gray')

plt.show()
Cell Number: mid Direction: y

Minimum Data for Model Computation

Ok, good! Now we have added the position of the bottom of this top layer for each borehole. But is this enough to compute our first layer? Well, no. GemPy’s approach is based on an implicit interpolation method that requires the following minimum data:

  • Two surface points for at least one surface in a structural group/series

  • One orientation per structural group/series

Thanks to GemPy’s global interpolation approach, once you have one surface defined by two surface points and an orientation in a structural group, you can add more surfaces (in the same group) with the minimum of one surface point, as it will now take its orientation information from the other surface.

So, we are missing an orientation. Let’s go ahead and add one. It seems that we can assume a horizontal orientation between the first two surface points (apparent, as we have no information about the y-direction). Let’s add a corresponding orientation using the function add_orientations:

gp.add_orientations(
    geo_model=geo_model,
    x=[350],
    y=[0],
    z=[-120],
    elements_names=['Limestone'],
    pole_vector=[np.array([0, 0, 1])]
)

p2d = gpv.plot_2d(geo_model, show=False)
p2d.axes[0].imshow(img, origin='upper', alpha=.8, extent=(0, 780, -582, 0))

# Enable grid with minor ticks
p2d.axes[0].grid(which='both')  # Enable both major and minor grids
p2d.axes[0].minorticks_on()  # Enable minor ticks

# Customize the appearance of the grid if needed
p2d.axes[0].grid(which='major', linestyle='--', linewidth='0.8', color='gray')
p2d.axes[0].grid(which='minor', linestyle=':', linewidth='0.4', color='gray')

plt.show()
Cell Number: mid Direction: y

Alright, now we actually have sufficient input data to compute the first version of our model. Let’s go ahead and do that using compute_model:

geo_model.update_transform(gp.data.GlobalAnisotropy.NONE)
Setting Backend To: AvailableBackends.numpy
Solutions: 4 Octree Levels, 1 DualContouringMeshes


Now, the model has been computed and is ready to be visualized. Let’s see what it looks like in a 2D section:

2D visualization:

gpv.plot_2d(geo_model, cell_number='mid')
Cell Number: mid Direction: y
<gempy_viewer.modules.plot_2d.visualization_2d.Plot2D object at 0x7fb6049b2ec0>

We can also plot it together with our cross-section image. By using transparency on the cross-section image, we can overlay it over the 2D model visualization.

p2d = gpv.plot_2d(geo_model, show=False)
p2d.axes[0].imshow(img, origin='upper', alpha=.8, extent=(0, 780, -582, 0))

# Enable grid with minor ticks
p2d.axes[0].grid(which='both')  # Enable both major and minor grids
p2d.axes[0].minorticks_on()  # Enable minor ticks

# Customize the appearance of the grid if needed
p2d.axes[0].grid(which='major', linestyle='--', linewidth='0.8', color='gray')
p2d.axes[0].grid(which='minor', linestyle=':', linewidth='0.4', color='gray')

plt.show()
Cell Number: mid Direction: y

You can see how the computed interface runs through the points we defined and is furthermore determined by the one orientation we placed. Now, let’s look at our 3D model:

3D visualization:

gpv.plot_3d(geo_model, show_surfaces=True, image=False)
get started
<gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7fb6048e3910>

Very good, we have successfully computed the first iteration of our model including one lithological interface. You could now go ahead and fine-tune the model by adding further points or orientations. For now, let’s continue.

About Scalar Fields

GemPy’s global interpolation approach uses scalar fields to compute models. Each structural group or series has its own scalar field, which is defined by the data input to all of its elements and at least the minimum data mentioned above. Given that alone, a scalar field will already be created “globally”, i.e., for the full extent of the modeling space. The defined surface follows one value along that field as an isosurface. A separate structural element will follow a different isosurface, and once you input additional points and orientations, the scalar field will be altered accordingly.

As mentioned, each structural group has its own scalar field. These can be combined to achieve more complex structures and relationships, as we will see later.

Let’s take a look at the current scalar field for our current group by plotting it in 2D. Keep it in mind as we go ahead and add additional elements and data.

p2d = gpv.plot_2d(
    model=geo_model,
    series_n=0,  # This will plot the scalar field used for the fault
    show_data=True,
    show_scalar=True,
    show_lith=False
)

plt.show()
Cell Number: mid Direction: y

Adding a Second Lithological Unit

To add another unit to our model, we can define it as another structural element and then append it to our geo_model object. We do this for the second unit in the following steps. See how we can already give it a name (let’s assume this is a siltstone now), a color corresponding to the dot colors in the cross-section, as well as define surface points and orientations. By appending it to structural_groups[0], we are adding it to our first (and currently only) structural group/series, i.e., it will be in the same stack as our limestone.

element2 = gp.data.StructuralElement(
    name='Siltstone',
    color='#FFA833',  # color=next(geo_model.structural_frame.color_generator),
    surface_points=gp.data.SurfacePointsTable.from_arrays(
        x=np.array([460]),
        y=np.array([0]),
        z=np.array([-280]),
        names='Siltstone'
    ),
    orientations=gp.data.OrientationsTable.initialize_empty()
)

geo_model.structural_frame.structural_groups[0].append_element(element2)

Now, we can see that this siltstone unit is part of our structural frame. Note below, that it has by default been added below the limestone. The order of structural elements within one group only affects the default color assigned. We recommend being consistent in the way you choose to order them, and to order them in accordance with geological age. The order of structural groups actually represents geological time relationships, with groups at the top being the youngest and lower ones being older. This, together with their StackRelationType, decides how they affect each other via their individual scalar fields, as we will see later.

Structural Groups: StructuralGroup:
Name:Deposit. Series
Structural Relation:StackRelationType.ERODE
Elements:
StructuralElement:
Name:Limestone

StructuralElement:
Name:Siltstone
Fault Relations:
Deposit. S...
Deposit. Series
True
False


Setting Backend To: AvailableBackends.numpy
Solutions: 4 Octree Levels, 2 DualContouringMeshes


p2d = gpv.plot_2d(geo_model, cell='mid', show=False)
p2d.axes[0].imshow(img, origin='upper', alpha=.8, extent=(0, 780, -582, 0))

# Enable grid with minor ticks
p2d.axes[0].grid(which='both')  # Enable both major and minor grids
p2d.axes[0].minorticks_on()  # Enable minor ticks

# Customize the appearance of the grid if needed
p2d.axes[0].grid(which='major', linestyle='--', linewidth='0.8', color='gray')
p2d.axes[0].grid(which='minor', linestyle=':', linewidth='0.4', color='gray')

plt.show()
Cell Number: mid Direction: y

The 2D visualization of our updated model now shows that the next surface follows the respective point we added. Based on the implicit modeling approach GemPy uses, given this sparse information we have put in, the siltstone bottom interface otherwise follows the course and orientation of the limestone we defined earlier. This is due to the scalar field which was defined by the data input for the structural group as a whole. In our 2D plot, we can see that this fits quite well with the first borehole, too. Still, let’s add the remaining point, and while we are at it, let’s also add the third lithological unit marked in green.

First, we add the two missing points to the Siltstone

gp.add_surface_points(
    geo_model=geo_model,
    x=[225],
    y=[0],
    z=[-270],
    elements_names=['Siltstone']
)

element3 = gp.data.StructuralElement(
    name='Sandstone',
    color='#72A533',  # next(geo_model.structural_frame.color_generator),
    surface_points=gp.data.SurfacePointsTable.from_arrays(
        x=np.array([225, 460]),
        y=np.array([0, 0]),
        z=np.array([-436, -441]),
        names='Sandstone'
    ),
    orientations=gp.data.OrientationsTable.initialize_empty()
)

geo_model.structural_frame.structural_groups[0].append_element(element3)
Setting Backend To: AvailableBackends.numpy
Solutions: 4 Octree Levels, 3 DualContouringMeshes


p2d = gpv.plot_2d(geo_model, show=False)
p2d.axes[0].imshow(img, origin='upper', alpha=.8, extent=(0, 780, -582, 0))

# Enable grid with minor ticks
p2d.axes[0].grid(which='both')  # Enable both major and minor grids
p2d.axes[0].minorticks_on()  # Enable minor ticks

# Customize the appearance of the grid if needed
p2d.axes[0].grid(which='major', linestyle='--', linewidth='0.8', color='gray')
p2d.axes[0].grid(which='minor', linestyle=':', linewidth='0.4', color='gray')

plt.show()
Cell Number: mid Direction: y

3D visualization:

gpv.plot_3d(geo_model, show_surfaces=True, image=False)
get started
<gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7fb60431bcd0>

Discontinuities: Combining Scalar Fields

Now that we have created all the lithological units and added all the surface points we got from the boreholes, we have created a very simple geological model. However, geological scenarios are usually more complex. In GemPy, you can not only combine numerous surface points and orientations to create elaborate structures but also create various structural groups that affect each other through combinations of their scalar fields. In the following part, we will look at the right side of our cross-section, where we only have limited data, and see how we can add a new structural group to create various types of discontinuities, and with that, possibly even meaningful alternative model hypotheses.

So, let’s define another structural element that will serve to showcase the different types of discontinuities we can implement in GemPy:

element_discont = gp.data.StructuralElement(
    name='Discont_Surface',
    color='#990000',  # next(geo_model.structural_frame.color_generator),
    surface_points=gp.data.SurfacePointsTable.from_arrays(
        x=np.array([550, 650]),
        y=np.array([0, 0]),
        z=np.array([-30, -200]),
        names='Discont_Surface'
    ),
    orientations=gp.data.OrientationsTable.from_arrays(
        x=np.array([600]),
        y=np.array([0]),
        z=np.array([-100]),
        G_x=np.array([.3]),
        G_y=np.array([0]),
        G_z=np.array([.3]),
        names='Discont_Surface'
    )
)

To place the discontinuity element in a separate structural group, we need to create one. This is what we do next. Note that we directly add the element to the group as we create it, and we define the group’s structural relation type as the default ‘erode’. We can then insert the group into the structural frame.

group_discont = gp.data.StructuralGroup(
    name='Discontinuity',
    elements=[element_discont],
    structural_relation=gp.data.StackRelationType.ERODE,
)

# Insert the fault group into the structural frame:
geo_model.structural_frame.insert_group(0, group_discont)

Let’s take a quick look at the state of our structural frame.

Structural Groups: StructuralGroup:
Name:Discontinuity
Structural Relation:StackRelationType.ERODE
Elements:
StructuralElement:
Name:Discont_Surface

StructuralGroup:
Name:Deposit. Series
Structural Relation:StackRelationType.ERODE
Elements:
StructuralElement:
Name:Limestone

StructuralElement:
Name:Siltstone

StructuralElement:
Name:Sandstone
Fault Relations:
Discontinu...Deposit. S...
Discontinuity
Deposit. Series
True
False


We can now see the two different structural groups: the default one containing the deposition series, and the group containing the discontinuity. Let’s go ahead and compute the model. Once the model has been computed, we can plot the scalar fields of both structural groups independently.

Setting Backend To: AvailableBackends.numpy
Solutions: 4 Octree Levels, 4 DualContouringMeshes


p2d = gpv.plot_2d(
    model=geo_model,
    series_n=1,  # This will plot the scalar field used for the fault
    show_data=True,
    show_scalar=True,
    show_lith=False
)

plt.show()
Cell Number: mid Direction: y
p2d = gpv.plot_2d(
    model=geo_model,
    series_n=0,  # This will plot the scalar field used for the discontinuity.
    show_data=True,
    show_scalar=True,
    show_lith=False
)

plt.show()
Cell Number: mid Direction: y

We now have two very different scalar fields. Note how they are each defined by the input data assigned to their respective structural elements. Multiple scalar fields in GemPy influence each other depending on (1) their order and (2) their StackRelationType. The latter defines how a younger (upper) structural group will relate to the older (lower) structural groups and possibly affect their scalar field.

The parameter StackRelationType can take the following values:

  • BASEMENT: Treats all lower groups as the basement.

  • ERODE: Defines erosive contact/unconformity.

  • ONLAP: Defines the younger group to be onlapping onto the older groups.

  • FAULT: Defines the group to be a fault.

We will now take a look at each of these relation types except for the basement type.

Erosive Contact

For this, we don’t have to change anything now, as we already set the StackRelationType to be ERODE. If we now plot it, we will see how this younger structural group erodes all older elements and basically “cuts them out” in our model.

p2d = gpv.plot_2d(geo_model, show=False)
p2d.axes[0].imshow(img, origin='upper', alpha=.8, extent=(0, 780, -582, 0))

# Enable grid with minor ticks
p2d.axes[0].grid(which='both')  # Enable both major and minor grids
p2d.axes[0].minorticks_on()  # Enable minor ticks

# Customize the appearance of the grid if needed
p2d.axes[0].grid(which='major', linestyle='--', linewidth='0.8', color='gray')
p2d.axes[0].grid(which='minor', linestyle=':', linewidth='0.4', color='gray')

plt.show()
Cell Number: mid Direction: y

3D visualization:

gpv.plot_3d(geo_model, show_surfaces=True, image=False, show_lith=False)
get started
<gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7fb60488c670>

We can see how all units of the depositional series stop at the contact with the new discontinuity group. However, this doesn’t look quite right, and it in particular doesn’t fit the surface point that was observed in the third borehole. So let’s try another relation type.

Onlapping

Let’s change the relation type from ERODE to ONLAP to achieve a different type of discontinuity and then plot it.

geo_model.structural_frame.structural_groups[0].structural_relation = gp.data.StackRelationType.ONLAP
Setting Backend To: AvailableBackends.numpy
Solutions: 4 Octree Levels, 4 DualContouringMeshes


p2d = gpv.plot_2d(geo_model, show=False)
p2d.axes[0].imshow(img, origin='upper', alpha=.8, extent=(0, 780, -582, 0))

# Enable grid with minor ticks
p2d.axes[0].grid(which='both')  # Enable both major and minor grids
p2d.axes[0].minorticks_on()  # Enable minor ticks

# Customize the appearance of the grid if needed
p2d.axes[0].grid(which='major', linestyle='--', linewidth='0.8', color='gray')
p2d.axes[0].grid(which='minor', linestyle=':', linewidth='0.4', color='gray')

plt.show()
Cell Number: mid Direction: y

3D visualization:

gpv.plot_3d(geo_model, show_surfaces=True, image=False, show_lith=False)
get started
<gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7fb60474efe0>

Now the unit defined as part of the discontinuity group is onlapping onto the uppermost surface of the default group and ends there. This also doesn’t really make sense considering the data given, so let’s try the last relation type.

Faults

Let’s change the relation type to FAULT and plot the results. For a fault, we also need to make use of the function set_is_fault.

geo_model.structural_frame.structural_groups[0].structural_relation = gp.data.StackRelationType.FAULT
gp.set_is_fault(
    frame=geo_model.structural_frame,
    fault_groups=['Discontinuity']
)
Structural Groups: StructuralGroup:
Name:Discontinuity
Structural Relation:StackRelationType.FAULT
Elements:
StructuralElement:
Name:Discont_Surface

StructuralGroup:
Name:Deposit. Series
Structural Relation:StackRelationType.ERODE
Elements:
StructuralElement:
Name:Limestone

StructuralElement:
Name:Siltstone

StructuralElement:
Name:Sandstone
Fault Relations:
Discontinu...Deposit. S...
Discontinuity
Deposit. Series
True
False


See that the fault relations field in the structural frame now indicates that the fault affects the default formation, i.e., offsets it. Let’s compute our model including the fault and see what that looks like.

Setting Backend To: AvailableBackends.numpy
Solutions: 4 Octree Levels, 4 DualContouringMeshes


p2d = gpv.plot_2d(geo_model, show=False)
p2d.axes[0].imshow(img, origin='upper', alpha=.8, extent=(0, 780, -582, 0))

# Enable grid with minor ticks
p2d.axes[0].grid(which='both')  # Enable both major and minor grids
p2d.axes[0].minorticks_on()  # Enable minor ticks

# Customize the appearance of the grid if needed
p2d.axes[0].grid(which='major', linestyle='--', linewidth='0.8', color='gray')
p2d.axes[0].grid(which='minor', linestyle=':', linewidth='0.4', color='gray')

plt.show()
Cell Number: mid Direction: y

3D visualization:

gpv.plot_3d(geo_model, show_surfaces=True, image=False, show_lith=False)
get started
<gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7fb605a38310>

In the 2D and 3D visualizations, we can now see how the insertion of a fault has created a viable alternative hypothesis that fits the original data in the cross-section. Instead of a larger syncline structure and upward-bending of the whole depositional series, we can now explain the shallower depth of the limestone in the third borehole by the effects of a reverse fault. In this model realization, all lithological units are oriented near-horizontal but are offset by the fault. Note that in GemPy, the degree of offset is defined by the location of the surface points on each side. If there is no data on one side of a fault, a very large offset will be assumed.

Note also that by implementing a fault, the scalar field of the depositional series has been affected by the offset.

p2d = gpv.plot_2d(
    model=geo_model,
    series_n=1,  # This will plot the scalar field used for the fault
    show_data=True,
    show_scalar=True,
    show_lith=False
)

plt.show()
Cell Number: mid Direction: y

Topography and Geological Maps

In GemPy, we can add more grid types for different purposes, such as to add topography to our model. In this following section, we will exemplify this by creating a random topography grid which allows us to intersect the surfaces as well as compute a high-resolution geological map. GemPy has a built-in function to generate random topography. After executing it, a topography grid will be added to the geo_model. It can be directly visualized in 2D and 3D.

GemPy offers built-in tools to manage topographic data through gdal. For demonstration, we’ll create a random topography:

gp.set_topography_from_random(
    grid=geo_model.grid,
    fractal_dimension=1.9,
    d_z=np.array([-150, 0]),
    topography_resolution=np.array([200, 200])
)
Active grids: GridTypes.NONE|TOPOGRAPHY|DENSE

<gempy.core.data.grid_modules.topography.Topography object at 0x7fb605a02a70>
gpv.plot_2d(geo_model, show_topography=True)
Cell Number: mid Direction: y
<gempy_viewer.modules.plot_2d.visualization_2d.Plot2D object at 0x7fb60588a1d0>
gpv.plot_3d(geo_model, show_surfaces=True, image=False, show_topography=True, show_lith=False)
get started
<gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7fb6041dc280>

If we now also re-compute our geological model, the generated topography grid will display the lithological units that intersect it, i.e., which outcrop at the surface. We can therefore display a geological map based on our topography and the underlying 3D geological model. To plot a top-down view of this map, you can pass the arguments section_names=[‘topography’] and show_topography=True in the plotting function as shown below.

Setting Backend To: AvailableBackends.numpy
Solutions: 4 Octree Levels, 4 DualContouringMeshes


gpv.plot_2d(geo_model, section_names=['topography'], show_topography=True)
Geological map
/home/leguark/gempy_viewer/gempy_viewer/API/_plot_2d_sections_api.py:105: UserWarning: Section contacts not implemented yet. We need to pass scalar field for the sections grid
  warnings.warn(

<gempy_viewer.modules.plot_2d.visualization_2d.Plot2D object at 0x7fb604073550>
gpv.plot_3d(geo_model, show_surfaces=True, image=False, show_topography=True)
get started
<gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7fb604072f20>

We can now see how the topography displays the color of the lithologies outcropping at the surface, together with topographical contour lines.

While this topography is random, GemPy also has the capability to include real topography files and arrays via the functions set_topography_from_file and set_topography_from_arrays.

Extracting Model Solutions

Once you have built a model, you might not only want to visualize it, but also further analyze it or export it for further utilization. For this, it is good to know that the solutions from modeling are stored in geo_model.solutions and can be returned from there. This includes the following outputs in particular: - geo_model.solutions.dc_meshes: A list of the surface meshes in the model with the location of vertices and edges for each. - geo_model.solutions.raw_arrays: An object containing numerous arrays that define various parts of the model. Of particular importance are the lithology block (lith_block), the fault block (fault_block), and the scalar field matrix (scalar_field_matrix).

Mesh Solutions

Let’s take a quick look at how we can return some key information from geo_model.solutions. Starting with meshes, we can see that the list dc_meshes can be indexed to return specific meshes and their respective vertices or edges. Please note that the order will be the same as in our structural_frame, i.e., the index [0] will return the first and top surface, in our case, the discontinuity surface.

vertices_0 = geo_model.solutions.dc_meshes[0].vertices
edges_0 = geo_model.solutions.dc_meshes[0].edges
print(type(vertices_0), vertices_0, edges_0)
<class 'trimesh.caching.TrackedArray'> [[ 0.45129359 -0.23915722 -0.63081408]
 [ 0.43619337 -0.23915722 -0.58985021]
 [ 0.45123358 -0.20726947 -0.63101987]
 ...
 [ 0.21781076  0.2072733  -0.04150489]
 [ 0.23731025  0.23916798 -0.07939452]
 [ 0.21703678  0.23916084 -0.04243479]] [[  3   1   2]
 [  8   6   3]
 [  9   7   8]
 ...
 [316 314 313]
 [318 323 314]
 [327 325 323]]

We can see that the vertices for this mesh were returned as a Numpy array with values for x, y, and z positions for each vertex. However, the values don’t correspond with our model extent. That is because they have been transformed in GemPy. To return the values corresponding to the original coordinate system, we can invert this transformation as follows:

geo_model.input_transform.apply_inverse(vertices_0)
array([[ 774.81417593, -187.49925971, -559.55823517],
       [ 762.97560303, -187.49926005, -527.44256826],
       [ 774.76712736, -162.49926701, -559.71957915],
       ...,
       [ 591.76363561,  162.50226762,  -97.53983597],
       [ 607.05123778,  187.5076957 , -127.24530088],
       [ 591.15683725,  187.50209584,  -98.26887806]])

Lithology Block

The lithology block is an array that, for a given model realization/solution, returns the ID of the lithology for each voxel. Note below that the lith_block first returns all values in the shape of one row. You might need to reshape it as shown below. For a regular grid, you can reshape it using the resolution used in geo_model.

lith_block = geo_model.solutions.raw_arrays.lith_block
print(lith_block.shape, lith_block)
(125000,) [5 5 5 ... 3 3 2]
lith_block = lith_block.reshape(50, 50, 50)
print(lith_block.shape, lith_block)
(50, 50, 50) [[[5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]
  ...
  [5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]]

 [[5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]
  ...
  [5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]]

 [[5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]
  ...
  [5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]
  [5 5 5 ... 2 2 2]]

 ...

 [[5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]
  ...
  [5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]]

 [[5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]
  ...
  [5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]]

 [[5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]
  ...
  [5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]
  [5 5 5 ... 3 3 2]]]

Grid Values

Apart from these solutions, you might also need to return grid values. You can access the values for each grid in your geo_model object via geo_model.grid as shown below. %%

geo_model.grid.regular_grid.values
array([[   7.8 , -196.  , -576.18],
       [   7.8 , -196.  , -564.54],
       [   7.8 , -196.  , -552.9 ],
       ...,
       [ 772.2 ,  196.  ,  -29.1 ],
       [ 772.2 ,  196.  ,  -17.46],
       [ 772.2 ,  196.  ,   -5.82]])
geo_model.grid.topography.values
array([[   0.        , -200.        ,  -41.51146691],
       [   0.        , -197.98994975,  -40.57677464],
       [   0.        , -195.9798995 ,  -40.49454267],
       ...,
       [ 780.        ,  195.9798995 ,  -41.88077326],
       [ 780.        ,  197.98994975,  -42.6337991 ],
       [ 780.        ,  200.        ,  -43.31644351]])

Total running time of the script: (0 minutes 31.970 seconds)

Gallery generated by Sphinx-Gallery