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 load_regridder docstring #404

Merged
merged 2 commits into from
Oct 3, 2024
Merged

Fix load_regridder docstring #404

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
229bdfd
fix regridder loading docstring
stephenworsley Sep 6, 2024
9a9b4ab
fix regridder loading docstring
stephenworsley Sep 6, 2024
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
12 changes: 7 additions & 5 deletions esmf_regrid/experimental/io.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,10 +274,12 @@ def load_regridder(filename):
"""
Load a regridder scheme instance.

Loads either a
:class:`~esmf_regrid.experimental.unstructured_scheme.GridToMeshESMFRegridder`
or a
:class:`~esmf_regrid.experimental.unstructured_scheme.MeshToGridESMFRegridder`.
Loads any of the regridder classes, i.e.
:class:`~esmf_regrid.experimental.unstructured_scheme.GridToMeshESMFRegridder`,
:class:`~esmf_regrid.experimental.unstructured_scheme.MeshToGridESMFRegridder`,
:class:`~esmf_regrid.schemes.ESMFAreaWeightedRegridder`,
:class:`~esmf_regrid.schemes.ESMFBilinearRegridder` or
:class:`~esmf_regrid.schemes.ESMFNearestRegridder`.

Parameters
----------
Expand All @@ -286,7 +288,7 @@ def load_regridder(filename):

Returns
-------
:class:`~esmf_regrid.experimental.unstructured_scheme.GridToMeshESMFRegridder` or :class:`~esmf_regrid.experimental.unstructured_scheme.MeshToGridESMFRegridder`
:class:`~esmf_regrid.schemes._ESMFRegridder`
"""
with _load_context():
cubes = iris.load(filename)
Expand Down