Rogii Solo.Earth Model

EarthModel

attribute interpretation	Interpretation object associated with the EarthModel.
attribute uuid	Unique identifier of the EarthModel.
attribute name	Name of the EarthModel.
property sections	Get the Sections of the EarthModel.
method to_dict()	Convert the EarthModel instance to a dictionary.
method to_df()	Convert the EarthModelLayer instance to a Pandas DataFrame.

EarthModelSection

attribute earth_model	Reference to the EarthModel instance this EarthModelSection belongs to.
attribute measure_units	Measurement units used in the project.
attribute uuid	Unique identifier of the EarthModelSection.
attribute md	Measured depth at which this EarthModelSection is located.
attribute dip	Dip angle of the formation at this EarthModelSection.
attribute interpretation_segment	Segment of the interpretation associated with this EarthModelSection.
property layers	Retrieve the layers of the EarthModelSection.
method to_dict(get_converted)	Convert the EarthModelSection instance to a dictionary.
method to_df(get_converted)	Convert the EarthModelSection instance to a Pandas DataFrame.

EarthModelLayer

attribute earth_model_section	Reference to the EarthModelSection this EarthModelLayer belongs to.
attribute measure_units	Measurement units used in the project.
attribute uuid	Unique identifier of the EarthModelLayer.
attribute resistivity_vertical	Vertical resistivity of the EarthModelLayer.
attribute resistivity_horizontal	Horizontal resistivity of the EarthModelLayer.
attribute tvt	True vertical thickness of the EarthModelLayer.
attribute thickness	Calculated thickness of the EarthModelLayer.
attribute anisotropy	Anisotropy of the EarthModelLayer.
method to_dict(get_converted)	Convert the EarthModelLayer instance to a dictionary.
method to_df(get_converted)	Convert the EarthModelLayer instance to a Pandas DataFrame.

Module Contents

class EarthModel(papi_client: rogii_solo.papi.client.PapiClient, interpretation: rogii_solo.interpretation.Interpretation, **kwargs)

Bases: rogii_solo.base.ComplexObject

Represent an EarthModel, which is a collection of EarthModelSection and EarthModelLayer associated with an Interpretation.

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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Get the Interpretation associated with this Earth Model
interpretation = earth_model.interpretation
print(interpretation.name)

# Get the unique ID of the Earth Model
earth_model_uuid = earth_model.uuid
print(earth_model_uuid)

# Get the name of the Earth Model
earth_model_name = earth_model.name
print(earth_model_name)

interpretation

Interpretation object associated with the EarthModel.

uuid: str | None = None

Unique identifier of the EarthModel.

name: str | None = None

Name of the EarthModel.

property sections: rogii_solo.base.ObjectRepository[EarthModelSection]

Get the Sections of the EarthModel.

Returns:

ObjectRepository containing EarthModelSection 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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Get the Sections of the Earth Model
sections = earth_model.sections
print(sections.to_dict())

to_dict() → Dict

Convert the EarthModel instance to a dictionary.

Returns:

Dictionary representation of the EarthModel.

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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Convert the Earth Model to a dictionary
earth_model_dict = earth_model.to_dict()
print(earth_model_dict)

to_df() → pandas.DataFrame

Convert the EarthModelLayer instance to a Pandas DataFrame.

Returns:

DataFrame representation of the EarthModel.

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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Convert the Earth Model to a DataFrame
earth_model_df = earth_model.to_df()
print(earth_model_df)

class EarthModelSection(earth_model: EarthModel, **kwargs)

Bases: rogii_solo.base.BaseObject

Represent a section of an EarthModel, containing EarthModelLayer and metadata.

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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Get the first Section of the Earth Model
section = earth_model.sections[0]
print(section.to_dict())

# Get the unique ID of the Section
section_uuid = section.uuid
print(section_uuid)

# Get the measure units of the project
measure_units = section.measure_units
print(measure_units)

# Get the measured depth of the Section
section_md = section.md
print(section_md)

# Get the dip angle of the Section
section_dip = section.dip
print(section_dip)

# Get the interpretation segment associated with the Section
interpretation_segment = section.interpretation_segment
print(interpretation_segment)

earth_model

Reference to the EarthModel instance this EarthModelSection belongs to.

measure_units

Measurement units used in the project.

uuid: str | None = None

Unique identifier of the EarthModelSection.

