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

Jump to bottom

Clarification on the show_time parameter #1215

Merged
merged 2 commits into from Aug 15, 2022
Merged

Clarification on the show_time parameter #1215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3eae27f
Changing docstrings
VeckoTheGecko Aug 11, 2022
232fc2a
Changing docstrings
VeckoTheGecko Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion parcels/field.py
View file
Open in desktop
Expand Up @@ -1244,7 +1244,7 @@ def show(self, animation=False, show_time=None, domain=None, depth_level=0, proj
"""Method to 'show' a Parcels Field

:param animation: Boolean whether result is a single plot, or an animation
:param show_time: Time at which to show the Field (only in single-plot mode)
:param show_time: Time in seconds from start after which to show the Field (only in single-plot mode)
:param domain: dictionary (with keys 'N', 'S', 'E', 'W') defining domain to show
:param depth_level: depth level to be plotted (default 0)
:param projection: type of cartopy projection to use (default PlateCarree)
Expand Down
4 changes: 2 additions & 2 deletions parcels/plotting.py
View file
Open in desktop
Expand Up @@ -17,7 +17,7 @@ def plotparticles(particles, with_particles=True, show_time=None, field=None, do
animation=False, **kwargs):
"""Function to plot a Parcels ParticleSet

:param show_time: Time at which to show the ParticleSet
:param show_time: Time in seconds from start after which to show the ParticleSet
:param with_particles: Boolean whether particles are also plotted on Field
:param field: Field to plot under particles (either None, a Field object, or 'vector')
:param domain: dictionary (with keys 'N', 'S', 'E', 'W') defining domain to show
Expand Down Expand Up @@ -104,7 +104,7 @@ def plotfield(field, show_time=None, domain=None, depth_level=0, projection='Pla
vmin=None, vmax=None, savefile=None, **kwargs):
"""Function to plot a Parcels Field

:param show_time: Time at which to show the Field
:param show_time: Time in seconds from start after which to show the Field
:param domain: dictionary (with keys 'N', 'S', 'E', 'W') defining domain to show
:param depth_level: depth level to be plotted (default 0)
:param projection: type of cartopy projection to use (default PlateCarree)
Expand Down