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).
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/sea/norkyst800m/1h/aggregate_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)
17:16:22 INFO opendrift:513: OpenDriftSimulation initialised (version 1.14.2 / v1.14.2-88-gf09b7bd)
17:16:22 INFO opendrift.readers:61: Opening file with xr.open_dataset
17:16:23 INFO opendrift.readers.reader_netCDF_CF_generic:332: Detected dimensions: {'x': 'X', 'y': 'Y', 'z': 'depth', 'time': 'time'}
17:16:23 INFO opendrift.readers:61: Opening file with xr.open_dataset
17:16:25 INFO opendrift.readers.reader_netCDF_CF_generic:332: Detected dimensions: {'x': 'x', 'y': 'y', 'time': 'time'}
Seeding some particles
lons = np.linspace(10.2, 12.2, 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=reader_topaz.start_time)
17:16:25 INFO opendrift.models.basemodel.environment:206: Adding a global landmask from GSHHG
17:16:30 INFO opendrift.models.basemodel.environment:229: Fallback values will be used for the following variables which have no readers:
17:16:30 INFO opendrift.models.basemodel.environment:232: ocean_vertical_diffusivity: 0.000000
17:16:30 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_significant_height: 0.000000
17:16:30 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_stokes_drift_x_velocity: 0.000000
17:16:30 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_stokes_drift_y_velocity: 0.000000
17:16:30 INFO opendrift.models.basemodel.environment:232: ocean_mixed_layer_thickness: 50.000000
Running model
o.run(steps=16*4, time_step=900, time_step_output=1800)
17:16:30 INFO opendrift:1732: Skipping environment variable ocean_vertical_diffusivity because of condition ['drift:vertical_mixing', 'is', False]
17:16:30 INFO opendrift:1732: Skipping environment variable ocean_mixed_layer_thickness because of condition ['drift:vertical_mixing', 'is', False]
17:16:30 INFO opendrift:1743: Storing previous values of element property lon because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
17:16:30 INFO opendrift:1743: Storing previous values of element property lat because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
17:16:30 INFO opendrift:1751: Storing previous values of environment variable sea_surface_height because of condition ['drift:vertical_advection', 'is', True]
17:16:30 INFO opendrift:899: Using existing reader for land_binary_mask
17:16:30 INFO opendrift:928: All points are in ocean
17:16:30 INFO opendrift:2035: 2023-01-01 00:00:00 - step 1 of 64 - 2500 active elements (0 deactivated)
17:16:32 INFO opendrift:2035: 2023-01-01 00:15:00 - step 2 of 64 - 2500 active elements (0 deactivated)
17:16:34 INFO opendrift:2035: 2023-01-01 00:30:00 - step 3 of 64 - 2500 active elements (0 deactivated)
17:16:35 INFO opendrift:2035: 2023-01-01 00:45:00 - step 4 of 64 - 2500 active elements (0 deactivated)
17:16:35 INFO opendrift:2035: 2023-01-01 01:00:00 - step 5 of 64 - 2500 active elements (0 deactivated)
17:16:36 INFO opendrift:2035: 2023-01-01 01:15:00 - step 6 of 64 - 2500 active elements (0 deactivated)
17:16:38 INFO opendrift:2035: 2023-01-01 01:30:00 - step 7 of 64 - 2500 active elements (0 deactivated)
17:16:39 INFO opendrift:2035: 2023-01-01 01:45:00 - step 8 of 64 - 2500 active elements (0 deactivated)
17:16:40 INFO opendrift:2035: 2023-01-01 02:00:00 - step 9 of 64 - 2500 active elements (0 deactivated)
17:16:40 INFO opendrift:2035: 2023-01-01 02:15:00 - step 10 of 64 - 2500 active elements (0 deactivated)
17:16:43 INFO opendrift:2035: 2023-01-01 02:30:00 - step 11 of 64 - 2500 active elements (0 deactivated)
17:16:43 INFO opendrift:2035: 2023-01-01 02:45:00 - step 12 of 64 - 2500 active elements (0 deactivated)
17:16:44 INFO opendrift:2035: 2023-01-01 03:00:00 - step 13 of 64 - 2500 active elements (0 deactivated)
17:16:45 INFO opendrift:2035: 2023-01-01 03:15:00 - step 14 of 64 - 2500 active elements (0 deactivated)
17:16:47 INFO opendrift:2035: 2023-01-01 03:30:00 - step 15 of 64 - 2500 active elements (0 deactivated)
17:16:48 INFO opendrift:2035: 2023-01-01 03:45:00 - step 16 of 64 - 2500 active elements (0 deactivated)
17:16:48 INFO opendrift:2035: 2023-01-01 04:00:00 - step 17 of 64 - 2500 active elements (0 deactivated)
17:16:49 INFO opendrift:2035: 2023-01-01 04:15:00 - step 18 of 64 - 2500 active elements (0 deactivated)
17:16:51 INFO opendrift:2035: 2023-01-01 04:30:00 - step 19 of 64 - 2500 active elements (0 deactivated)
17:16:52 INFO opendrift:2035: 2023-01-01 04:45:00 - step 20 of 64 - 2500 active elements (0 deactivated)
17:16:53 INFO opendrift:2035: 2023-01-01 05:00:00 - step 21 of 64 - 2500 active elements (0 deactivated)
17:16:53 INFO opendrift:2035: 2023-01-01 05:15:00 - step 22 of 64 - 2500 active elements (0 deactivated)
17:16:56 INFO opendrift:2035: 2023-01-01 05:30:00 - step 23 of 64 - 2500 active elements (0 deactivated)
17:16:57 INFO opendrift:2035: 2023-01-01 05:45:00 - step 24 of 64 - 2500 active elements (0 deactivated)
17:16:57 INFO opendrift:2035: 2023-01-01 06:00:00 - step 25 of 64 - 2500 active elements (0 deactivated)
17:16:58 INFO opendrift:2035: 2023-01-01 06:15:00 - step 26 of 64 - 2500 active elements (0 deactivated)
17:17:00 INFO opendrift:2035: 2023-01-01 06:30:00 - step 27 of 64 - 2500 active elements (0 deactivated)
17:17:01 INFO opendrift:2035: 2023-01-01 06:45:00 - step 28 of 64 - 2500 active elements (0 deactivated)
17:17:02 INFO opendrift:2035: 2023-01-01 07:00:00 - step 29 of 64 - 2500 active elements (0 deactivated)
17:17:02 INFO opendrift:2035: 2023-01-01 07:15:00 - step 30 of 64 - 2500 active elements (0 deactivated)
17:17:04 INFO opendrift:2035: 2023-01-01 07:30:00 - step 31 of 64 - 2500 active elements (0 deactivated)
17:17:05 INFO opendrift:2035: 2023-01-01 07:45:00 - step 32 of 64 - 2500 active elements (0 deactivated)
17:17:06 INFO opendrift:2035: 2023-01-01 08:00:00 - step 33 of 64 - 2500 active elements (0 deactivated)
17:17:07 INFO opendrift:2035: 2023-01-01 08:15:00 - step 34 of 64 - 2500 active elements (0 deactivated)
17:17:09 INFO opendrift:2035: 2023-01-01 08:30:00 - step 35 of 64 - 2500 active elements (0 deactivated)
17:17:10 INFO opendrift:2035: 2023-01-01 08:45:00 - step 36 of 64 - 2500 active elements (0 deactivated)
17:17:10 INFO opendrift:2035: 2023-01-01 09:00:00 - step 37 of 64 - 2500 active elements (0 deactivated)
17:17:11 INFO opendrift:2035: 2023-01-01 09:15:00 - step 38 of 64 - 2500 active elements (0 deactivated)
17:17:13 INFO opendrift:2035: 2023-01-01 09:30:00 - step 39 of 64 - 2500 active elements (0 deactivated)
17:17:14 INFO opendrift:2035: 2023-01-01 09:45:00 - step 40 of 64 - 2500 active elements (0 deactivated)
17:17:15 INFO opendrift:2035: 2023-01-01 10:00:00 - step 41 of 64 - 2500 active elements (0 deactivated)
17:17:15 INFO opendrift:2035: 2023-01-01 10:15:00 - step 42 of 64 - 2500 active elements (0 deactivated)
17:17:18 INFO opendrift:2035: 2023-01-01 10:30:00 - step 43 of 64 - 2500 active elements (0 deactivated)
17:17:18 INFO opendrift:2035: 2023-01-01 10:45:00 - step 44 of 64 - 2500 active elements (0 deactivated)
17:17:19 INFO opendrift:2035: 2023-01-01 11:00:00 - step 45 of 64 - 2500 active elements (0 deactivated)
17:17:20 INFO opendrift:2035: 2023-01-01 11:15:00 - step 46 of 64 - 2500 active elements (0 deactivated)
17:17:22 INFO opendrift:2035: 2023-01-01 11:30:00 - step 47 of 64 - 2500 active elements (0 deactivated)
17:17:22 INFO opendrift:2035: 2023-01-01 11:45:00 - step 48 of 64 - 2500 active elements (0 deactivated)
17:17:23 INFO opendrift:2035: 2023-01-01 12:00:00 - step 49 of 64 - 2500 active elements (0 deactivated)
17:17:24 INFO opendrift:2035: 2023-01-01 12:15:00 - step 50 of 64 - 2500 active elements (0 deactivated)
17:17:27 INFO opendrift:2035: 2023-01-01 12:30:00 - step 51 of 64 - 2500 active elements (0 deactivated)
17:17:27 INFO opendrift:2035: 2023-01-01 12:45:00 - step 52 of 64 - 2500 active elements (0 deactivated)
17:17:28 INFO opendrift:2035: 2023-01-01 13:00:00 - step 53 of 64 - 2500 active elements (0 deactivated)
17:17:29 INFO opendrift:2035: 2023-01-01 13:15:00 - step 54 of 64 - 2500 active elements (0 deactivated)
17:17:31 INFO opendrift:2035: 2023-01-01 13:30:00 - step 55 of 64 - 2500 active elements (0 deactivated)
17:17:32 INFO opendrift:2035: 2023-01-01 13:45:00 - step 56 of 64 - 2500 active elements (0 deactivated)
17:17:32 INFO opendrift:2035: 2023-01-01 14:00:00 - step 57 of 64 - 2500 active elements (0 deactivated)
17:17:33 INFO opendrift:2035: 2023-01-01 14:15:00 - step 58 of 64 - 2500 active elements (0 deactivated)
17:17:35 INFO opendrift:2035: 2023-01-01 14:30:00 - step 59 of 64 - 2500 active elements (0 deactivated)
17:17:36 INFO opendrift:2035: 2023-01-01 14:45:00 - step 60 of 64 - 2500 active elements (0 deactivated)
17:17:37 INFO opendrift:2035: 2023-01-01 15:00:00 - step 61 of 64 - 2500 active elements (0 deactivated)
17:17:37 INFO opendrift:2035: 2023-01-01 15:15:00 - step 62 of 64 - 2500 active elements (0 deactivated)
17:17:40 INFO opendrift:2035: 2023-01-01 15:30:00 - step 63 of 64 - 2500 active elements (0 deactivated)
17:17:41 INFO opendrift:2035: 2023-01-01 15:45:00 - 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/sea/norkyst800m/1h/aggregate_be
0:00:28.4 total
0:00:00.0 preparing
0:00:27.8 reading
0:00:00.5 interpolation
0:00:00.0 interpolation_time
0:00:00.5 rotating vectors
0:00:00.0 masking
--------------------
https://thredds.met.no/thredds/dodsC/cmems/topaz6/dataset-topaz6-arc-15min-3km-be.ncml
0:00:40.8 total
0:00:00.0 preparing
0:00:40.7 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:19.6 total time
8.1 configuration
0.0 preparing main loop
0.0 moving elements to ocean
1:11.4 main loop
0.2 updating elements
0.0 cleaning up
--------------------
===========================
Model: OceanDrift (OpenDrift version 1.14.2)
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/sea/norkyst800m/1h/aggregate_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/sea/norkyst800m/1h/aggregate_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: 2023-01-01 00:00:00 UTC
Present: 2023-01-01 16:00:00 UTC
Calculation steps: 64 * 0:15:00 - total time: 16:00:00
Output steps: 33 * 0:30:00
===========================
17:17:41 WARNING opendrift:2391: Plotting fast. This will make your plots less accurate.
17:17:43 INFO opendrift:4553: Saving animation to /root/project/docs/source/gallery/animations/example_reader_boundary_0.gif...
17:18:09 INFO opendrift:2994: Time to make animation: 0:00:27.774197

o.plot(fast=True)

17:18:09 WARNING opendrift:2391: Plotting fast. This will make your plots less accurate.
(<GeoAxes: title={'center': 'OpenDrift - OceanDrift\n2023-01-01 00:00 to 2023-01-01 16:00 UTC (33 steps)'}>, <Figure size 867.688x1100 with 1 Axes>)
Total running time of the script: (2 minutes 3.887 seconds)