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)
09:44:51 INFO    opendrift:576: OpenDriftSimulation initialised (version 1.14.7 / v1.14.7-21-gb739e9e)
09:44:51 INFO    opendrift.readers:63: Opening file with xr.open_dataset
09:44:52 INFO    opendrift.readers.reader_netCDF_CF_generic:332: Detected dimensions: {'x': 'X', 'y': 'Y', 'z': 'depth', 'time': 'time'}
09:44:52 INFO    opendrift.readers.basereader:176: Variable x_sea_water_velocity will be rotated from eastward_sea_water_velocity
09:44:52 INFO    opendrift.readers.basereader:176: Variable y_sea_water_velocity will be rotated from northward_sea_water_velocity
09:44:52 INFO    opendrift.readers.basereader:176: Variable x_wind will be rotated from eastward_wind
09:44:52 INFO    opendrift.readers.basereader:176: Variable y_wind will be rotated from northward_wind
09:44:52 INFO    opendrift.readers:63: Opening file with xr.open_dataset
09:44:56 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())
09:44:56 INFO    opendrift.models.basemodel.environment:203: Adding a global landmask from GSHHG
09:45:00 INFO    opendrift.models.basemodel.environment:227: Fallback values will be used for the following variables which have no readers:
09:45:00 INFO    opendrift.models.basemodel.environment:230:    sea_surface_wave_significant_height: 0.000000
09:45:00 INFO    opendrift.models.basemodel.environment:230:    sea_surface_wave_stokes_drift_x_velocity: 0.000000
09:45:00 INFO    opendrift.models.basemodel.environment:230:    sea_surface_wave_stokes_drift_y_velocity: 0.000000
09:45:00 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)
09:45:00 INFO    opendrift:1803: Skipping environment variable ocean_vertical_diffusivity because of condition ['drift:vertical_mixing', 'is', False]
09:45:00 INFO    opendrift:1803: Skipping environment variable ocean_mixed_layer_thickness because of condition ['drift:vertical_mixing', 'is', False]
09:45:00 INFO    opendrift:1814: Storing previous values of element property lon because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
09:45:00 INFO    opendrift:1814: Storing previous values of element property lat because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
09:45:00 INFO    opendrift:1822: Storing previous values of environment variable sea_surface_height because of condition ['drift:vertical_advection', 'is', True]
09:45:00 INFO    opendrift:952: Using existing reader for land_binary_mask to move elements to ocean
09:45:00 INFO    opendrift:982: All points are in ocean
09:45:00 INFO    opendrift:2111: 2026-01-09 09:44:56.913433 - step 1 of 64 - 2500 active elements (0 deactivated)
09:45:07 INFO    opendrift:2111: 2026-01-09 09:59:56.913433 - step 2 of 64 - 2500 active elements (0 deactivated)
09:45:08 INFO    opendrift:2111: 2026-01-09 10:14:56.913433 - step 3 of 64 - 2500 active elements (0 deactivated)
09:45:10 INFO    opendrift:2111: 2026-01-09 10:29:56.913433 - step 4 of 64 - 2500 active elements (0 deactivated)
09:45:10 INFO    opendrift:2111: 2026-01-09 10:44:56.913433 - step 5 of 64 - 2500 active elements (0 deactivated)
09:45:11 INFO    opendrift:2111: 2026-01-09 10:59:56.913433 - step 6 of 64 - 2500 active elements (0 deactivated)
09:45:12 INFO    opendrift:2111: 2026-01-09 11:14:56.913433 - step 7 of 64 - 2500 active elements (0 deactivated)
09:45:14 INFO    opendrift:2111: 2026-01-09 11:29:56.913433 - step 8 of 64 - 2500 active elements (0 deactivated)
09:45:15 INFO    opendrift:2111: 2026-01-09 11:44:56.913433 - step 9 of 64 - 2500 active elements (0 deactivated)
09:45:15 INFO    opendrift:2111: 2026-01-09 11:59:56.913433 - step 10 of 64 - 2500 active elements (0 deactivated)
09:45:16 INFO    opendrift:2111: 2026-01-09 12:14:56.913433 - step 11 of 64 - 2500 active elements (0 deactivated)
09:45:18 INFO    opendrift:2111: 2026-01-09 12:29:56.913433 - step 12 of 64 - 2500 active elements (0 deactivated)
09:45:19 INFO    opendrift:2111: 2026-01-09 12:44:56.913433 - step 13 of 64 - 2500 active elements (0 deactivated)
09:45:20 INFO    opendrift:2111: 2026-01-09 12:59:56.913433 - step 14 of 64 - 2500 active elements (0 deactivated)
09:45:20 INFO    opendrift:2111: 2026-01-09 13:14:56.913433 - step 15 of 64 - 2500 active elements (0 deactivated)
09:45:23 INFO    opendrift:2111: 2026-01-09 13:29:56.913433 - step 16 of 64 - 2500 active elements (0 deactivated)
09:45:23 INFO    opendrift:2111: 2026-01-09 13:44:56.913433 - step 17 of 64 - 2500 active elements (0 deactivated)
09:45:24 INFO    opendrift:2111: 2026-01-09 13:59:56.913433 - step 18 of 64 - 2500 active elements (0 deactivated)
09:45:25 INFO    opendrift:2111: 2026-01-09 14:14:56.913433 - step 19 of 64 - 2500 active elements (0 deactivated)
09:45:27 INFO    opendrift:2111: 2026-01-09 14:29:56.913433 - step 20 of 64 - 2500 active elements (0 deactivated)
09:45:28 INFO    opendrift:2111: 2026-01-09 14:44:56.913433 - step 21 of 64 - 2500 active elements (0 deactivated)
09:45:28 INFO    opendrift:2111: 2026-01-09 14:59:56.913433 - step 22 of 64 - 2500 active elements (0 deactivated)
09:45:29 INFO    opendrift:2111: 2026-01-09 15:14:56.913433 - step 23 of 64 - 2500 active elements (0 deactivated)
09:45:32 INFO    opendrift:2111: 2026-01-09 15:29:56.913433 - step 24 of 64 - 2500 active elements (0 deactivated)
09:45:32 INFO    opendrift:2111: 2026-01-09 15:44:56.913433 - step 25 of 64 - 2500 active elements (0 deactivated)
09:45:33 INFO    opendrift:2111: 2026-01-09 15:59:56.913433 - step 26 of 64 - 2500 active elements (0 deactivated)
09:45:34 INFO    opendrift:2111: 2026-01-09 16:14:56.913433 - step 27 of 64 - 2500 active elements (0 deactivated)
09:45:36 INFO    opendrift:2111: 2026-01-09 16:29:56.913433 - step 28 of 64 - 2500 active elements (0 deactivated)
09:45:37 INFO    opendrift:2111: 2026-01-09 16:44:56.913433 - step 29 of 64 - 2500 active elements (0 deactivated)
09:45:37 INFO    opendrift:2111: 2026-01-09 16:59:56.913433 - step 30 of 64 - 2500 active elements (0 deactivated)
09:45:38 INFO    opendrift:2111: 2026-01-09 17:14:56.913433 - step 31 of 64 - 2500 active elements (0 deactivated)
09:45:40 INFO    opendrift:2111: 2026-01-09 17:29:56.913433 - step 32 of 64 - 2500 active elements (0 deactivated)
09:45:41 INFO    opendrift:2111: 2026-01-09 17:44:56.913433 - step 33 of 64 - 2500 active elements (0 deactivated)
09:45:42 INFO    opendrift:2111: 2026-01-09 17:59:56.913433 - step 34 of 64 - 2500 active elements (0 deactivated)
09:45:42 INFO    opendrift:2111: 2026-01-09 18:14:56.913433 - step 35 of 64 - 2500 active elements (0 deactivated)
09:45:45 INFO    opendrift:2111: 2026-01-09 18:29:56.913433 - step 36 of 64 - 2500 active elements (0 deactivated)
09:45:45 INFO    opendrift:2111: 2026-01-09 18:44:56.913433 - step 37 of 64 - 2500 active elements (0 deactivated)
09:45:46 INFO    opendrift:2111: 2026-01-09 18:59:56.913433 - step 38 of 64 - 2500 active elements (0 deactivated)
09:45:47 INFO    opendrift:2111: 2026-01-09 19:14:56.913433 - step 39 of 64 - 2500 active elements (0 deactivated)
09:45:49 INFO    opendrift:2111: 2026-01-09 19:29:56.913433 - step 40 of 64 - 2500 active elements (0 deactivated)
09:45:50 INFO    opendrift:2111: 2026-01-09 19:44:56.913433 - step 41 of 64 - 2500 active elements (0 deactivated)
09:45:51 INFO    opendrift:2111: 2026-01-09 19:59:56.913433 - step 42 of 64 - 2500 active elements (0 deactivated)
09:45:51 INFO    opendrift:2111: 2026-01-09 20:14:56.913433 - step 43 of 64 - 2500 active elements (0 deactivated)
09:45:55 INFO    opendrift:2111: 2026-01-09 20:29:56.913433 - step 44 of 64 - 2500 active elements (0 deactivated)
09:45:55 INFO    opendrift:2111: 2026-01-09 20:44:56.913433 - step 45 of 64 - 2500 active elements (0 deactivated)
09:45:56 INFO    opendrift:2111: 2026-01-09 20:59:56.913433 - step 46 of 64 - 2500 active elements (0 deactivated)
09:45:57 INFO    opendrift:2111: 2026-01-09 21:14:56.913433 - step 47 of 64 - 2500 active elements (0 deactivated)
09:46:00 INFO    opendrift:2111: 2026-01-09 21:29:56.913433 - step 48 of 64 - 2500 active elements (0 deactivated)
09:46:01 INFO    opendrift:2111: 2026-01-09 21:44:56.913433 - step 49 of 64 - 2500 active elements (0 deactivated)
09:46:02 INFO    opendrift:2111: 2026-01-09 21:59:56.913433 - step 50 of 64 - 2500 active elements (0 deactivated)
09:46:03 INFO    opendrift:2111: 2026-01-09 22:14:56.913433 - step 51 of 64 - 2500 active elements (0 deactivated)
09:46:05 INFO    opendrift:2111: 2026-01-09 22:29:56.913433 - step 52 of 64 - 2500 active elements (0 deactivated)
09:46:06 INFO    opendrift:2111: 2026-01-09 22:44:56.913433 - step 53 of 64 - 2500 active elements (0 deactivated)
09:46:07 INFO    opendrift:2111: 2026-01-09 22:59:56.913433 - step 54 of 64 - 2500 active elements (0 deactivated)
09:46:07 INFO    opendrift:2111: 2026-01-09 23:14:56.913433 - step 55 of 64 - 2500 active elements (0 deactivated)
09:46:10 INFO    opendrift:2111: 2026-01-09 23:29:56.913433 - step 56 of 64 - 2500 active elements (0 deactivated)
09:46:11 INFO    opendrift:2111: 2026-01-09 23:44:56.913433 - step 57 of 64 - 2500 active elements (0 deactivated)
09:46:12 INFO    opendrift:2111: 2026-01-09 23:59:56.913433 - step 58 of 64 - 2500 active elements (0 deactivated)
09:46:13 INFO    opendrift:2111: 2026-01-10 00:14:56.913433 - step 59 of 64 - 2500 active elements (0 deactivated)
09:46:15 INFO    opendrift:2111: 2026-01-10 00:29:56.913433 - step 60 of 64 - 2500 active elements (0 deactivated)
09:46:16 INFO    opendrift:2111: 2026-01-10 00:44:56.913433 - step 61 of 64 - 2500 active elements (0 deactivated)
09:46:16 INFO    opendrift:2111: 2026-01-10 00:59:56.913433 - step 62 of 64 - 2500 active elements (0 deactivated)
09:46:17 INFO    opendrift:2111: 2026-01-10 01:14:56.913433 - step 63 of 64 - 2500 active elements (0 deactivated)
09:46:20 INFO    opendrift:2111: 2026-01-10 01:29:56.913433 - step 64 of 64 - 2500 active elements (0 deactivated)
<xarray.Dataset> Size: 7MB
Dimensions:                                   (trajectory: 2500, time: 33)
Coordinates:
  * trajectory                                (trajectory) int64 20kB 0 ... 2499
  * time                                      (time) datetime64[ns] 264B 2026...
