Rogii Solo.Horizon¶

`Horizon`¶
attribute interpretation	Represent the `Interpretation` of the `Horizon`
attribute uuid	Unique identifier of the `Horizon`.
attribute name	Name of the `Horizon`.
property points	Get the points (MD/TVD pairs) associated with this `Horizon`.
method to_dict()	Convert the `Horizon` instance to a dictionary.
method to_df()	Convert the `Horizon` instance to a Pandas DataFrame.

`HorizonPoint`¶
attribute measure_units	The measurement units used for this `HorizonPoint`
attribute md	The measured depth (MD) of the `HorizonPoint`
attribute tvd	The true vertical depth (TVD) of the `HorizonPoint`
method to_dict(get_converted)	Convert the `HorizonPoint` instance to a dictionary, optionally
method to_df(get_converted)	Convert the `HorizonPoint` instance to a Pandas DataFrame,

Module Contents¶

class Horizon(interpretation: rogii_solo.interpretation.Interpretation, **kwargs)¶

Bases: rogii_solo.base.BaseObject

Represent a Horizon within an Interpretation, providing access to Horizon specific data such as points (MD/TVD pairs). A Horizon is an interface or boundary marker used to correlate and track formations or lithologic units across the well.

Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')
horizon = interpretation.horizons.find_by_name('Horizon1')

# Get the Interpretation associated with this Horizon
interpretation = horizon.interpretation
print(interpretation.name)

# Get the unique ID of the Horizon
horizon_uuid = horizon.uuid
print(horizon_uuid)

# Get the name of the Horizon
horizon_name = horizon.name
print(horizon_name)

interpretation¶: Represent the Interpretation of the Horizon

uuid: str | None = None¶: Unique identifier of the Horizon.

name: str | None = None¶: Name of the Horizon.

property points: rogii_solo.base.ObjectRepository¶

Get the points (MD/TVD pairs) associated with this Horizon.

Returns:: ObjectRepository containing HorizonPoint instances.
Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')
horizon = interpretation.horizons.find_by_name('Horizon1')

# Get the Horizon points
horizon_points = horizon.points
print(horizon_points.to_dict())

to_dict() → Dict¶

Convert the Horizon instance to a dictionary.

Returns:: Dictionary representation of the Horizon.
Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')
horizon = interpretation.horizons.find_by_name('Horizon1')

# Get the Horizon data as a dictionary
horizon_data = horizon.to_dict()
print(horizon_data)

to_df() → pandas.DataFrame¶

Convert the Horizon instance to a Pandas DataFrame.

Returns:: DataFrame representation of the Horizon.
Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')
horizon = interpretation.horizons.find_by_name('Horizon1')

# Get the Horizon data as a Pandas DataFrame
horizon_df = horizon.to_df()
print(horizon_df)

class HorizonPoint(measure_units: rogii_solo.calculations.enums.EMeasureUnits, md: float, tvd: float)¶

Bases: rogii_solo.base.BaseObject

Represent an individual point on a Horizon, storing the measured depth (MD) and true vertical depth (TVD). These points are used to define a horizon’s path along the Well.

Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')
horizon = interpretation.horizons.find_by_name('Horizon1')

# Get the first Horizon point
horizon_point = horizon.points[0]
print(horizon_point.to_dict())

# Get measured depth (MD)
point_md = horizon_point.md
print(point_md)

# Get true vertical depth (TVD)
point_tvd = horizon_point.tvd
print(point_tvd)

measure_units¶: The measurement units used for this HorizonPoint

md: float¶: The measured depth (MD) of the HorizonPoint

tvd: float¶: The true vertical depth (TVD) of the HorizonPoint

to_dict(get_converted: bool = True) → Dict¶

Convert the HorizonPoint instance to a dictionary, optionally converting MD and TVD values to the project’s measurement units.

Parameters:: get_converted – (Optional) Whether to convert the depth values using convert_z(). Default is True.
Returns:: Dictionary representation of the HorizonPoint.
Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')
horizon = interpretation.horizons.find_by_name('Horizon1')

# Get the first Horizon point
horizon_point = horizon.points[0]
print(horizon_point.to_dict())

to_df(get_converted: bool = True) → pandas.DataFrame¶

Convert the HorizonPoint instance to a Pandas DataFrame, optionally converting MD and TVD values to the project’s measurement units.

Parameters:: get_converted – (Optional) Whether to convert the depth values using convert_z(). Default is True.
Returns:: DataFrame representation of the HorizonPoint.
Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
interpretation = well.interpretations.find_by_name('Interpretation1')
horizon = interpretation.horizons.find_by_name('Horizon1')

# Get the first Horizon point
horizon_point = horizon.points[0]
print(horizon_point.to_df())