From bc8e38f76e32c8a369c2456d56d88e0e9dbf5099 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5vard=20Berland?= Date: Mon, 26 Aug 2024 13:53:22 +0200 Subject: [PATCH] Fix libecl -> resdata in documentation --- docs/usage.rst | 4 ++-- src/fmu/ensemble/ensemble.py | 6 +++--- src/fmu/ensemble/realization.py | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index 3ffd9b5a..5b87dfae 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -144,9 +144,9 @@ Reading Eclipse data The ensemble class has specific support for parsing binary files produced by reservoir simulator outputting the Eclipse binary format. This support -is through `libecl_`. +is through `resdata`_. -.. _libecl: https://github.com/equinor/libecl +.. _resdata: https://github.com/equinor/resdata .. code-block:: python diff --git a/src/fmu/ensemble/ensemble.py b/src/fmu/ensemble/ensemble.py index 3cfacbd9..5928f36c 100644 --- a/src/fmu/ensemble/ensemble.py +++ b/src/fmu/ensemble/ensemble.py @@ -754,7 +754,7 @@ def load_smry( Dates past this date will be dropped, supplied end_date will always be included. Overridden if time_index is 'first' or 'last'. If string, use ISO-format, YYYY-MM-DD. - include_restart (boolean): boolean sent to libecl for whether restart + include_restart (boolean): boolean sent to resdata for whether restart files should be traversed. Returns: pd.DataFame: Summary vectors for the ensemble, or @@ -1021,7 +1021,7 @@ def get_smry_dates( end_date will always be included. Overrides normalized dates. Overridden if freq is 'first' or 'last'. If string, use ISO-format, YYYY-MM-DD. - include_restart: boolean sent to libecl for whether restart + include_restart: boolean sent to resdata for whether restart files should be traversed. Returns: @@ -1418,7 +1418,7 @@ def get_smry( Dates past this date will be dropped, supplied end_date will always be included. Overridden if time_index is 'first' or 'last'. - include_restart: boolean sent to libecl for whether restart + include_restart: boolean sent to resdata for whether restart files should be traversed. Returns: diff --git a/src/fmu/ensemble/realization.py b/src/fmu/ensemble/realization.py index 2628e343..71e0ccfb 100644 --- a/src/fmu/ensemble/realization.py +++ b/src/fmu/ensemble/realization.py @@ -938,7 +938,7 @@ def get_resdatafiles(self): def get_eclsum(self, cache=True, include_restart=True): """ Fetch the Eclipse Summary file from the realization - and return as a libecl EclSum object + and return as a ResdataFile object Unless the UNSMRY file has been discovered, it will pick the file from the glob `eclipse/model/*UNSMRY`, @@ -952,7 +952,7 @@ def get_eclsum(self, cache=True, include_restart=True): cache: boolean indicating whether we should keep an object reference to the EclSum object. Set to false if you need to conserve memory. - include_restart: boolean sent to libecl for whether restart + include_restart: boolean sent to resdata for whether restart files should be traversed. Returns: @@ -1045,7 +1045,7 @@ def load_smry( Dates past this date will be dropped, supplied end_date will always be included. Overridden if time_index is 'first' or 'last'. - include_restart: boolean sent to libecl for whether restart + include_restart: boolean sent to resdata for whether restart files should be traversed. Returns: @@ -1291,7 +1291,7 @@ def get_smryvalues(self, props_wildcard=None): prop: self._eclsum.numpy_vector(prop, report_only=False) for prop in props } - else: # get_values() is deprecated in newer libecl + else: # get_values() is deprecated in resdata data = { prop: self._eclsum.get_values(prop, report_only=False) for prop in props }