Note
Go to the end to download the full example code.
2D simulation profile
from datetime import datetime, timedelta
import numpy as np
from opendrift.models.oceandrift import OceanDrift
o = OceanDrift(loglevel=20) # Set loglevel to 0 for debug information
09:35:57 INFO opendrift:507: OpenDriftSimulation initialised (version 1.14.2 / v1.14.2-21-g950aeec)
Define some constant current, wind and Stokes drift
o.set_config('environment:fallback:x_wind', 7)
o.set_config('environment:fallback:x_sea_water_velocity', .1)
o.set_config('environment:fallback:sea_surface_wave_stokes_drift_x_velocity', .2)
o.set_config('environment:fallback:sea_surface_wave_significant_height', 2)
o.set_config('environment:fallback:sea_surface_wave_period_at_variance_spectral_density_maximum', 8)
Seed elements between surface and 5m depth
time = datetime.utcnow()
z = -np.linspace(0, 5, 50)
o.seed_elements(lon=4.5, lat=60.0, z=z, radius=0, number=len(z), time=time)
/root/project/examples/example_2d.py:23: DeprecationWarning: datetime.datetime.utcnow() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.now(datetime.UTC).
time = datetime.utcnow()
09:35:57 INFO opendrift.models.basemodel.environment:206: Adding a global landmask from GSHHG
09:36:02 INFO opendrift.models.basemodel.environment:229: Fallback values will be used for the following variables which have no readers:
09:36:02 INFO opendrift.models.basemodel.environment:232: x_sea_water_velocity: 0.100000
09:36:02 INFO opendrift.models.basemodel.environment:232: y_sea_water_velocity: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_height: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: x_wind: 7.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: y_wind: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: upward_sea_water_velocity: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: ocean_vertical_diffusivity: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_significant_height: 2.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_stokes_drift_x_velocity: 0.200000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_stokes_drift_y_velocity: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_period_at_variance_spectral_density_maximum: 8.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_wave_mean_period_from_variance_spectral_density_second_frequency_moment: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_swell_wave_to_direction: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_swell_wave_peak_period_from_variance_spectral_density: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_swell_wave_significant_height: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_wind_wave_to_direction: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_wind_wave_mean_period: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_surface_wind_wave_significant_height: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: surface_downward_x_stress: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: surface_downward_y_stress: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: turbulent_kinetic_energy: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: turbulent_generic_length_scale: 0.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: ocean_mixed_layer_thickness: 50.000000
09:36:02 INFO opendrift.models.basemodel.environment:232: sea_floor_depth_below_sea_level: 10000.000000
Running model for 6 hours
o.run(duration=timedelta(hours=6), time_step=600)
09:36:02 INFO opendrift:911: Using existing reader for land_binary_mask
09:36:02 INFO opendrift:940: All points are in ocean
09:36:02 INFO opendrift:2102: 2025-05-28 09:35:57.821036 - step 1 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 09:45:57.821036 - step 2 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 09:55:57.821036 - step 3 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 10:05:57.821036 - step 4 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 10:15:57.821036 - step 5 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 10:25:57.821036 - step 6 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 10:35:57.821036 - step 7 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 10:45:57.821036 - step 8 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 10:55:57.821036 - step 9 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 11:05:57.821036 - step 10 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 11:15:57.821036 - step 11 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 11:25:57.821036 - step 12 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 11:35:57.821036 - step 13 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 11:45:57.821036 - step 14 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 11:55:57.821036 - step 15 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 12:05:57.821036 - step 16 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 12:15:57.821036 - step 17 of 36 - 50 active elements (0 deactivated)
09:36:02 INFO opendrift:2102: 2025-05-28 12:25:57.821036 - step 18 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 12:35:57.821036 - step 19 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 12:45:57.821036 - step 20 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 12:55:57.821036 - step 21 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 13:05:57.821036 - step 22 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 13:15:57.821036 - step 23 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 13:25:57.821036 - step 24 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 13:35:57.821036 - step 25 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 13:45:57.821036 - step 26 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 13:55:57.821036 - step 27 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 14:05:57.821036 - step 28 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 14:15:57.821036 - step 29 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 14:25:57.821036 - step 30 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 14:35:57.821036 - step 31 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 14:45:57.821036 - step 32 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 14:55:57.821036 - step 33 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 15:05:57.821036 - step 34 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 15:15:57.821036 - step 35 of 36 - 50 active elements (0 deactivated)
09:36:03 INFO opendrift:2102: 2025-05-28 15:25:57.821036 - step 36 of 36 - 50 active elements (0 deactivated)
To check that z is really kept constant for all particles
o.plot_property('z')

Vertical profile of advection. Note the decaying importance of Stokes drift, and the additional windage of the element at surface
o.animation_profile()
09:36:03 INFO opendrift:4609: Saving animation to /root/project/docs/source/gallery/animations/example_2d_0.gif...
09:36:09 INFO opendrift:3272: Time to make animation: 0:00:05.976639

Total running time of the script: (0 minutes 19.224 seconds)