Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix libecl -> resdata in documentation #255

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Fix libecl -> resdata in documentation #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/usage.rst
View file
Open in desktop
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`_.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's that extra underscore?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#links-to-external-web-pages

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Splendid


.. _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
View file
Open in desktop
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
View file
Open in desktop
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
Loading