Welcome to GeoRead’s documentation!

GeoRead is a python-based framework for reading reservoir model data.

API

Text files

load(path: Path, *, logger: Logger | None = None, encoding: str | None = None, directory_extension: dict[str, KeywordSpecification | None] | None = None) → dict[str, list[tuple[str, Sequence[DataFrame] | Sequence[tuple[DataFrame, DataFrame]] | tuple[str, DataFrame] | DataFrame | str | ndarray[tuple[Any, ...], dtype[int8]] | ndarray[tuple[Any, ...], dtype[int16]] | ndarray[tuple[Any, ...], dtype[int32]] | ndarray[tuple[Any, ...], dtype[int64]] | ndarray[tuple[Any, ...], dtype[float16]] | ndarray[tuple[Any, ...], dtype[float32]] | ndarray[tuple[Any, ...], dtype[float64]] | ndarray[tuple[Any, ...], dtype[bool]] | None | dict[str, str | None] | ArrayWithUnits | Sequence[str] | Sequence[Timestamp] | Timestamp | list[DataFrame | tuple[DataFrame, DataFrame] | ndarray[tuple[Any, ...], dtype[int8]] | ndarray[tuple[Any, ...], dtype[int16]] | ndarray[tuple[Any, ...], dtype[int32]] | ndarray[tuple[Any, ...], dtype[int64]] | ndarray[tuple[Any, ...], dtype[float16]] | ndarray[tuple[Any, ...], dtype[float32]] | ndarray[tuple[Any, ...], dtype[float64]] | ndarray[tuple[Any, ...], dtype[bool]]] | dict[str, DataFrame]]]][source]

Load model data.

Parameters:

  • path (pathlib.Path) – Path to main model file.

  • logger (logging.Logger | None, default None) – Logger.

  • encoding (str | None, default None) – Encoding.

  • directory_extension (dict[str, KeywordSpecification | None] | None) – Specifications for new keywords or altered specificatios for current keywords.

Returns:

Model data.

Return type:

DataType

dump(data: dict[str, list[tuple[str, Sequence[DataFrame] | Sequence[tuple[DataFrame, DataFrame]] | tuple[str, DataFrame] | DataFrame | str | ndarray[tuple[Any, ...], dtype[int8]] | ndarray[tuple[Any, ...], dtype[int16]] | ndarray[tuple[Any, ...], dtype[int32]] | ndarray[tuple[Any, ...], dtype[int64]] | ndarray[tuple[Any, ...], dtype[float16]] | ndarray[tuple[Any, ...], dtype[float32]] | ndarray[tuple[Any, ...], dtype[float64]] | ndarray[tuple[Any, ...], dtype[bool]] | None | dict[str, str | None] | ArrayWithUnits | Sequence[str] | Sequence[Timestamp] | Timestamp | list[DataFrame | tuple[DataFrame, DataFrame] | ndarray[tuple[Any, ...], dtype[int8]] | ndarray[tuple[Any, ...], dtype[int16]] | ndarray[tuple[Any, ...], dtype[int32]] | ndarray[tuple[Any, ...], dtype[int64]] | ndarray[tuple[Any, ...], dtype[float16]] | ndarray[tuple[Any, ...], dtype[float32]] | ndarray[tuple[Any, ...], dtype[float64]] | ndarray[tuple[Any, ...], dtype[bool]]] | dict[str, DataFrame]]]], path: Path, inplace_schedule: bool = False, filename: str | None = None) → None[source]

Dump model data.

Parameters:

  • data (DataType) – Model data.

  • path (pathlib.Path) – Path to dump the model.

  • inplace_schedule (bool, default False.) – Should schedule be dumped inplace.

  • filename (str | None, default None.) – Name of the main model file, if None filename is taken from TITLE field in the RUNSPEC.

Binary files

load(model_path: Path) → BinaryData | None[source]

Load binary data.

Parameters:

model_path (pathlib.Path) – Path to the model .data file.

Returns:

Loaded data.

Return type:

BinaryData | None