Skip to content

Commit

Permalink
Fix libecl -> resdata in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
berland committed Aug 26, 2024
1 parent 0b1f308 commit 89fd4b2
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions src/fmu/ensemble/ensemble.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions src/fmu/ensemble/realization.py
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
}
Expand Down

0 comments on commit 89fd4b2

Please sign in to comment.