map2loop.project.Map2ModelWrapper

class map2loop.project.Map2ModelWrapper(map_data, verbose_level: VerboseLevel = VerboseLevel.NONE)

Bases: object

A wrapper around map2model functionality

sorted_units

map2model’s estimate of the stratigraphic column

Type:

None or list

fault_fault_relationships

data frame of fault to fault relationships with columns [“Fault1”, “Fault2”, “Type”, “Angle”]

Type:

None or pandas.DataFrame

unit_fault_relationships

data frame of unit fault relationships with columns [“Unit”, “Fault”]

Type:

None or pandas.DataFrame

unit_unit_relationships

data frame of unit unit relationships with columns [“Index1”, “UnitName1”, “Index2”, “UnitName2”]

Type:

None or pandas.DataFrame

map_data

A pointer to the map data structure in project

Type:

MapData

verbose_level

A selection that defines how much console logging is output

Type:

m2l_enum.VerboseLevel

The initialiser for the map2model wrapper

Parameters:

• map_data (MapData) – The project map data structure to reference

• verbose_level (VerboseLevel, optional) – How much console output is sent. Defaults to VerboseLevel.ALL.

__init__(map_data, verbose_level: VerboseLevel = VerboseLevel.NONE)

The initialiser for the map2model wrapper

Parameters:

• map_data (MapData) – The project map data structure to reference

• verbose_level (VerboseLevel, optional) – How much console output is sent. Defaults to VerboseLevel.ALL.

Methods

__init__(map_data[, verbose_level])	The initialiser for the map2model wrapper
get_fault_fault_relationships()	Getter for the fault fault relationships
get_sorted_units()	Getter for the map2model sorted units
get_unit_fault_relationships()	Getter for the unit fault relationships
get_unit_unit_relationships()	Getter for the unit unit relationships
reset()	Reset the wrapper to before the map2model process
run([verbose_level])	The main execute function that prepares, runs and parse the output of the map2model process

get_fault_fault_relationships()

Getter for the fault fault relationships

Returns:

pandas.DataFrame – The fault fault relationships

get_sorted_units()

Getter for the map2model sorted units

Returns:

list – The map2model stratigraphic column estimate

get_unit_fault_relationships()

Getter for the unit fault relationships

Returns:

pandas.DataFrame – The unit fault relationships

get_unit_unit_relationships()

Getter for the unit unit relationships

Returns:

pandas.DataFrame – The unit unit relationships

reset()

Reset the wrapper to before the map2model process

run(verbose_level: VerboseLevel = None)

The main execute function that prepares, runs and parse the output of the map2model process

Parameters:

verbose_level (VerboseLevel, optional) – How much console output is sent. Defaults to None (which uses the wrapper attribute).