Test correct keys in dimensions dictionary #545
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also adding unit test
Instead using new `filebuffername` variable
parcels/field.py
Outdated
| @@ -55,7 +55,8 @@ class Field(object): | |||
| def __init__(self, name, data, lon=None, lat=None, depth=None, time=None, grid=None, mesh='flat', | |||
| fieldtype=None, transpose=False, vmin=None, vmax=None, time_origin=None, | |||
| interp_method='linear', allow_time_extrapolation=None, time_periodic=False, **kwargs): | |||
| self.name = name | |||
| self.name = list(name)[0] if isinstance(name, dict) else name | |||
| self.filebuffername = name[list(name)[0]] if isinstance(name, dict) else name | |||
There was a problem hiding this comment.
It's quite hard to follow. Why is name a dict?
If you make name a tuple, you can do
if not isinstance(name, tuple):
self.name = name
self.filebuffername = name
else:
self.name, self.filebuffername = name
or as you did
self.name = name[0] if isinstance(name, tuple) else name
self.filebuffername = name[1] if isinstance(name, tuple) else name
parcels/field.py
Outdated
| @@ -133,7 +134,7 @@ def from_netcdf(cls, filenames, variable, dimensions, indices=None, grid=None, | |||
| filenames can be a list [files] | |||
| or a dictionary {dim:[files]} (if lon, lat, depth and/or data not stored in same files as data) | |||
| time values are in filenames[data] | |||
| :param variable: Name of the field to create. Note that this has to be a string | |||
| :param variable: Dictionary mapping name of the field to create to variable in file. | |||
There was a problem hiding this comment.
So here I would put a tuple. You will never have more than one key, right?
parcels/fieldset.py
Outdated
| @@ -34,6 +34,12 @@ def __init__(self, U, V, fields=None): | |||
|
|
|||
| self.compute_on_defer = None | |||
|
|
|||
| @classmethod | |||
There was a problem hiding this comment.
This should be a static method
delandmeterp
approved these changes
Feb 25, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR tests that the
dimensionsdictionary has no other keys thanlon,lat,depthandtime. Since other keys are not used, this prevents errors where users use the wrong key for e.g.depthand inadvertently use in 2D modeFurthermore, this PR also cleans up the code by removing the
dimensions['data']entry for the name of the variable in the filebuffer