md: float | None = None

Measured depth at which this EarthModelSection is located.

dip: float | None = None

Dip angle of the formation at this EarthModelSection.

interpretation_segment: rogii_solo.calculations.types.Segment | None = None

Segment of the interpretation associated with this EarthModelSection.

property layers: rogii_solo.base.ObjectRepository[EarthModelLayer]

Retrieve the layers of the EarthModelSection.

Returns:

ObjectRepository containing EarthModelLayer 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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Get the first Section of the Earth Model
section = earth_model.sections[0]

# Get the Layers of the Section
layers = section.layers
print(layers.to_dict())

to_dict(get_converted: bool = True) → Dict

Convert the EarthModelSection instance to a dictionary.

Parameters:

get_converted – (Optional) Whether to convert measure units. Default is True.

Returns:

Dictionary representation of the EarthModelSection.

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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Get the first Section of the Earth Model
section = earth_model.sections[0]

# Convert the Section to a dictionary
section_dict = section.to_dict()
print(section_dict)

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

Convert the EarthModelSection instance to a Pandas DataFrame.

Parameters:

get_converted – (Optional) Whether to convert measure units. Default is True.

Returns:

DataFrame representation of the EarthModelSection.

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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Get the first Section of the Earth Model
section = earth_model.sections[0]

# Convert the Section to a DataFrame
section_df = section.to_df()
print(section_df)

class EarthModelLayer(earth_model_section: EarthModelSection, **kwargs)

Bases: rogii_solo.base.BaseObject

Represent a EarthModelLayer within an EarthModelSection, containing physical properties.

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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Get the first Section of the Earth Model
section = earth_model.sections[0]

# Get the first Earth Model Layer of the Section
layer = section.layers[0]

# Get the measure units of the project
measure_units = layer.measure_units
print(measure_units)

# Get the unique ID of the Earth Model Layer
layer_uuid = layer.uuid
print(layer_uuid)

# Get the vertical resistivity of the Earth Model Layer
layer_resistivity_vertical = layer.resistivity_vertical
print(layer_resistivity_vertical)

# Get the horizontal resistivity of the Earth Model Layer
layer_resistivity_horizontal = layer.resistivity_horizontal
print(layer_resistivity_horizontal)

# Get the true vertical thickness of the Earth Model Layer
layer_tvt = layer.tvt
print(layer_tvt)

# Get the calculated thickness of the Earth Model Layer
layer_thickness = layer.thickness
print(layer_thickness)

# Get the anisotropy of the Earth Model Layer
layer_anisotropy = layer.anisotropy
print(layer_anisotropy)

earth_model_section: EarthModelSection

Reference to the EarthModelSection this EarthModelLayer belongs to.

measure_units: rogii_solo.calculations.enums.EMeasureUnits

Measurement units used in the project.

uuid: str | None = None

Unique identifier of the EarthModelLayer.

resistivity_vertical: float | None = None

Vertical resistivity of the EarthModelLayer.

resistivity_horizontal: float | None = None

Horizontal resistivity of the EarthModelLayer.

tvt: float | None = None

True vertical thickness of the EarthModelLayer.

thickness: float

Calculated thickness of the EarthModelLayer.

anisotropy: float | None = None

Anisotropy of the EarthModelLayer.

to_dict(get_converted: bool = True) → Dict

Convert the EarthModelLayer instance to a dictionary.

Parameters:

get_converted – (Optional) Whether to convert measure units. Default is True.

Returns:

Dictionary representation of the EarthModelLayer.

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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Get the first Section of the Earth Model
section = earth_model.sections[0]

# Get the first Earth Model Layer of the Section
layer = section.layers[0]

# Convert the Earth Model Layer to a dictionary
layer_dict = layer.to_dict()
print(layer_dict)

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

Convert the EarthModelLayer instance to a Pandas DataFrame.

Parameters:

get_converted – (Optional) Whether to convert measure units. Default is True.

Returns:

DataFrame representation of the EarthModelLayer.

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')
earth_model = interpretation.earth_models.find_by_name('EarthModel1')

# Get the first Section of the Earth Model
section = earth_model.sections[0]

# Get the first Earth Model Layer of the Section
layer = section.layers[0]

# Convert the Earth Model Layer to a DataFrame
layer_df = layer.to_df()
print(layer_df)