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)
18:18:09 INFO opendrift:576: OpenDriftSimulation initialised (version 1.14.9 / v1.14.9-1-g9eceedb)
18:18:09 INFO opendrift.readers:64: Opening file with xr.open_dataset
18:18:10 INFO opendrift.readers.reader_netCDF_CF_generic:340: Detected dimensions: {'x': 'X', 'y': 'Y', 'z': 'depth', 'time': 'time'}
18:18:10 INFO opendrift.readers.basereader:178: Variable x_sea_water_velocity will be rotated from eastward_sea_water_velocity
18:18:10 INFO opendrift.readers.basereader:178: Variable y_sea_water_velocity will be rotated from northward_sea_water_velocity
18:18:10 INFO opendrift.readers.basereader:178: Variable x_wind will be rotated from eastward_wind
18:18:10 INFO opendrift.readers.basereader:178: Variable y_wind will be rotated from northward_wind
18:18:10 INFO opendrift.readers:64: Opening file with xr.open_dataset
18:18:13 INFO opendrift.readers.reader_netCDF_CF_generic:340: 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())
18:18:13 INFO opendrift.models.basemodel.environment:203: Adding a global landmask from GSHHG
18:18:17 INFO opendrift.models.basemodel.environment:227: Fallback values will be used for the following variables which have no readers:
18:18:17 INFO opendrift.models.basemodel.environment:230: horizontal_diffusivity: 0.000000
18:18:17 INFO opendrift.models.basemodel.environment:230: sea_surface_wave_significant_height: 0.000000
18:18:17 INFO opendrift.models.basemodel.environment:230: sea_surface_wave_stokes_drift_x_velocity: 0.000000
18:18:17 INFO opendrift.models.basemodel.environment:230: sea_surface_wave_stokes_drift_y_velocity: 0.000000
18:18:17 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)
18:18:17 INFO opendrift:1836: Skipping environment variable ocean_vertical_diffusivity because of condition ['drift:vertical_mixing', 'is', False]
18:18:17 INFO opendrift:1836: Skipping environment variable ocean_mixed_layer_thickness because of condition ['drift:vertical_mixing', 'is', False]
18:18:17 INFO opendrift:1847: Storing previous values of element property lon because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
18:18:17 INFO opendrift:1847: Storing previous values of element property lat because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
18:18:17 INFO opendrift:1855: Storing previous values of environment variable sea_surface_height because of condition ['drift:vertical_advection', 'is', True]
18:18:17 INFO opendrift:955: Using existing reader for land_binary_mask to move elements to ocean
18:18:17 INFO opendrift:986: All points are in ocean
18:18:17 INFO opendrift:2144: 2026-03-18 18:18:13.534094 - step 1 of 64 - 2500 active elements (0 deactivated)
18:18:24 INFO opendrift:2144: 2026-03-18 18:33:13.534094 - step 2 of 64 - 2500 active elements (0 deactivated)
18:18:25 INFO opendrift:2144: 2026-03-18 18:48:13.534094 - step 3 of 64 - 2500 active elements (0 deactivated)
18:18:27 INFO opendrift:2144: 2026-03-18 19:03:13.534094 - step 4 of 64 - 2500 active elements (0 deactivated)
18:18:30 INFO opendrift:2144: 2026-03-18 19:18:13.534094 - step 5 of 64 - 2500 active elements (0 deactivated)
18:18:31 INFO opendrift:2144: 2026-03-18 19:33:13.534094 - step 6 of 64 - 2500 active elements (0 deactivated)
18:18:32 INFO opendrift:2144: 2026-03-18 19:48:13.534094 - step 7 of 64 - 2500 active elements (0 deactivated)
18:18:34 INFO opendrift:2144: 2026-03-18 20:03:13.534094 - step 8 of 64 - 2500 active elements (0 deactivated)
18:18:37 INFO opendrift:2144: 2026-03-18 20:18:13.534094 - step 9 of 64 - 2500 active elements (0 deactivated)
18:18:38 INFO opendrift:2144: 2026-03-18 20:33:13.534094 - step 10 of 64 - 2500 active elements (0 deactivated)
18:18:39 INFO opendrift:2144: 2026-03-18 20:48:13.534094 - step 11 of 64 - 2500 active elements (0 deactivated)
18:18:41 INFO opendrift:2144: 2026-03-18 21:03:13.534094 - step 12 of 64 - 2500 active elements (0 deactivated)
18:18:44 INFO opendrift:2144: 2026-03-18 21:18:13.534094 - step 13 of 64 - 2500 active elements (0 deactivated)
18:18:45 INFO opendrift:2144: 2026-03-18 21:33:13.534094 - step 14 of 64 - 2500 active elements (0 deactivated)
18:18:46 INFO opendrift:2144: 2026-03-18 21:48:13.534094 - step 15 of 64 - 2500 active elements (0 deactivated)
18:18:48 INFO opendrift:2144: 2026-03-18 22:03:13.534094 - step 16 of 64 - 2500 active elements (0 deactivated)
18:18:51 INFO opendrift:2144: 2026-03-18 22:18:13.534094 - step 17 of 64 - 2500 active elements (0 deactivated)
18:18:52 INFO opendrift:2144: 2026-03-18 22:33:13.534094 - step 18 of 64 - 2500 active elements (0 deactivated)
18:18:53 INFO opendrift:2144: 2026-03-18 22:48:13.534094 - step 19 of 64 - 2500 active elements (0 deactivated)
18:18:55 INFO opendrift:2144: 2026-03-18 23:03:13.534094 - step 20 of 64 - 2500 active elements (0 deactivated)
18:18:58 INFO opendrift:2144: 2026-03-18 23:18:13.534094 - step 21 of 64 - 2500 active elements (0 deactivated)
18:18:59 INFO opendrift:2144: 2026-03-18 23:33:13.534094 - step 22 of 64 - 2500 active elements (0 deactivated)
18:19:01 INFO opendrift:2144: 2026-03-18 23:48:13.534094 - step 23 of 64 - 2500 active elements (0 deactivated)
18:19:03 INFO opendrift:2144: 2026-03-19 00:03:13.534094 - step 24 of 64 - 2500 active elements (0 deactivated)
18:19:06 INFO opendrift:2144: 2026-03-19 00:18:13.534094 - step 25 of 64 - 2500 active elements (0 deactivated)
18:19:07 INFO opendrift:2144: 2026-03-19 00:33:13.534094 - step 26 of 64 - 2500 active elements (0 deactivated)
18:19:09 INFO opendrift:2144: 2026-03-19 00:48:13.534094 - step 27 of 64 - 2500 active elements (0 deactivated)
18:19:10 INFO opendrift:2144: 2026-03-19 01:03:13.534094 - step 28 of 64 - 2500 active elements (0 deactivated)
18:19:13 INFO opendrift:2144: 2026-03-19 01:18:13.534094 - step 29 of 64 - 2500 active elements (0 deactivated)
18:19:14 INFO opendrift:2144: 2026-03-19 01:33:13.534094 - step 30 of 64 - 2500 active elements (0 deactivated)
18:19:16 INFO opendrift:2144: 2026-03-19 01:48:13.534094 - step 31 of 64 - 2500 active elements (0 deactivated)
18:19:17 INFO opendrift:2144: 2026-03-19 02:03:13.534094 - step 32 of 64 - 2500 active elements (0 deactivated)
18:19:20 INFO opendrift:2144: 2026-03-19 02:18:13.534094 - step 33 of 64 - 2500 active elements (0 deactivated)
18:19:21 INFO opendrift:2144: 2026-03-19 02:33:13.534094 - step 34 of 64 - 2500 active elements (0 deactivated)
18:19:23 INFO opendrift:2144: 2026-03-19 02:48:13.534094 - step 35 of 64 - 2500 active elements (0 deactivated)
18:19:24 INFO opendrift:2144: 2026-03-19 03:03:13.534094 - step 36 of 64 - 2500 active elements (0 deactivated)
18:19:27 INFO opendrift:2144: 2026-03-19 03:18:13.534094 - step 37 of 64 - 2500 active elements (0 deactivated)
18:19:28 INFO opendrift:2144: 2026-03-19 03:33:13.534094 - step 38 of 64 - 2500 active elements (0 deactivated)
18:19:30 INFO opendrift:2144: 2026-03-19 03:48:13.534094 - step 39 of 64 - 2500 active elements (0 deactivated)
18:19:31 INFO opendrift:2144: 2026-03-19 04:03:13.534094 - step 40 of 64 - 2500 active elements (0 deactivated)
18:19:34 INFO opendrift:2144: 2026-03-19 04:18:13.534094 - step 41 of 64 - 2500 active elements (0 deactivated)
18:19:35 INFO opendrift:2144: 2026-03-19 04:33:13.534094 - step 42 of 64 - 2500 active elements (0 deactivated)
18:19:37 INFO opendrift:2144: 2026-03-19 04:48:13.534094 - step 43 of 64 - 2500 active elements (0 deactivated)
18:19:38 INFO opendrift:2144: 2026-03-19 05:03:13.534094 - step 44 of 64 - 2500 active elements (0 deactivated)
18:19:41 INFO opendrift:2144: 2026-03-19 05:18:13.534094 - step 45 of 64 - 2500 active elements (0 deactivated)
18:19:42 INFO opendrift:2144: 2026-03-19 05:33:13.534094 - step 46 of 64 - 2500 active elements (0 deactivated)
18:19:44 INFO opendrift:2144: 2026-03-19 05:48:13.534094 - step 47 of 64 - 2500 active elements (0 deactivated)
18:19:45 INFO opendrift:2144: 2026-03-19 06:03:13.534094 - step 48 of 64 - 2500 active elements (0 deactivated)
18:19:49 INFO opendrift:2144: 2026-03-19 06:18:13.534094 - step 49 of 64 - 2500 active elements (0 deactivated)
18:19:51 INFO opendrift:2144: 2026-03-19 06:33:13.534094 - step 50 of 64 - 2500 active elements (0 deactivated)
18:19:52 INFO opendrift:2144: 2026-03-19 06:48:13.534094 - step 51 of 64 - 2500 active elements (0 deactivated)
18:19:53 INFO opendrift:2144: 2026-03-19 07:03:13.534094 - step 52 of 64 - 2500 active elements (0 deactivated)
18:19:56 INFO opendrift:2144: 2026-03-19 07:18:13.534094 - step 53 of 64 - 2500 active elements (0 deactivated)
18:19:58 INFO opendrift:2144: 2026-03-19 07:33:13.534094 - step 54 of 64 - 2500 active elements (0 deactivated)
18:19:59 INFO opendrift:2144: 2026-03-19 07:48:13.534094 - step 55 of 64 - 2500 active elements (0 deactivated)
18:20:01 INFO opendrift:2144: 2026-03-19 08:03:13.534094 - step 56 of 64 - 2500 active elements (0 deactivated)
18:20:03 INFO opendrift:2144: 2026-03-19 08:18:13.534094 - step 57 of 64 - 2500 active elements (0 deactivated)
18:20:05 INFO opendrift:2144: 2026-03-19 08:33:13.534094 - step 58 of 64 - 2500 active elements (0 deactivated)
18:20:06 INFO opendrift:2144: 2026-03-19 08:48:13.534094 - step 59 of 64 - 2500 active elements (0 deactivated)
18:20:08 INFO opendrift:2144: 2026-03-19 09:03:13.534094 - step 60 of 64 - 2500 active elements (0 deactivated)
18:20:11 INFO opendrift:2144: 2026-03-19 09:18:13.534094 - step 61 of 64 - 2500 active elements (0 deactivated)
18:20:12 INFO opendrift:2144: 2026-03-19 09:33:13.534094 - step 62 of 64 - 2500 active elements (0 deactivated)
18:20:13 INFO opendrift:2144: 2026-03-19 09:48:13.534094 - step 63 of 64 - 2500 active elements (0 deactivated)
18:20:15 INFO opendrift:2144: 2026-03-19 10:03:13.534094 - 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:30.7 total
0:00:00.0 preparing
0:00:30.3 reading
0:00:00.3 interpolation
0:00:00.0 interpolation_time
0:00:00.3 rotating vectors
0:00:00.0 masking
--------------------
https://thredds.met.no/thredds/dodsC/cmems/topaz6/dataset-topaz6-arc-15min-3km-be.ncml
0:01:28.0 total
0:00:00.0 preparing
0:01:27.8 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:
2:09.0 total time
8.6 configuration
0.0 preparing main loop
0.0 moving elements to ocean
2:00.4 main loop
0.1 updating elements
0.0 cleaning up
--------------------
===========================
Model: OceanDrift (OpenDrift version 1.14.9)
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:
horizontal_diffusivity
sea_surface_wave_significant_height
sea_surface_wave_stokes_drift_x_velocity
sea_surface_wave_stokes_drift_y_velocity
Discarded readers:
Time:
Start: 2026-03-18 18:18:13.534094 UTC
Present: 2026-03-19 10:18:13.534094 UTC
Calculation steps: 64 * 0:15:00 - total time: 16:00:00
Output steps: 33 * 0:30:00
===========================
18:20:18 WARNING opendrift:2507: Plotting fast. This will make your plots less accurate.
18:20:19 INFO opendrift:4705: Saving animation to /root/project/docs/source/gallery/animations/example_reader_boundary_0.gif...
18:20:41 INFO opendrift:3128: Time to make animation: 0:00:23.806253
o.plot(fast=True)
18:20:41 WARNING opendrift:2507: Plotting fast. This will make your plots less accurate.
(<GeoAxes: title={'center': 'OpenDrift - OceanDrift\n2026-03-18 18:18 to 2026-03-19 10:18 UTC (33 steps)'}>, <Figure size 988.989x1100 with 1 Axes>)
Total running time of the script: (2 minutes 45.286 seconds)