Note
Go to the end to download the full example code.
Reader boundary
Seeding elements around the border of a ocean model domain (NorKyst800) to demonstrate autmatic transition back and forth with another model covering a larger domain (Topaz).
from datetime import datetime
import numpy as np
from opendrift.readers import reader_netCDF_CF_generic
from opendrift.models.oceandrift import OceanDrift
o = OceanDrift(loglevel=20) # Set loglevel to 0 for debug information
# Norkyst
reader_norkyst = reader_netCDF_CF_generic.Reader('https://thredds.met.no/thredds/dodsC/fou-hi/norkystv3_800m_m00_be')
# Topaz
reader_topaz = reader_netCDF_CF_generic.Reader('https://thredds.met.no/thredds/dodsC/cmems/topaz6/dataset-topaz6-arc-15min-3km-be.ncml')
o.add_reader([reader_norkyst, reader_topaz])
o.set_config('environment:fallback:land_binary_mask', 0)
o.set_config('drift:vertical_mixing', False)
14:41:13 INFO opendrift:576: OpenDriftSimulation initialised (version 1.14.6 / v1.14.6-9-geaa6ee2)
14:41:13 INFO opendrift.readers:63: Opening file with xr.open_dataset
14:41:15 INFO opendrift.readers.reader_netCDF_CF_generic:332: Detected dimensions: {'x': 'X', 'y': 'Y', 'z': 'depth', 'time': 'time'}
14:41:15 INFO opendrift.readers.basereader:176: Variable x_sea_water_velocity will be rotated from eastward_sea_water_velocity
14:41:15 INFO opendrift.readers.basereader:176: Variable y_sea_water_velocity will be rotated from northward_sea_water_velocity
14:41:15 INFO opendrift.readers.basereader:176: Variable x_wind will be rotated from eastward_wind
14:41:15 INFO opendrift.readers.basereader:176: Variable y_wind will be rotated from northward_wind
14:41:15 INFO opendrift.readers:63: Opening file with xr.open_dataset
14:41:18 INFO opendrift.readers.reader_netCDF_CF_generic:332: Detected dimensions: {'x': 'x', 'y': 'y', 'time': 'time'}
Seeding some particles
lons = np.linspace(5, 8, 50)
lats = np.linspace(69.8, 70.8, 50)
lons, lats = np.meshgrid(lons, lats)
Seed oil elements at defined position and time
o.seed_elements(lons, lats, radius=0, number=2500,
time=datetime.now())
14:41:18 INFO opendrift.models.basemodel.environment:203: Adding a global landmask from GSHHG
14:41:22 INFO opendrift.models.basemodel.environment:227: Fallback values will be used for the following variables which have no readers:
14:41:22 INFO opendrift.models.basemodel.environment:230: sea_surface_wave_significant_height: 0.000000
14:41:22 INFO opendrift.models.basemodel.environment:230: sea_surface_wave_stokes_drift_x_velocity: 0.000000
14:41:22 INFO opendrift.models.basemodel.environment:230: sea_surface_wave_stokes_drift_y_velocity: 0.000000
14:41:22 INFO opendrift.models.basemodel.environment:230: ocean_mixed_layer_thickness: 50.000000
Running model
o.run(steps=16*4, time_step=900, time_step_output=1800)
14:41:22 INFO opendrift:1794: Skipping environment variable ocean_vertical_diffusivity because of condition ['drift:vertical_mixing', 'is', False]
14:41:22 INFO opendrift:1794: Skipping environment variable ocean_mixed_layer_thickness because of condition ['drift:vertical_mixing', 'is', False]
14:41:22 INFO opendrift:1805: Storing previous values of element property lon because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
14:41:22 INFO opendrift:1805: Storing previous values of element property lat because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
14:41:22 INFO opendrift:1813: Storing previous values of environment variable sea_surface_height because of condition ['drift:vertical_advection', 'is', True]
14:41:22 INFO opendrift:952: Using existing reader for land_binary_mask to move elements to ocean
14:41:22 INFO opendrift:982: All points are in ocean
14:41:22 INFO opendrift:2101: 2025-11-10 14:41:18.422192 - step 1 of 64 - 2500 active elements (0 deactivated)
14:41:26 INFO opendrift:2101: 2025-11-10 14:56:18.422192 - step 2 of 64 - 2500 active elements (0 deactivated)
14:41:27 INFO opendrift:2101: 2025-11-10 15:11:18.422192 - step 3 of 64 - 2500 active elements (0 deactivated)
14:41:29 INFO opendrift:2101: 2025-11-10 15:26:18.422192 - step 4 of 64 - 2500 active elements (0 deactivated)
14:41:30 INFO opendrift:2101: 2025-11-10 15:41:18.422192 - step 5 of 64 - 2500 active elements (0 deactivated)
14:41:30 INFO opendrift:2101: 2025-11-10 15:56:18.422192 - step 6 of 64 - 2500 active elements (0 deactivated)
14:41:31 INFO opendrift:2101: 2025-11-10 16:11:18.422192 - step 7 of 64 - 2500 active elements (0 deactivated)
14:41:33 INFO opendrift:2101: 2025-11-10 16:26:18.422192 - step 8 of 64 - 2500 active elements (0 deactivated)
14:41:34 INFO opendrift:2101: 2025-11-10 16:41:18.422192 - step 9 of 64 - 2500 active elements (0 deactivated)
14:41:34 INFO opendrift:2101: 2025-11-10 16:56:18.422192 - step 10 of 64 - 2500 active elements (0 deactivated)
14:41:35 INFO opendrift:2101: 2025-11-10 17:11:18.422192 - step 11 of 64 - 2500 active elements (0 deactivated)
14:41:37 INFO opendrift:2101: 2025-11-10 17:26:18.422192 - step 12 of 64 - 2500 active elements (0 deactivated)
14:41:38 INFO opendrift:2101: 2025-11-10 17:41:18.422192 - step 13 of 64 - 2500 active elements (0 deactivated)
14:41:39 INFO opendrift:2101: 2025-11-10 17:56:18.422192 - step 14 of 64 - 2500 active elements (0 deactivated)
14:41:39 INFO opendrift:2101: 2025-11-10 18:11:18.422192 - step 15 of 64 - 2500 active elements (0 deactivated)
14:41:42 INFO opendrift:2101: 2025-11-10 18:26:18.422192 - step 16 of 64 - 2500 active elements (0 deactivated)
14:41:42 INFO opendrift:2101: 2025-11-10 18:41:18.422192 - step 17 of 64 - 2500 active elements (0 deactivated)
14:41:43 INFO opendrift:2101: 2025-11-10 18:56:18.422192 - step 18 of 64 - 2500 active elements (0 deactivated)
14:41:44 INFO opendrift:2101: 2025-11-10 19:11:18.422192 - step 19 of 64 - 2500 active elements (0 deactivated)
14:41:46 INFO opendrift:2101: 2025-11-10 19:26:18.422192 - step 20 of 64 - 2500 active elements (0 deactivated)
14:41:47 INFO opendrift:2101: 2025-11-10 19:41:18.422192 - step 21 of 64 - 2500 active elements (0 deactivated)
14:41:48 INFO opendrift:2101: 2025-11-10 19:56:18.422192 - step 22 of 64 - 2500 active elements (0 deactivated)
14:41:48 INFO opendrift:2101: 2025-11-10 20:11:18.422192 - step 23 of 64 - 2500 active elements (0 deactivated)
14:41:52 INFO opendrift:2101: 2025-11-10 20:26:18.422192 - step 24 of 64 - 2500 active elements (0 deactivated)
14:41:52 INFO opendrift:2101: 2025-11-10 20:41:18.422192 - step 25 of 64 - 2500 active elements (0 deactivated)
14:41:53 INFO opendrift:2101: 2025-11-10 20:56:18.422192 - step 26 of 64 - 2500 active elements (0 deactivated)
14:41:53 INFO opendrift:2101: 2025-11-10 21:11:18.422192 - step 27 of 64 - 2500 active elements (0 deactivated)
14:41:56 INFO opendrift:2101: 2025-11-10 21:26:18.422192 - step 28 of 64 - 2500 active elements (0 deactivated)
14:41:57 INFO opendrift:2101: 2025-11-10 21:41:18.422192 - step 29 of 64 - 2500 active elements (0 deactivated)
14:41:57 INFO opendrift:2101: 2025-11-10 21:56:18.422192 - step 30 of 64 - 2500 active elements (0 deactivated)
14:41:58 INFO opendrift:2101: 2025-11-10 22:11:18.422192 - step 31 of 64 - 2500 active elements (0 deactivated)
14:42:01 INFO opendrift:2101: 2025-11-10 22:26:18.422192 - step 32 of 64 - 2500 active elements (0 deactivated)
14:42:02 INFO opendrift:2101: 2025-11-10 22:41:18.422192 - step 33 of 64 - 2500 active elements (0 deactivated)
14:42:02 INFO opendrift:2101: 2025-11-10 22:56:18.422192 - step 34 of 64 - 2500 active elements (0 deactivated)
14:42:03 INFO opendrift:2101: 2025-11-10 23:11:18.422192 - step 35 of 64 - 2500 active elements (0 deactivated)
14:42:06 INFO opendrift:2101: 2025-11-10 23:26:18.422192 - step 36 of 64 - 2500 active elements (0 deactivated)
14:42:07 INFO opendrift:2101: 2025-11-10 23:41:18.422192 - step 37 of 64 - 2500 active elements (0 deactivated)
14:42:07 INFO opendrift:2101: 2025-11-10 23:56:18.422192 - step 38 of 64 - 2500 active elements (0 deactivated)
14:42:08 INFO opendrift:2101: 2025-11-11 00:11:18.422192 - step 39 of 64 - 2500 active elements (0 deactivated)
14:42:11 INFO opendrift:2101: 2025-11-11 00:26:18.422192 - step 40 of 64 - 2500 active elements (0 deactivated)
14:42:11 INFO opendrift:2101: 2025-11-11 00:41:18.422192 - step 41 of 64 - 2500 active elements (0 deactivated)
14:42:12 INFO opendrift:2101: 2025-11-11 00:56:18.422192 - step 42 of 64 - 2500 active elements (0 deactivated)
14:42:13 INFO opendrift:2101: 2025-11-11 01:11:18.422192 - step 43 of 64 - 2500 active elements (0 deactivated)
14:42:16 INFO opendrift:2101: 2025-11-11 01:26:18.422192 - step 44 of 64 - 2500 active elements (0 deactivated)
14:42:16 INFO opendrift:2101: 2025-11-11 01:41:18.422192 - step 45 of 64 - 2500 active elements (0 deactivated)
14:42:17 INFO opendrift:2101: 2025-11-11 01:56:18.422192 - step 46 of 64 - 2500 active elements (0 deactivated)
14:42:17 INFO opendrift:2101: 2025-11-11 02:11:18.422192 - step 47 of 64 - 2500 active elements (0 deactivated)
14:42:20 INFO opendrift:2101: 2025-11-11 02:26:18.422192 - step 48 of 64 - 2500 active elements (0 deactivated)
14:42:21 INFO opendrift:2101: 2025-11-11 02:41:18.422192 - step 49 of 64 - 2500 active elements (0 deactivated)
14:42:22 INFO opendrift:2101: 2025-11-11 02:56:18.422192 - step 50 of 64 - 2500 active elements (0 deactivated)
14:42:23 INFO opendrift:2101: 2025-11-11 03:11:18.422192 - step 51 of 64 - 2500 active elements (0 deactivated)
14:42:25 INFO opendrift:2101: 2025-11-11 03:26:18.422192 - step 52 of 64 - 2500 active elements (0 deactivated)
14:42:25 INFO opendrift:2101: 2025-11-11 03:41:18.422192 - step 53 of 64 - 2500 active elements (0 deactivated)
14:42:26 INFO opendrift:2101: 2025-11-11 03:56:18.422192 - step 54 of 64 - 2500 active elements (0 deactivated)
14:42:27 INFO opendrift:2101: 2025-11-11 04:11:18.422192 - step 55 of 64 - 2500 active elements (0 deactivated)
14:42:30 INFO opendrift:2101: 2025-11-11 04:26:18.422192 - step 56 of 64 - 2500 active elements (0 deactivated)
14:42:31 INFO opendrift:2101: 2025-11-11 04:41:18.422192 - step 57 of 64 - 2500 active elements (0 deactivated)
14:42:31 INFO opendrift:2101: 2025-11-11 04:56:18.422192 - step 58 of 64 - 2500 active elements (0 deactivated)
14:42:32 INFO opendrift:2101: 2025-11-11 05:11:18.422192 - step 59 of 64 - 2500 active elements (0 deactivated)
14:42:35 INFO opendrift:2101: 2025-11-11 05:26:18.422192 - step 60 of 64 - 2500 active elements (0 deactivated)
14:42:35 INFO opendrift:2101: 2025-11-11 05:41:18.422192 - step 61 of 64 - 2500 active elements (0 deactivated)
14:42:36 INFO opendrift:2101: 2025-11-11 05:56:18.422192 - step 62 of 64 - 2500 active elements (0 deactivated)
14:42:37 INFO opendrift:2101: 2025-11-11 06:11:18.422192 - step 63 of 64 - 2500 active elements (0 deactivated)
14:42:40 INFO opendrift:2101: 2025-11-11 06:26:18.422192 - step 64 of 64 - 2500 active elements (0 deactivated)
Print and plot results
print(o)
o.animation(fast=True)
===========================
--------------------
Reader performance:
--------------------
https://thredds.met.no/thredds/dodsC/fou-hi/norkystv3_800m_m00_be
0:00:37.8 total
0:00:00.0 preparing
0:00:37.3 reading
0:00:00.4 interpolation
0:00:00.0 interpolation_time
0:00:00.4 rotating vectors
0:00:00.0 masking
--------------------
https://thredds.met.no/thredds/dodsC/cmems/topaz6/dataset-topaz6-arc-15min-3km-be.ncml
0:00:38.6 total
0:00:00.0 preparing
0:00:38.5 reading
0:00:00.0 interpolation
0:00:00.0 interpolation_time
0:00:00.1 rotating vectors
0:00:00.0 masking
--------------------
global_landmask
0:00:00.0 total
0:00:00.0 preparing
0:00:00.0 reading
0:00:00.0 masking
--------------------
Performance:
1:27.5 total time
9.0 configuration
0.0 preparing main loop
0.0 moving elements to ocean
1:18.4 main loop
0.2 updating elements
0.0 cleaning up
--------------------
===========================
Model: OceanDrift (OpenDrift version 1.14.6)
2500 active Lagrangian3DArray particles (0 deactivated, 0 scheduled)
-------------------
Environment variables:
-----
sea_floor_depth_below_sea_level
sea_surface_height
x_sea_water_velocity
y_sea_water_velocity
1) https://thredds.met.no/thredds/dodsC/fou-hi/norkystv3_800m_m00_be
2) https://thredds.met.no/thredds/dodsC/cmems/topaz6/dataset-topaz6-arc-15min-3km-be.ncml
-----
upward_sea_water_velocity
x_wind
y_wind
1) https://thredds.met.no/thredds/dodsC/fou-hi/norkystv3_800m_m00_be
-----
land_binary_mask
1) global_landmask
-----
Readers not added for the following variables:
sea_surface_wave_significant_height
sea_surface_wave_stokes_drift_x_velocity
sea_surface_wave_stokes_drift_y_velocity
Discarded readers:
Time:
Start: 2025-11-10 14:41:18.422192 UTC
Present: 2025-11-11 06:41:18.422192 UTC
Calculation steps: 64 * 0:15:00 - total time: 16:00:00
Output steps: 33 * 0:30:00
===========================
14:42:41 WARNING opendrift:2460: Plotting fast. This will make your plots less accurate.
14:42:42 INFO opendrift:4636: Saving animation to /root/project/docs/source/gallery/animations/example_reader_boundary_0.gif...
14:43:05 INFO opendrift:3071: Time to make animation: 0:00:24.481187
o.plot(fast=True)
14:43:05 WARNING opendrift:2460: Plotting fast. This will make your plots less accurate.
(<GeoAxes: title={'center': 'OpenDrift - OceanDrift\n2025-11-10 14:41 to 2025-11-11 06:41 UTC (33 steps)'}>, <Figure size 1036.16x1100 with 1 Axes>)
Total running time of the script: (2 minutes 5.069 seconds)