Note

Go to the end to download the full example code.

Show dominating source

import os
from datetime import datetime
import xarray as xr
import opendrift
from opendrift.models.oceandrift import OceanDrift

of = 'test.nc'

Seed elements at 5 different locations/longitudes

lons = [4, 4.2, 4.3, 4.32, 4.6]
t = datetime.now()

o = OceanDrift(loglevel=20)
o.set_config('environment:constant:y_sea_water_velocity', .1)

for i, lon in enumerate(lons):
    o.seed_elements(lon=lon, lat=60, radius=3000, number=2000, time=t, origin_marker_name='Lon %f' % lon)
o.run(steps=15, outfile=of)

14:20:09 INFO    opendrift.models.basemodel:533: OpenDriftSimulation initialised (version 1.11.2 / v1.11.2-43-gce9f6bb)
14:20:09 INFO    opendrift.models.basemodel.environment:218: Adding a dynamical landmask with max. priority based on assumed maximum speed of 2.0 m/s. Adding a customised landmask may be faster...
14:20:14 INFO    opendrift.models.basemodel.environment:245: Fallback values will be used for the following variables which have no readers:
14:20:14 INFO    opendrift.models.basemodel.environment:248:    x_sea_water_velocity: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_height: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    x_wind: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    y_wind: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    upward_sea_water_velocity: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    ocean_vertical_diffusivity: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_wave_significant_height: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_wave_stokes_drift_x_velocity: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_wave_stokes_drift_y_velocity: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_wave_period_at_variance_spectral_density_maximum: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_wave_mean_period_from_variance_spectral_density_second_frequency_moment: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_swell_wave_to_direction: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_swell_wave_peak_period_from_variance_spectral_density: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_swell_wave_significant_height: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_wind_wave_to_direction: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_wind_wave_mean_period: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_surface_wind_wave_significant_height: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    surface_downward_x_stress: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    surface_downward_y_stress: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    turbulent_kinetic_energy: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    turbulent_generic_length_scale: 0.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    ocean_mixed_layer_thickness: 50.000000
14:20:14 INFO    opendrift.models.basemodel.environment:248:    sea_floor_depth_below_sea_level: 10000.000000
14:20:15 INFO    opendrift.models.basemodel:911: Using existing reader for land_binary_mask
14:20:15 INFO    opendrift.models.basemodel:922: All points are in ocean
14:20:15 INFO    opendrift.models.basemodel:2011: 2024-05-14 14:20:09.077036 - step 1 of 15 - 10000 active elements (0 deactivated)
14:20:15 INFO    opendrift.models.basemodel:2011: 2024-05-14 15:20:09.077036 - step 2 of 15 - 10000 active elements (0 deactivated)
14:20:15 INFO    opendrift.models.basemodel:2011: 2024-05-14 16:20:09.077036 - step 3 of 15 - 10000 active elements (0 deactivated)
14:20:15 INFO    opendrift.models.basemodel:2011: 2024-05-14 17:20:09.077036 - step 4 of 15 - 10000 active elements (0 deactivated)
14:20:15 INFO    opendrift.models.basemodel:2011: 2024-05-14 18:20:09.077036 - step 5 of 15 - 10000 active elements (0 deactivated)
14:20:16 INFO    opendrift.models.basemodel:2011: 2024-05-14 19:20:09.077036 - step 6 of 15 - 10000 active elements (0 deactivated)
14:20:16 INFO    opendrift.models.basemodel:2011: 2024-05-14 20:20:09.077036 - step 7 of 15 - 10000 active elements (0 deactivated)
14:20:16 INFO    opendrift.models.basemodel:2011: 2024-05-14 21:20:09.077036 - step 8 of 15 - 10000 active elements (0 deactivated)
14:20:16 INFO    opendrift.models.basemodel:2011: 2024-05-14 22:20:09.077036 - step 9 of 15 - 10000 active elements (0 deactivated)
14:20:16 INFO    opendrift.models.basemodel:2011: 2024-05-14 23:20:09.077036 - step 10 of 15 - 10000 active elements (0 deactivated)
14:20:16 INFO    opendrift.models.basemodel:2011: 2024-05-15 00:20:09.077036 - step 11 of 15 - 10000 active elements (0 deactivated)
14:20:16 INFO    opendrift.models.basemodel:2011: 2024-05-15 01:20:09.077036 - step 12 of 15 - 10000 active elements (0 deactivated)
14:20:16 INFO    opendrift.models.basemodel:2011: 2024-05-15 02:20:09.077036 - step 13 of 15 - 10000 active elements (0 deactivated)
14:20:16 INFO    opendrift.models.basemodel:2011: 2024-05-15 03:20:09.077036 - step 14 of 15 - 10000 active elements (0 deactivated)
14:20:16 INFO    opendrift.models.basemodel:2011: 2024-05-15 04:20:09.077036 - step 15 of 15 - 10000 active elements (0 deactivated)
14:20:17 INFO    opendrift.export.io_netcdf:116: Wrote 16 steps to file test.nc
/opt/conda/envs/opendrift/lib/python3.11/site-packages/numpy/ma/core.py:467: RuntimeWarning: invalid value encountered in cast
  fill_value = np.array(fill_value, copy=False, dtype=ndtype)

