create_curved_borehole API Reference

geoloop.geoloopcore.pygfield_ana.create_curved_borehole

create_curved_borehole(
    H: float,
    D: float,
    x: float,
    y: float,
    initial_tilt: float,
    final_tilt: float,
    orientation: float,
    num_segments: int = 10,
)

Create a borehole with varying inclination by approximating it with straight segments.

Parameters:

Name	Type	Description	Default
H	float	Borehole length (m).	required
D	float	Borehole burial depth (m)	required
x	float	x-coordinate of the borehole.	required
y	float	y-coordinate of the borehole.	required
initial_tilt	float	Initial borehole inclination (radians).	required
final_tilt	float	Final borehole inclination (radians).	required
orientation	float	Borehole orientation angle (radians).	required
num_segments	int	Number of segments to approximate the varying inclination. The default is 10.	10

Returns:

Name	Type	Description
segments	list	List of segment coordinates representing the borehole. (x_start, y_start, z_start, x_end, y_end, z_end, tilt, orientation)