Data variables: (12/21)
    status                                    (trajectory, time) float32 330kB ...
    moving                                    (trajectory, time) float32 330kB ...
    age_seconds                               (trajectory, time) float32 330kB ...
    origin_marker                             (trajectory, time) float32 330kB ...
    lon                                       (trajectory, time) float32 330kB ...
    lat                                       (trajectory, time) float32 330kB ...
    ...                                        ...
    upward_sea_water_velocity                 (trajectory, time) float32 330kB ...
    sea_surface_wave_significant_height       (trajectory, time) float32 330kB ...
    sea_surface_wave_stokes_drift_x_velocity  (trajectory, time) float32 330kB ...
    sea_surface_wave_stokes_drift_y_velocity  (trajectory, time) float32 330kB ...
    sea_floor_depth_below_sea_level           (trajectory, time) float32 330kB ...
    land_binary_mask                          (trajectory, time) float32 330kB ...
Attributes: (12/119)
    Conventions:                                                           CF...
    standard_name_vocabulary:                                              CF...
    featureType:                                                           tr...
    title:                                                                 Op...
    summary:                                                               Ou...
    keywords:                                                              tr...
    ...                                                                    ...
    geospatial_lon_units:                                                  de...
    geospatial_lon_resolution:                                             point
    runtime:                                                               0:...
    geospatial_vertical_min:                                               0.0
    geospatial_vertical_max:                                               0.0
    geospatial_vertical_positive:                                          up


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:34.0  total
 0:00:00.0  preparing
 0:00:33.6  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:44.4  total
 0:00:00.0  preparing
 0:00:44.2  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:30.2 total time
    9.9 configuration
    0.0 preparing main loop
      0.0 moving elements to ocean
 1:20.2 main loop
      0.2 updating elements
    0.0 cleaning up
--------------------
===========================
Model:  OceanDrift     (OpenDrift version 1.14.7)
        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: 2026-01-09 09:44:56.913433 UTC
        Present: 2026-01-10 01:44:56.913433 UTC
        Calculation steps: 64 * 0:15:00 - total time: 16:00:00
        Output steps: 33 * 0:30:00
===========================

09:46:21 WARNING opendrift:2473: Plotting fast. This will make your plots less accurate.
09:46:22 INFO    opendrift:4660: Saving animation to /root/project/docs/source/gallery/animations/example_reader_boundary_0.gif...
09:46:44 INFO    opendrift:3094: Time to make animation: 0:00:23.227386
../_images/example_reader_boundary_0.gif
o.plot(fast=True)
OpenDrift - OceanDrift 2026-01-09 09:44 to 2026-01-10 01:44 UTC (33 steps)
09:46:44 WARNING opendrift:2473: Plotting fast. This will make your plots less accurate.

(<GeoAxes: title={'center': 'OpenDrift - OceanDrift\n2026-01-09 09:44 to 2026-01-10 01:44 UTC (33 steps)'}>, <Figure size 930.151x1100 with 1 Axes>)

Total running time of the script: (2 minutes 7.437 seconds)

Gallery generated by Sphinx-Gallery