Welcome to petromodder’s documentation!¶
Utilities for reading and manupulating Schlumberger’s PetroMod data
PetroMod is a registered trademark of Schlumberger
- class petromodder.Project(project_path)¶
PetroMod project object
- property models_1D¶
list of all 1D model
- Returns:
key = model name, value: Pathlib path to the model
- Return type:
dict
- property models_2D¶
list of all 2D model
- Returns:
key = model name, value: Pathlib path to the model
- Return type:
dict
- property models_3D¶
list of all 3D model
- Returns:
key = model name, value: Pathlib path to the model
- Return type:
dict
- property project_data¶
Project data :returns: Project data :rtype: Project data class
- property project_path¶
Path to project
- Returns:
Pathlib path to the project
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property version¶
Major version of the project
- Returns:
Major version of the project
- Return type:
str
- class petromodder.Project_data(project_data_path)¶
- property cultural_data¶
Cultural data of the project
- Returns:
Cultural data of the project
- Return type:
Cultural_data class
- property lithology¶
Lithology database of the project
- Returns:
Project’s lithology data
- Return type:
dict
- class petromodder.Model3D(model_path)¶
- add_heatflow_maps(map_dict, folder_name=None)¶
Add new heat flow maps to the model. Stored under directory structure if folder_name is defined
- Parameters:
map_dict (key = Age of the map in Ma, value = xtgeo RegularSurface) – dict
folder_name (str, optional) – Name of the new directory, by default None
- Returns:
Age and file name of the maps for writing active heat flow model
- Return type:
dict
- add_paleo_water_depth_maps(map_dict, folder_name=None)¶
Add new paleo water depth maps to the model. Stored under directory structure if folder_name is defined
- Parameters:
map_dict (dict) – key = Age of the map in Ma, value = xtgeo RegularSurface
folder_name (str, optional) – [description], key = Age of the map in Ma, value = xtgeo RegularSurface
- Returns:
Age and file name of the maps for writing active paleo water depth model
- Return type:
dict
- get_facies_table()¶
Facies definition table. Facies map code VS facies lithology code
- Returns:
Facies definition table
- Return type:
Pandas DataFrame
- Raises:
Exception – No facies table in the model
- get_heatflow_age()¶
Ages of heat flow maps that are currently active in the model
- Returns:
Ages of active heat flow maps
- Return type:
1D numpy array
- Raises:
Exception – No active heat flow model defined in the model
- get_heatflow_maps_index()¶
Index for heat flow maps
- Returns:
Heat flow map index
- Return type:
Pandas DataFrame
- Raises:
Exception – No heatflow map in the model
- get_pwd_age()¶
Ages of paleo water depth maps that are currently active in the model
- Returns:
Ages of active paleo water depth maps
- Return type:
1D numpy array
- Raises:
Exception – No active paleo water depth model defined in the model
- get_pwd_maps_index()¶
Index for paleo water depth maps
- Returns:
paleo water depth map index
- Return type:
Pandas DataFrame
- Raises:
Exception – No paleo water depth map in the model
- update_heatflow_model(map_dict)¶
Set active heat flow maps model
- Parameters:
map_dict (dict) – from add_heatflow_maps()
- update_paleo_water_depth_model(map_dict)¶
Set active paleo water depth model
- Parameters:
map_dict (dict) – from Model3D.add_paleo_water_depth_maps()
- property active_heatflow_model¶
Directory location of active heat flow model index
- Returns:
Path to active heat flow model index
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property active_pwd_model¶
Directory location of active paleo water depth model index
- Returns:
Path to active paleo water depth model index
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property depth_maps¶
Directory location of depth maps
- Returns:
Path to depth maps
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property depth_maps_index¶
Directory location of depth maps
- Returns:
Path to depth maps storage location
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property facies_maps¶
Directory location of facies maps
- Returns:
Path to facies maps
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property facies_maps_index¶
Directory location of facies maps
- Returns:
Path to facies maps storage location
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property facies_table¶
Facies map file
- Returns:
Facies map file
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property geometry¶
Geometry of the model inclusing depth maps, facies maps and ages
- Returns:
Geometry table
- Return type:
Pandas DataFrame
- property grid_size¶
Grid cell size of al lthe maps in the map. All maps have to be of the same grid size in a model
- Returns:
X and Y grid cell distance. Key = ‘xinc’ and ‘yinc’
- Return type:
dict
- property heatflow_maps¶
Directory location of heat flow maps
- Returns:
Path to heat flow maps storage location
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property heatflow_maps_index¶
cont.pmt index file location for heat flow maps
- Returns:
Location of heat flow index file
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property minor_version¶
Major.minor version of the model
- Returns:
Major.minor version of the model
- Return type:
str
- property model_path¶
Pathlib path to the model
- property project_data¶
Project data :returns: Project data :rtype: Project data class
- property pwd_maps¶
Directory location of paleo water depth maps
- Returns:
Path to Paleo water depth maps
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property pwd_maps_index¶
cont.pmt index file location for paleo water depth maps
- Returns:
Location of paleo water depth index file
- Return type:
Pathlib.PoxisPath/Pathlib.WindowsPath
- property version¶
Major version of the project
- Returns:
Major version of the project
- Return type:
str
- petromodder.get_model(model_path)¶
Create a model object from a path location. Currently only 3D model is supported
- Parameters:
model_path (str) – path to the model
- Returns:
Model 1D/2D/3D
- Return type:
Model object