Note
Go to the end to download the full example code.
No stranding
import numpy as np
from opendrift import test_data_folder as tdf
from opendrift.readers import reader_netCDF_CF_generic
from opendrift.readers import reader_ROMS_native
from opendrift.models.oceandrift import OceanDrift
o = OceanDrift(loglevel=20) # Set loglevel to 0 for debug information
o.set_config('drift:max_speed', 3)
# This example works better using hourly input from Thredds than the daily data from test folder
reader_current = reader_netCDF_CF_generic.Reader('https://thredds.met.no/thredds/dodsC/cmems/topaz6/dataset-topaz6-arc-15min-3km-be.ncml')
#reader_current = reader_ROMS_native.Reader(tdf +
# '2Feb2016_Nordic_sigma_3d/Nordic-4km_SLEVELS_avg_00_subset2Feb2016.nc')
o.add_reader([reader_current])
o.set_config('general:coastline_action', 'previous')
15:54:55 INFO opendrift:513: OpenDriftSimulation initialised (version 1.14.2 / v1.14.2-82-g86a40e4)
15:54:55 INFO opendrift.readers:61: Opening file with xr.open_dataset
15:54:57 INFO opendrift.readers.reader_netCDF_CF_generic:332: Detected dimensions: {'x': 'x', 'y': 'y', 'time': 'time'}
Seeding elements on a grid
lons = np.linspace(12, 14.5, 30)
lats = np.linspace(67.5, 68.5, 30)
lons, lats = np.meshgrid(lons, lats)
lon = lons.ravel()
lat = lats.ravel()
time = reader_current.start_time
o.seed_elements(lon, lat, radius=0, number=30*30, time=time)
o.run(steps=24*2, time_step=3600)
15:54:57 INFO opendrift.models.basemodel.environment:206: Adding a global landmask from GSHHG
15:55:01 INFO opendrift.models.basemodel.environment:229: Fallback values will be used for the following variables which have no readers:
15:55:01 INFO opendrift.models.basemodel.environment:232: x_wind: 0.000000
15:55:01 INFO opendrift.models.basemodel.environment:232: y_wind: 0.000000
15:55:01 INFO opendrift.models.basemodel.environment:232: upward_sea_water_velocity: 0.000000
15:55:01 INFO opendrift.models.basemodel.environment:232: ocean_vertical_diffusivity: 0.000000
15:55:01 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_significant_height: 0.000000
15:55:01 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_stokes_drift_x_velocity: 0.000000
15:55:01 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_stokes_drift_y_velocity: 0.000000
15:55:01 INFO opendrift.models.basemodel.environment:232: ocean_mixed_layer_thickness: 50.000000
15:55:01 INFO opendrift:1722: Skipping environment variable ocean_vertical_diffusivity because of condition ['drift:vertical_mixing', 'is', False]
15:55:01 INFO opendrift:1722: Skipping environment variable ocean_mixed_layer_thickness because of condition ['drift:vertical_mixing', 'is', False]
15:55:01 INFO opendrift:1732: Storing previous values of element property lon because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
15:55:01 INFO opendrift:1732: Storing previous values of element property lat because of condition (('general:coastline_action', 'in', ['stranding', 'previous']), 'or', ('general:seafloor_action', 'in', ['previous']))
15:55:01 INFO opendrift:889: Using existing reader for land_binary_mask
15:55:03 INFO opendrift:920: Moving 81 out of 900 points from land to water
15:55:03 INFO opendrift:2015: 2023-01-01 00:00:00 - step 1 of 48 - 900 active elements (0 deactivated)
15:55:04 INFO opendrift:2015: 2023-01-01 01:00:00 - step 2 of 48 - 900 active elements (0 deactivated)
15:55:05 INFO opendrift:2015: 2023-01-01 02:00:00 - step 3 of 48 - 900 active elements (0 deactivated)
15:55:05 INFO opendrift:2015: 2023-01-01 03:00:00 - step 4 of 48 - 900 active elements (0 deactivated)
15:55:06 INFO opendrift:2015: 2023-01-01 04:00:00 - step 5 of 48 - 900 active elements (0 deactivated)
15:55:07 INFO opendrift:2015: 2023-01-01 05:00:00 - step 6 of 48 - 900 active elements (0 deactivated)
15:55:08 INFO opendrift:2015: 2023-01-01 06:00:00 - step 7 of 48 - 900 active elements (0 deactivated)
15:55:08 INFO opendrift:2015: 2023-01-01 07:00:00 - step 8 of 48 - 900 active elements (0 deactivated)
15:55:09 INFO opendrift:2015: 2023-01-01 08:00:00 - step 9 of 48 - 900 active elements (0 deactivated)
15:55:10 INFO opendrift:2015: 2023-01-01 09:00:00 - step 10 of 48 - 900 active elements (0 deactivated)
15:55:11 INFO opendrift:2015: 2023-01-01 10:00:00 - step 11 of 48 - 900 active elements (0 deactivated)
15:55:11 INFO opendrift:2015: 2023-01-01 11:00:00 - step 12 of 48 - 900 active elements (0 deactivated)
15:55:12 INFO opendrift:2015: 2023-01-01 12:00:00 - step 13 of 48 - 900 active elements (0 deactivated)
15:55:13 INFO opendrift:2015: 2023-01-01 13:00:00 - step 14 of 48 - 900 active elements (0 deactivated)
15:55:14 INFO opendrift:2015: 2023-01-01 14:00:00 - step 15 of 48 - 900 active elements (0 deactivated)
15:55:14 INFO opendrift:2015: 2023-01-01 15:00:00 - step 16 of 48 - 900 active elements (0 deactivated)
15:55:15 INFO opendrift:2015: 2023-01-01 16:00:00 - step 17 of 48 - 900 active elements (0 deactivated)
15:55:16 INFO opendrift:2015: 2023-01-01 17:00:00 - step 18 of 48 - 900 active elements (0 deactivated)
15:55:17 INFO opendrift:2015: 2023-01-01 18:00:00 - step 19 of 48 - 900 active elements (0 deactivated)
15:55:17 INFO opendrift:2015: 2023-01-01 19:00:00 - step 20 of 48 - 900 active elements (0 deactivated)
15:55:18 INFO opendrift:2015: 2023-01-01 20:00:00 - step 21 of 48 - 900 active elements (0 deactivated)
15:55:19 INFO opendrift:2015: 2023-01-01 21:00:00 - step 22 of 48 - 900 active elements (0 deactivated)
15:55:20 INFO opendrift:2015: 2023-01-01 22:00:00 - step 23 of 48 - 900 active elements (0 deactivated)
15:55:21 INFO opendrift:2015: 2023-01-01 23:00:00 - step 24 of 48 - 900 active elements (0 deactivated)
15:55:21 INFO opendrift:2015: 2023-01-02 00:00:00 - step 25 of 48 - 900 active elements (0 deactivated)
15:55:22 INFO opendrift:2015: 2023-01-02 01:00:00 - step 26 of 48 - 900 active elements (0 deactivated)
15:55:23 INFO opendrift:2015: 2023-01-02 02:00:00 - step 27 of 48 - 900 active elements (0 deactivated)
15:55:24 INFO opendrift:2015: 2023-01-02 03:00:00 - step 28 of 48 - 900 active elements (0 deactivated)
15:55:25 INFO opendrift:2015: 2023-01-02 04:00:00 - step 29 of 48 - 900 active elements (0 deactivated)
15:55:25 INFO opendrift:2015: 2023-01-02 05:00:00 - step 30 of 48 - 900 active elements (0 deactivated)
15:55:26 INFO opendrift:2015: 2023-01-02 06:00:00 - step 31 of 48 - 900 active elements (0 deactivated)
15:55:27 INFO opendrift:2015: 2023-01-02 07:00:00 - step 32 of 48 - 900 active elements (0 deactivated)
15:55:28 INFO opendrift:2015: 2023-01-02 08:00:00 - step 33 of 48 - 900 active elements (0 deactivated)
15:55:28 INFO opendrift:2015: 2023-01-02 09:00:00 - step 34 of 48 - 900 active elements (0 deactivated)
15:55:29 INFO opendrift:2015: 2023-01-02 10:00:00 - step 35 of 48 - 900 active elements (0 deactivated)
15:55:30 INFO opendrift:2015: 2023-01-02 11:00:00 - step 36 of 48 - 900 active elements (0 deactivated)
15:55:30 INFO opendrift:2015: 2023-01-02 12:00:00 - step 37 of 48 - 900 active elements (0 deactivated)
15:55:31 INFO opendrift:2015: 2023-01-02 13:00:00 - step 38 of 48 - 900 active elements (0 deactivated)
15:55:32 INFO opendrift:2015: 2023-01-02 14:00:00 - step 39 of 48 - 900 active elements (0 deactivated)
15:55:33 INFO opendrift:2015: 2023-01-02 15:00:00 - step 40 of 48 - 900 active elements (0 deactivated)
15:55:34 INFO opendrift:2015: 2023-01-02 16:00:00 - step 41 of 48 - 900 active elements (0 deactivated)
15:55:34 INFO opendrift:2015: 2023-01-02 17:00:00 - step 42 of 48 - 900 active elements (0 deactivated)
15:55:35 INFO opendrift:2015: 2023-01-02 18:00:00 - step 43 of 48 - 900 active elements (0 deactivated)
15:55:36 INFO opendrift:2015: 2023-01-02 19:00:00 - step 44 of 48 - 900 active elements (0 deactivated)
15:55:36 INFO opendrift:2015: 2023-01-02 20:00:00 - step 45 of 48 - 900 active elements (0 deactivated)
15:55:37 INFO opendrift:2015: 2023-01-02 21:00:00 - step 46 of 48 - 900 active elements (0 deactivated)
15:55:38 INFO opendrift:2015: 2023-01-02 22:00:00 - step 47 of 48 - 900 active elements (0 deactivated)
15:55:38 INFO opendrift:2015: 2023-01-02 23:00:00 - step 48 of 48 - 900 active elements (0 deactivated)
Print and plot results
print(o)
o.plot()
#o.plot(background=['x_sea_water_velocity', 'y_sea_water_velocity'])
o.animation()

