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)
11:09:07 INFO opendrift:569: OpenDriftSimulation initialised (version 1.14.4 / v1.14.4-13-g6c46a55)
11:09:07 INFO opendrift.readers:63: Opening file with xr.open_dataset
11:09:08 INFO opendrift.readers.reader_netCDF_CF_generic:332: Detected dimensions: {'x': 'X', 'y': 'Y', 'z': 'depth', 'time': 'time'}
11:09:08 INFO opendrift.readers.basereader:176: Variable x_sea_water_velocity will be rotated from eastward_sea_water_velocity
11:09:08 INFO opendrift.readers.basereader:176: Variable y_sea_water_velocity will be rotated from northward_sea_water_velocity
11:09:08 INFO opendrift.readers.basereader:176: Variable x_wind will be rotated from eastward_wind
11:09:08 INFO opendrift.readers.basereader:176: Variable y_wind will be rotated from northward_wind
11:09:08 INFO opendrift.readers:63: Opening file with xr.open_dataset
11:09:12 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())
11:09:12 INFO opendrift.models.basemodel.environment:203: Adding a global landmask from GSHHG
11:09:16 INFO opendrift.models.basemodel.environment:227: Fallback values will be used for the following variables which have no readers:
11:09:16 INFO opendrift.models.basemodel.environment:230: sea_surface_wave_significant_height: 0.000000
11:09:16 INFO opendrift.models.basemodel.environment:230: sea_surface_wave_stokes_drift_x_velocity: 0.000000
11:09:16 INFO opendrift.models.basemodel.environment:230: sea_surface_wave_stokes_drift_y_velocity: 0.000000
11:09:16 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)
11:09:16 INFO opendrift:1787: Skipping environment variable ocean_vertical_diffusivity because of condition ['drift:vertical_mixing', 'is', False]
11:09:16 INFO opendrift:1787: Skipping environment variable ocean_mixed_layer_thickness because of condition ['drift:vertical_mixing', 'is', False]
11:09:16 INFO opendrift:1798: Storing previous values of element property lon because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
11:09:16 INFO opendrift:1798: Storing previous values of element property lat because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
11:09:16 INFO opendrift:1806: Storing previous values of environment variable sea_surface_height because of condition ['drift:vertical_advection', 'is', True]
11:09:16 INFO opendrift:945: Using existing reader for land_binary_mask to move elements to ocean
11:09:16 INFO opendrift:975: All points are in ocean
11:09:16 INFO opendrift:2094: 2025-10-24 11:09:12.262903 - step 1 of 64 - 2500 active elements (0 deactivated)
11:09:20 INFO opendrift:2094: 2025-10-24 11:24:12.262903 - step 2 of 64 - 2500 active elements (0 deactivated)
11:09:21 INFO opendrift:2094: 2025-10-24 11:39:12.262903 - step 3 of 64 - 2500 active elements (0 deactivated)
11:09:21 INFO opendrift:2094: 2025-10-24 11:54:12.262903 - step 4 of 64 - 2500 active elements (0 deactivated)
11:09:22 INFO opendrift:2094: 2025-10-24 12:09:12.262903 - step 5 of 64 - 2500 active elements (0 deactivated)
11:09:24 INFO opendrift:2094: 2025-10-24 12:24:12.262903 - step 6 of 64 - 2500 active elements (0 deactivated)
11:09:25 INFO opendrift:2094: 2025-10-24 12:39:12.262903 - step 7 of 64 - 2500 active elements (0 deactivated)
11:09:26 INFO opendrift:2094: 2025-10-24 12:54:12.262903 - step 8 of 64 - 2500 active elements (0 deactivated)
11:09:26 INFO opendrift:2094: 2025-10-24 13:09:12.262903 - step 9 of 64 - 2500 active elements (0 deactivated)
11:09:29 INFO opendrift:2094: 2025-10-24 13:24:12.262903 - step 10 of 64 - 2500 active elements (0 deactivated)
11:09:29 INFO opendrift:2094: 2025-10-24 13:39:12.262903 - step 11 of 64 - 2500 active elements (0 deactivated)
11:09:30 INFO opendrift:2094: 2025-10-24 13:54:12.262903 - step 12 of 64 - 2500 active elements (0 deactivated)
11:09:31 INFO opendrift:2094: 2025-10-24 14:09:12.262903 - step 13 of 64 - 2500 active elements (0 deactivated)
11:09:33 INFO opendrift:2094: 2025-10-24 14:24:12.262903 - step 14 of 64 - 2500 active elements (0 deactivated)
11:09:34 INFO opendrift:2094: 2025-10-24 14:39:12.262903 - step 15 of 64 - 2500 active elements (0 deactivated)
11:09:34 INFO opendrift:2094: 2025-10-24 14:54:12.262903 - step 16 of 64 - 2500 active elements (0 deactivated)
11:09:35 INFO opendrift:2094: 2025-10-24 15:09:12.262903 - step 17 of 64 - 2500 active elements (0 deactivated)
11:09:37 INFO opendrift:2094: 2025-10-24 15:24:12.262903 - step 18 of 64 - 2500 active elements (0 deactivated)
11:09:38 INFO opendrift:2094: 2025-10-24 15:39:12.262903 - step 19 of 64 - 2500 active elements (0 deactivated)
11:09:39 INFO opendrift:2094: 2025-10-24 15:54:12.262903 - step 20 of 64 - 2500 active elements (0 deactivated)
11:09:39 INFO opendrift:2094: 2025-10-24 16:09:12.262903 - step 21 of 64 - 2500 active elements (0 deactivated)
11:09:42 INFO opendrift:2094: 2025-10-24 16:24:12.262903 - step 22 of 64 - 2500 active elements (0 deactivated)
11:09:42 INFO opendrift:2094: 2025-10-24 16:39:12.262903 - step 23 of 64 - 2500 active elements (0 deactivated)
11:09:43 INFO opendrift:2094: 2025-10-24 16:54:12.262903 - step 24 of 64 - 2500 active elements (0 deactivated)
11:09:44 INFO opendrift:2094: 2025-10-24 17:09:12.262903 - step 25 of 64 - 2500 active elements (0 deactivated)
11:09:46 INFO opendrift:2094: 2025-10-24 17:24:12.262903 - step 26 of 64 - 2500 active elements (0 deactivated)
11:09:47 INFO opendrift:2094: 2025-10-24 17:39:12.262903 - step 27 of 64 - 2500 active elements (0 deactivated)
11:09:48 INFO opendrift:2094: 2025-10-24 17:54:12.262903 - step 28 of 64 - 2500 active elements (0 deactivated)
11:09:49 INFO opendrift:2094: 2025-10-24 18:09:12.262903 - step 29 of 64 - 2500 active elements (0 deactivated)
11:09:51 INFO opendrift:2094: 2025-10-24 18:24:12.262903 - step 30 of 64 - 2500 active elements (0 deactivated)
11:09:52 INFO opendrift:2094: 2025-10-24 18:39:12.262903 - step 31 of 64 - 2500 active elements (0 deactivated)
11:09:52 INFO opendrift:2094: 2025-10-24 18:54:12.262903 - step 32 of 64 - 2500 active elements (0 deactivated)
11:09:53 INFO opendrift:2094: 2025-10-24 19:09:12.262903 - step 33 of 64 - 2500 active elements (0 deactivated)
11:09:55 INFO opendrift:2094: 2025-10-24 19:24:12.262903 - step 34 of 64 - 2500 active elements (0 deactivated)
11:09:56 INFO opendrift:2094: 2025-10-24 19:39:12.262903 - step 35 of 64 - 2500 active elements (0 deactivated)
11:09:57 INFO opendrift:2094: 2025-10-24 19:54:12.262903 - step 36 of 64 - 2500 active elements (0 deactivated)
11:09:57 INFO opendrift:2094: 2025-10-24 20:09:12.262903 - step 37 of 64 - 2500 active elements (0 deactivated)
11:10:00 INFO opendrift:2094: 2025-10-24 20:24:12.262903 - step 38 of 64 - 2500 active elements (0 deactivated)
11:10:01 INFO opendrift:2094: 2025-10-24 20:39:12.262903 - step 39 of 64 - 2500 active elements (0 deactivated)
11:10:01 INFO opendrift:2094: 2025-10-24 20:54:12.262903 - step 40 of 64 - 2500 active elements (0 deactivated)
11:10:02 INFO opendrift:2094: 2025-10-24 21:09:12.262903 - step 41 of 64 - 2500 active elements (0 deactivated)
11:10:05 INFO opendrift:2094: 2025-10-24 21:24:12.262903 - step 42 of 64 - 2500 active elements (0 deactivated)
11:10:06 INFO opendrift:2094: 2025-10-24 21:39:12.262903 - step 43 of 64 - 2500 active elements (0 deactivated)
11:10:06 INFO opendrift:2094: 2025-10-24 21:54:12.262903 - step 44 of 64 - 2500 active elements (0 deactivated)
11:10:07 INFO opendrift:2094: 2025-10-24 22:09:12.262903 - step 45 of 64 - 2500 active elements (0 deactivated)
11:10:10 INFO opendrift:2094: 2025-10-24 22:24:12.262903 - step 46 of 64 - 2500 active elements (0 deactivated)
11:10:10 INFO opendrift:2094: 2025-10-24 22:39:12.262903 - step 47 of 64 - 2500 active elements (0 deactivated)
11:10:11 INFO opendrift:2094: 2025-10-24 22:54:12.262903 - step 48 of 64 - 2500 active elements (0 deactivated)
11:10:12 INFO opendrift:2094: 2025-10-24 23:09:12.262903 - step 49 of 64 - 2500 active elements (0 deactivated)
11:10:15 INFO opendrift:2094: 2025-10-24 23:24:12.262903 - step 50 of 64 - 2500 active elements (0 deactivated)
11:10:16 INFO opendrift:2094: 2025-10-24 23:39:12.262903 - step 51 of 64 - 2500 active elements (0 deactivated)
11:10:16 INFO opendrift:2094: 2025-10-24 23:54:12.262903 - step 52 of 64 - 2500 active elements (0 deactivated)
11:10:17 INFO opendrift:2094: 2025-10-25 00:09:12.262903 - step 53 of 64 - 2500 active elements (0 deactivated)
11:10:20 INFO opendrift:2094: 2025-10-25 00:24:12.262903 - step 54 of 64 - 2500 active elements (0 deactivated)
11:10:20 INFO opendrift:2094: 2025-10-25 00:39:12.262903 - step 55 of 64 - 2500 active elements (0 deactivated)
11:10:21 INFO opendrift:2094: 2025-10-25 00:54:12.262903 - step 56 of 64 - 2500 active elements (0 deactivated)
11:10:22 INFO opendrift:2094: 2025-10-25 01:09:12.262903 - step 57 of 64 - 2500 active elements (0 deactivated)
11:10:24 INFO opendrift:2094: 2025-10-25 01:24:12.262903 - step 58 of 64 - 2500 active elements (0 deactivated)
11:10:25 INFO opendrift:2094: 2025-10-25 01:39:12.262903 - step 59 of 64 - 2500 active elements (0 deactivated)
11:10:26 INFO opendrift:2094: 2025-10-25 01:54:12.262903 - step 60 of 64 - 2500 active elements (0 deactivated)
11:10:27 INFO opendrift:2094: 2025-10-25 02:09:12.262903 - step 61 of 64 - 2500 active elements (0 deactivated)
11:10:29 INFO opendrift:2094: 2025-10-25 02:24:12.262903 - step 62 of 64 - 2500 active elements (0 deactivated)
11:10:30 INFO opendrift:2094: 2025-10-25 02:39:12.262903 - step 63 of 64 - 2500 active elements (0 deactivated)
11:10:31 INFO opendrift:2094: 2025-10-25 02:54:12.262903 - 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.4 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:00:43.7 total
0:00:00.0 preparing
0:00:43.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:24.5 total time
8.5 configuration
0.0 preparing main loop
0.0 moving elements to ocean
1:15.9 main loop
0.1 updating elements
0.0 cleaning up
--------------------
===========================
Model: OceanDrift (OpenDrift version 1.14.4)
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-10-24 11:09:12.262903 UTC
Present: 2025-10-25 03:09:12.262903 UTC
Calculation steps: 64 * 0:15:00 - total time: 16:00:00
Output steps: 33 * 0:30:00
===========================
11:10:32 WARNING opendrift:2453: Plotting fast. This will make your plots less accurate.
11:10:33 INFO opendrift:4623: Saving animation to /root/project/docs/source/gallery/animations/example_reader_boundary_0.gif...
11:10:57 INFO opendrift:3064: Time to make animation: 0:00:24.887198
o.plot(fast=True)
11:10:57 WARNING opendrift:2453: Plotting fast. This will make your plots less accurate.
(<GeoAxes: title={'center': 'OpenDrift - OceanDrift\n2025-10-24 11:09 to 2025-10-25 03:09 UTC (33 steps)'}>, <Figure size 945.907x1100 with 1 Axes>)
Total running time of the script: (2 minutes 1.615 seconds)