Calculate spatial density of elements at 1500m grid spacing

oa = opendrift.open_xarray(of)
oa.ds = oa.ds.where(oa.ds.status==0)
d = oa.get_histogram(pixelsize_m=1500, weights=None)
dom = d.argmax(dim='origin_marker', skipna=True)
dom = dom.where(d.sum(dim='origin_marker')>0)
dom.name = 'Dominating source'

14:20:18 DEBUG   opendrift.config:161: Adding 16 config items from __init__
14:20:18 DEBUG   opendrift.config:171:   Overwriting config item readers:max_number_of_fails
14:20:18 DEBUG   opendrift.config:161: Adding 5 config items from __init__
14:20:18 INFO    opendrift.models.basemodel:533: OpenDriftSimulation initialised (version 1.11.2 / v1.11.2-43-gce9f6bb)
14:20:18 DEBUG   opendrift.config:161: Adding 15 config items from oceandrift
14:20:18 DEBUG   opendrift.config:171:   Overwriting config item seed:z
14:20:18 DEBUG   opendrift.export.io_netcdf:226: Importing with Xarray from test.nc
14:20:18 INFO    opendrift:118: Returning <class 'opendrift.models.oceandrift.OceanDrift'> object
14:20:18 INFO    opendrift.models.basemodel:3854:       calculating for origin_marker 0...
14:20:18 INFO    opendrift.models.basemodel:3854:       calculating for origin_marker 1...
14:20:18 INFO    opendrift.models.basemodel:3854:       calculating for origin_marker 2...
14:20:18 INFO    opendrift.models.basemodel:3854:       calculating for origin_marker 3...
14:20:18 INFO    opendrift.models.basemodel:3854:       calculating for origin_marker 4...

Show which of the 5 sources are dominating within each grid cell

oa.animation(background=dom, show_elements=False, bgalpha=1,
             legend=oa.origin_marker, colorbar=False, vmin=0, vmax=4)

14:20:18 DEBUG   opendrift.models.basemodel:2333: Setting up map: corners=None, fast=False, lscale=None
14:20:19 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
/opt/conda/envs/opendrift/lib/python3.11/site-packages/cartopy/mpl/geoaxes.py:1683: UserWarning: No data for colormapping provided via 'c'. Parameters 'cmap', 'vmin', 'vmax' will be ignored
  result = super().scatter(*args, **kwargs)
14:20:38 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:39 DEBUG   opendrift.models.basemodel:3010: Saving animation..
14:20:39 INFO    opendrift.models.basemodel:4570: Saving animation to /root/project/docs/source/gallery/animations/example_dominating_0.gif...
14:20:39 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:41 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:42 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:44 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:45 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:46 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:48 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:49 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:51 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:52 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:54 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:55 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:57 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:20:58 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:00 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:01 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:03 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:04 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:06 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:08 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:10 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:12 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:13 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:15 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:18 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:20 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:23 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:26 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:28 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:29 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:31 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:34 DEBUG   opendrift.readers.reader_global_landmask:83: Adding GSHHG shapes from cartopy, scale: h, extent: (3.435968017578124, 5.1932105064392085, 59.68026428222656, 60.350817871093746)..
14:21:37 DEBUG   opendrift.models.basemodel:4608: MPLBACKEND = agg
14:21:37 DEBUG   opendrift.models.basemodel:4609: DISPLAY = None
14:21:37 DEBUG   opendrift.models.basemodel:4610: Time to save animation: 0:00:57.350333
14:21:37 INFO    opendrift.models.basemodel:3003: Time to make animation: 0:01:18.249438
../_images/example_dominating_0.gif 
os.remove(of)

Total running time of the script: (1 minutes 28.811 seconds)

Gallery generated by Sphinx-Gallery