def test_grid_wind_curv():
# curvlinear grid
curv = Grid(wind_file, topology_file, grid_type=2)
time = date_to_sec(datetime(2006, 3, 31, 21))
vel = curv.get_value(time, (-122.934656, 38.27594))
print "Curv grid - vel: {0}\n".format(vel)
assert vel.item() != 0
def test_grid_wind_curv():
# curvlinear grid
curv = Grid(wind_file, topology_file, grid_type=2)
time = date_to_sec(datetime(2006, 3, 31, 21))
vel = curv.get_value(time, (-122.934656, 38.27594))
print "Curv grid - vel: {0}\n".format(vel)
assert vel.item() != 0
def __init__(self,
wind_file=None,
topology_file=None,
grid_type=1,
drift_angle=0,
extrapolation_is_allowed=False,
time_offset=0,
**kwargs):
"""
:param wind_file: file containing wind data on a grid
:param topology_file: Default is None. When exporting topology, it
is stored in this file
:param wind_scale: Value to scale wind data
:param extrapolate: Allow current data to be extrapolated before and
after file data
:param time_offset: Time zone shift if data is in GMT
Pass optional arguments to base class
uses super: super(ShipDriftMover,self).__init__(\*\*kwargs)
"""
if not os.path.exists(wind_file):
raise ValueError(
'Path for wind file does not exist: {0}'.format(wind_file))
if topology_file is not None:
if not os.path.exists(topology_file):
raise ValueError(
'Path for Topology file does not exist: {0}'.format(
topology_file))
# is wind_file and topology_file is stored with cy_gridwind_mover?
self.wind_file = wind_file
self.topology_file = topology_file
self.name = os.path.split(wind_file)[1]
self.drift_angle = drift_angle
self._wind_scale = kwargs.pop('wind_scale', 1)
self.grid_type = grid_type
self.grid = Grid(wind_file, topology_file, grid_type)
self.mover = Mover()
super(ShipDriftMover, self).__init__(**kwargs)
# have to override any uncertainty
# self.grid.load_data(wind_file, topology_file)
self.model_time = 0
self.positions = np.zeros((0, 3), dtype=world_point_type)
self.delta = np.zeros((0, 3), dtype=world_point_type)
self.status_codes = np.zeros((0, 1), dtype=status_code_type)
self.array_types.update(
{'windages', 'windage_range', 'windage_persist'})
def __init__(self,
wind_file=None,
topology_file=None,
grid_type=1,
drift_angle=0,
extrapolation_is_allowed=False,
time_offset=0,
**kwargs):
"""
:param wind_file: file containing wind data on a grid
:param topology_file: Default is None. When exporting topology, it
is stored in this file
:param wind_scale: Value to scale wind data
:param extrapolate: Allow current data to be extrapolated before and
after file data
:param time_offset: Time zone shift if data is in GMT
Pass optional arguments to base class
uses super: super(ShipDriftMover,self).__init__(\*\*kwargs)
"""
if not os.path.exists(wind_file):
raise ValueError('Path for wind file does not exist: {0}'
.format(wind_file))
if topology_file is not None:
if not os.path.exists(topology_file):
raise ValueError('Path for Topology file does not exist: {0}'
.format(topology_file))
# is wind_file and topology_file is stored with cy_gridwind_mover?
self.wind_file = wind_file
self.topology_file = topology_file
self.name = os.path.split(wind_file)[1]
self.drift_angle = drift_angle
self._wind_scale = kwargs.pop('wind_scale', 1)
self.grid_type = grid_type
self.grid = Grid(wind_file, topology_file, grid_type)
self.mover = Mover()
super(ShipDriftMover, self).__init__(**kwargs)
# have to override any uncertainty
# self.grid.load_data(wind_file, topology_file)
self.model_time = 0
self.positions = np.zeros((0, 3), dtype=world_point_type)
self.delta = np.zeros((0, 3), dtype=world_point_type)
self.status_codes = np.zeros((0, 1), dtype=status_code_type)
self.array_types.update({'windages',
'windage_range',
'windage_persist'})
def test_grid_wind_rect():
'''
check TimeGridWindRect correctly parses data
'''
idx = 5
file_ = testdata['GridWindMover']['wind_rect']
with nc.Dataset(file_) as data:
time = nc.num2date(data.variables['time'][idx],
units=data.variables['time'].units)
long_lat = (data.variables['lon'][idx], data.variables['lat'][idx])
exp_vel = (data.variables['air_u'][idx][idx][idx],
data.variables['air_v'][idx][idx][idx])
rect = Grid(file_)
time = date_to_sec(time)
vel = rect.get_value(time, long_lat)
print "\nRect grid - vel: {0}".format(vel)
print "Rect grid - expected_vel: {0}".format(exp_vel)
assert (vel.item() == exp_vel)
def test_grid_wind_rect():
'''
check TimeGridWindRect correctly parses data
'''
idx = 5
file_ = testdata['GridWindMover']['wind_rect']
with nc.Dataset(file_) as data:
time = nc.num2date(data.variables['time'][idx],
units=data.variables['time'].units)
long_lat = (data.variables['lon'][idx],
data.variables['lat'][idx])
exp_vel = (data.variables['air_u'][idx][idx][idx],
data.variables['air_v'][idx][idx][idx])
rect = Grid(file_)
time = date_to_sec(time)
vel = rect.get_value(time, long_lat)
print "\nRect grid - vel: {0}".format(vel)
print "Rect grid - expected_vel: {0}".format(exp_vel)
assert (vel.item() == exp_vel)
class ShipDriftMover(Mover):
_schema = ShipDriftMoverSchema
def __init__(self,
wind_file=None,
topology_file=None,
grid_type=1,
drift_angle=0,
extrapolation_is_allowed=False,
time_offset=0,
**kwargs):
"""
:param wind_file: file containing wind data on a grid
:param topology_file: Default is None. When exporting topology, it
is stored in this file
:param wind_scale: Value to scale wind data
:param extrapolate: Allow current data to be extrapolated before and
after file data
:param time_offset: Time zone shift if data is in GMT
Pass optional arguments to base class
uses super: super(ShipDriftMover,self).__init__(\*\*kwargs)
"""
if not os.path.exists(wind_file):
raise ValueError(
'Path for wind file does not exist: {0}'.format(wind_file))
if topology_file is not None:
if not os.path.exists(topology_file):
raise ValueError(
'Path for Topology file does not exist: {0}'.format(
topology_file))
# is wind_file and topology_file is stored with cy_gridwind_mover?
self.wind_file = wind_file
self.topology_file = topology_file
self.name = os.path.split(wind_file)[1]
self.drift_angle = drift_angle
self._wind_scale = kwargs.pop('wind_scale', 1)
self.grid_type = grid_type
self.grid = Grid(wind_file, topology_file, grid_type)
self.mover = Mover()
super(ShipDriftMover, self).__init__(**kwargs)
# have to override any uncertainty
# self.grid.load_data(wind_file, topology_file)
self.model_time = 0
self.positions = np.zeros((0, 3), dtype=world_point_type)
self.delta = np.zeros((0, 3), dtype=world_point_type)
self.status_codes = np.zeros((0, 1), dtype=status_code_type)
self.array_types.update(
{'windages', 'windage_range', 'windage_persist'})
def __repr__(self):
"""
.. todo::
We probably want to include more information.
"""
return ('ShipDriftMover('
'active_start={1.active_start}, '
'active_stop={1.active_stop}, '
'on={1.on})'.format(self.mover, self))
def __str__(self):
return ('ShipDriftMover - current _state.\n'
' active_start time={1.active_start}\n'
' active_stop time={1.active_stop}\n'
' current on/off status={1.on}'.format(self.mover, self))
wind_scale = property(lambda self: self._wind_scale,
lambda self, val: setattr(self, 'wind_scale', val))
extrapolate = property(
lambda self: self.grid.extrapolate,
lambda self, val: setattr(self.grid, 'extrapolate', val))
time_offset = property(
lambda self: self.grid.time_offset / 3600.,
lambda self, val: setattr(self.grid, 'time_offset', val * 3600.))
def export_topology(self, topology_file):
"""
:param topology_file=None: absolute or relative path where topology
file will be written.
"""
if topology_file is None:
raise ValueError(
'Topology file path required: {0}'.format(topology_file))
self.grid.export_topology(topology_file)
def prepare_for_model_run(self):
"""
Override this method if a derived mover class needs to perform any
actions prior to a model run
"""
# May not need this function
pass
def prepare_for_model_step(self, sc, time_step, model_time_datetime):
"""
Call base class method using super
Also updates windage for this timestep
:param sc: an instance of gnome.spill_container.SpillContainer class
:param time_step: time step in seconds
:param model_time_datetime: current time of model as a date time object
"""
# not sure if we need to redefine this or what we want to do here
super(ShipDriftMover,
self).prepare_for_model_step(sc, time_step, model_time_datetime)
# if no particles released, then no need for windage
# TODO: revisit this since sc.num_released shouldn't be None
if sc.num_released is None or sc.num_released == 0:
return
self.grid.prepare_for_model_step(model_time_datetime)
# here we might put in drift angle stuff ?
if self.active:
rand.random_with_persistance(sc['windage_range'][:, 0],
sc['windage_range'][:, 1],
sc['windages'], sc['windage_persist'],
time_step)
def prepare_data_for_get_move(self, sc, model_time_datetime):
"""
organizes the spill object into inputs for calling with Cython
wrapper's get_move(...)
:param sc: an instance of gnome.spill_container.SpillContainer class
:param model_time_datetime: current model time as datetime object
"""
self.model_time = self.datetime_to_seconds(model_time_datetime)
# Get the data:
try:
self.positions = sc['positions']
self.status_codes = sc['status_codes']
except KeyError, err:
raise ValueError('The spill container does not have the required'
'data arrays\n' + str(err))
self.positions = (self.positions.view(dtype=world_point).reshape(
(len(self.positions), )))
self.delta = np.zeros(len(self.positions), dtype=world_point)
class ShipDriftMover(Mover, serializable.Serializable):
_state = copy.deepcopy(Mover._state)
_state.add(update=['wind_scale','grid_type','drift_angle'], save=['wind_scale','grid_type','drift_angle'])
_state.add_field([serializable.Field('wind_file', save=True,
read=True, isdatafile=True, test_for_eq=False),
serializable.Field('topology_file', save=True,
read=True, isdatafile=True, test_for_eq=False)])
_schema = ShipDriftMoverSchema
def __init__(self, wind_file, topology_file=None, grid_type=1,
drift_angle = 0, extrapolate=False, time_offset=0,
**kwargs):
"""
:param wind_file: file containing wind data on a grid
:param topology_file: Default is None. When exporting topology, it
is stored in this file
:param wind_scale: Value to scale wind data
:param extrapolate: Allow current data to be extrapolated before and
after file data
:param time_offset: Time zone shift if data is in GMT
Pass optional arguments to base class
uses super: super(ShipDriftMover,self).__init__(\*\*kwargs)
"""
if not os.path.exists(wind_file):
raise ValueError('Path for wind file does not exist: {0}'
.format(wind_file))
if topology_file is not None:
if not os.path.exists(topology_file):
raise ValueError('Path for Topology file does not exist: {0}'
.format(topology_file))
# is wind_file and topology_file is stored with cy_gridwind_mover?
self.wind_file = wind_file
self.topology_file = topology_file
self.mover = Mover()
self.grid_type = grid_type
self.drift_angle = drift_angle
self.grid = Grid(wind_file, topology_file, grid_type)
self.name = os.path.split(wind_file)[1]
self._wind_scale=kwargs.pop('wind_scale', 1)
super(ShipDriftMover, self).__init__(**kwargs)
#have to override any uncertainty
#self.grid.load_data(wind_file, topology_file)
self.model_time = 0
self.positions = np.zeros((0, 3), dtype=world_point_type)
self.delta = np.zeros((0, 3), dtype=world_point_type)
self.status_codes = np.zeros((0, 1), dtype=status_code_type)
self.array_types.update({'windages',
'windage_range',
'windage_persist'})
def __repr__(self):
"""
.. todo::
We probably want to include more information.
"""
return ('ShipDriftMover('
'active_start={1.active_start}, '
'active_stop={1.active_stop}, '
'on={1.on})'.format(self.mover, self))
def __str__(self):
return ('ShipDriftMover - current _state.\n'
' active_start time={1.active_start}\n'
' active_stop time={1.active_stop}\n'
' current on/off status={1.on}'
.format(self.mover, self))
wind_scale = property(lambda self: self._wind_scale,
lambda self, val: setattr(self,
'wind_scale',
val))
extrapolate = property(lambda self: self.grid.extrapolate,
lambda self, val: setattr(self.grid,
'extrapolate',
val))
time_offset = property(lambda self: self.grid.time_offset / 3600.,
lambda self, val: setattr(self.grid,
'time_offset',
val * 3600.))
def export_topology(self, topology_file):
"""
:param topology_file=None: absolute or relative path where topology
file will be written.
"""
if topology_file is None:
raise ValueError('Topology file path required: {0}'.
format(topology_file))
self.grid.export_topology(topology_file)
def prepare_for_model_run(self):
"""
Override this method if a derived mover class needs to perform any
actions prior to a model run
"""
# May not need this function
pass
def prepare_for_model_step(self, sc, time_step, model_time_datetime):
"""
Call base class method using super
Also updates windage for this timestep
:param sc: an instance of gnome.spill_container.SpillContainer class
:param time_step: time step in seconds
:param model_time_datetime: current time of model as a date time object
"""
# not sure if we need to redefine this or what we want to do here
super(ShipDriftMover, self).prepare_for_model_step(sc, time_step,
model_time_datetime)
# if no particles released, then no need for windage
# TODO: revisit this since sc.num_released shouldn't be None
if sc.num_released is None or sc.num_released == 0:
return
self.grid.prepare_for_model_step(model_time_datetime)
# here we might put in drift angle stuff ?
rand.random_with_persistance(sc['windage_range'][:, 0],
sc['windage_range'][:, 1],
sc['windages'],
sc['windage_persist'],
time_step)
def prepare_data_for_get_move(self, sc, model_time_datetime):
"""
organizes the spill object into inputs for calling with Cython
wrapper's get_move(...)
:param sc: an instance of gnome.spill_container.SpillContainer class
:param model_time_datetime: current model time as datetime object
"""
self.model_time = self.datetime_to_seconds(model_time_datetime)
# Get the data:
try:
self.positions = sc['positions']
self.status_codes = sc['status_codes']
except KeyError, err:
raise ValueError('The spill container does not have the required'
'data arrays\n' + err.message)
self.positions = \
self.positions.view(dtype=world_point).reshape(
(len(self.positions),))
self.delta = np.zeros(len(self.positions),
dtype=world_point)
