ResSimpy.Nexus.DataModels.NexusRockMethod.NexusRockMethod

class ResSimpy.Nexus.DataModels.NexusRockMethod.NexusRockMethod(file: NexusFile, input_number: int, properties: dict[str, Union[str, int, float, enum.Enum, list[str], pandas.DataFrame, dict[str, Union[float, pandas.DataFrame]]]] | None = None)

Bases: DynamicProperty

Class to hold Nexus Rock properties.

file

Nexus rock properties file object

Type:

NexusFile

input_number

Rock properties method number in Nexus fcs file

Type:

int

properties (dict[str, Union[str, int, float, Enum, list[str], pd.DataFrame,

dict[str, Union[float, pd.DataFrame]]]]):

Dictionary holding all properties for a specific rock properties method. Defaults to empty dictionary.

Public Data Attributes:

file
properties

Inherited from DynamicProperty

input_number
file

Methods:

__init__(file, input_number[, properties])
to_string()	Create string with rock properties data, in Nexus file format.
read_properties()	Read Nexus rock properties file contents and populate NexusRockMethod object.
__eq__(other)	Return self==value.

Inherited from DynamicProperty

__init__(input_number, file)
__repr__()	Pretty printing dynamic property data.
to_string()	Write dynamic property data to string.
write_to_file([overwrite_existing, ...])	Write dynamic property data to file.
__eq__(other)	Return self==value.

---

__init__(file: NexusFile, input_number: int, properties: dict[str, Union[str, int, float, enum.Enum, list[str], pandas.DataFrame, dict[str, Union[float, pandas.DataFrame]]]] | None = None) → None

to_string() → str

Create string with rock properties data, in Nexus file format.

write_to_file(overwrite_existing: bool = False, new_file_location: str | None = None) → None

Write dynamic property data to file.

read_properties() → None

Read Nexus rock properties file contents and populate NexusRockMethod object.