===========================
--------------------
Reader performance:
--------------------
https://thredds.met.no/thredds/dodsC/cmems/topaz6/dataset-topaz6-arc-15min-3km-be.ncml
0:00:34.9 total
0:00:00.0 preparing
0:00:34.8 reading
0:00:00.1 interpolation
0:00:00.0 interpolation_time
0:00:00.0 rotating vectors
0:00:00.0 masking
--------------------
global_landmask
0:00:01.6 total
0:00:00.0 preparing
0:00:01.6 reading
0:00:00.0 masking
--------------------
Performance:
44.4 total time
6.7 configuration
1.5 preparing main loop
1.5 moving elements to ocean
36.1 main loop
0.0 updating elements
0.0 cleaning up
--------------------
===========================
Model: OceanDrift (OpenDrift version 1.14.2)
900 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/cmems/topaz6/dataset-topaz6-arc-15min-3km-be.ncml
-----
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
upward_sea_water_velocity
x_wind
y_wind
Discarded readers:
Time:
Start: 2023-01-01 00:00:00 UTC
Present: 2023-01-03 00:00:00 UTC
Calculation steps: 48 * 1:00:00 - total time: 2 days, 0:00:00
Output steps: 49 * 1:00:00
===========================
15:55:52 INFO opendrift:4533: Saving animation to /root/project/docs/source/gallery/animations/example_coastline_0.gif...
15:56:27 INFO opendrift:2974: Time to make animation: 0:00:35.963554

Total running time of the script: (1 minutes 39.244 seconds)