Note

Go to the end to download the full example code

Seeding from shapefile

from datetime import datetime
from opendrift.models.oceandrift import OceanDrift


o = OceanDrift(loglevel=20)  # Set loglevel to 0 for debug information

14:00:50 INFO    opendrift.models.basemodel:539: OpenDriftSimulation initialised (version 1.10.7 / v1.10.6-119-g1da5bec)

Seed particles within contours from shapefile

o.seed_from_shapefile(o.test_data_folder() +
                      'shapefile_spawning_areas/Torsk.shp',
                      number=2000, layername=None,
                      featurenum=[2, 4], time=datetime.utcnow())

o.set_config('environment:fallback:x_wind', -4)  # Constant wind drift
o.set_config('environment:fallback:y_wind', 8)
o.set_config('drift:wind_uncertainty', 4) # Adding some diffusion
o.set_config('drift:vertical_mixing', False)

14:00:51 INFO    opendrift.models.basemodel:2306: Seeding for layer: Torsk (8 features)
14:00:51 INFO    opendrift.models.basemodel:2337: Total area of all polygons: 87279214796.95839 m2
14:00:51 INFO    opendrift.models.basemodel:2348:       Seeding 1721 elements within polygon number 2
14:00:51 INFO    opendrift.models.basemodel:2348:       Seeding 279 elements within polygon number 4

Running model

o.run(steps=50, time_step=3600)

14:00:51 INFO    opendrift.models.basemodel:2591: Fallback values will be used for the following variables which have no readers:
14:00:51 INFO    opendrift.models.basemodel:2594:       x_sea_water_velocity: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       y_sea_water_velocity: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       x_wind: -4.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       y_wind: 8.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       upward_sea_water_velocity: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       ocean_vertical_diffusivity: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_wave_significant_height: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_wave_stokes_drift_x_velocity: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_wave_stokes_drift_y_velocity: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_wave_period_at_variance_spectral_density_maximum: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_wave_mean_period_from_variance_spectral_density_second_frequency_moment: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_swell_wave_to_direction: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_swell_wave_peak_period_from_variance_spectral_density: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_swell_wave_significant_height: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_wind_wave_to_direction: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_wind_wave_mean_period: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_surface_wind_wave_significant_height: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       surface_downward_x_stress: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       surface_downward_y_stress: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       turbulent_kinetic_energy: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       turbulent_generic_length_scale: 0.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       ocean_mixed_layer_thickness: 50.000000
14:00:51 INFO    opendrift.models.basemodel:2594:       sea_floor_depth_below_sea_level: 10000.000000
14:00:51 INFO    opendrift.models.basemodel:2753: Adding a dynamical landmask with max. priority based on assumed maximum speed of 1 m/s. Adding a customised landmask may be faster...
14:00:57 INFO    opendrift.models.basemodel:1701: Using existing reader for land_binary_mask
14:00:57 INFO    opendrift.models.basemodel:1713: All points are in ocean
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-01 14:00:50.990538 - step 1 of 50 - 2000 active elements (0 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-01 15:00:50.990538 - step 2 of 50 - 2000 active elements (0 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-01 16:00:50.990538 - step 3 of 50 - 2000 active elements (0 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-01 17:00:50.990538 - step 4 of 50 - 2000 active elements (0 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-01 18:00:50.990538 - step 5 of 50 - 2000 active elements (0 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-01 19:00:50.990538 - step 6 of 50 - 2000 active elements (0 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-01 20:00:50.990538 - step 7 of 50 - 2000 active elements (0 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-01 21:00:50.990538 - step 8 of 50 - 2000 active elements (0 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-01 22:00:50.990538 - step 9 of 50 - 1999 active elements (1 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-01 23:00:50.990538 - step 10 of 50 - 1997 active elements (3 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 00:00:50.990538 - step 11 of 50 - 1996 active elements (4 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 01:00:50.990538 - step 12 of 50 - 1996 active elements (4 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 02:00:50.990538 - step 13 of 50 - 1994 active elements (6 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 03:00:50.990538 - step 14 of 50 - 1994 active elements (6 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 04:00:50.990538 - step 15 of 50 - 1993 active elements (7 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 05:00:50.990538 - step 16 of 50 - 1991 active elements (9 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 06:00:50.990538 - step 17 of 50 - 1989 active elements (11 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 07:00:50.990538 - step 18 of 50 - 1987 active elements (13 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 08:00:50.990538 - step 19 of 50 - 1985 active elements (15 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 09:00:50.990538 - step 20 of 50 - 1983 active elements (17 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 10:00:50.990538 - step 21 of 50 - 1983 active elements (17 deactivated)
14:00:57 INFO    opendrift.models.basemodel:2882: 2023-09-02 11:00:50.990538 - step 22 of 50 - 1981 active elements (19 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 12:00:50.990538 - step 23 of 50 - 1979 active elements (21 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 13:00:50.990538 - step 24 of 50 - 1976 active elements (24 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 14:00:50.990538 - step 25 of 50 - 1973 active elements (27 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 15:00:50.990538 - step 26 of 50 - 1972 active elements (28 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 16:00:50.990538 - step 27 of 50 - 1969 active elements (31 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 17:00:50.990538 - step 28 of 50 - 1968 active elements (32 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 18:00:50.990538 - step 29 of 50 - 1967 active elements (33 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 19:00:50.990538 - step 30 of 50 - 1964 active elements (36 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 20:00:50.990538 - step 31 of 50 - 1961 active elements (39 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 21:00:50.990538 - step 32 of 50 - 1960 active elements (40 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 22:00:50.990538 - step 33 of 50 - 1958 active elements (42 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-02 23:00:50.990538 - step 34 of 50 - 1957 active elements (43 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 00:00:50.990538 - step 35 of 50 - 1952 active elements (48 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 01:00:50.990538 - step 36 of 50 - 1952 active elements (48 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 02:00:50.990538 - step 37 of 50 - 1949 active elements (51 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 03:00:50.990538 - step 38 of 50 - 1948 active elements (52 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 04:00:50.990538 - step 39 of 50 - 1946 active elements (54 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 05:00:50.990538 - step 40 of 50 - 1943 active elements (57 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 06:00:50.990538 - step 41 of 50 - 1940 active elements (60 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 07:00:50.990538 - step 42 of 50 - 1938 active elements (62 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 08:00:50.990538 - step 43 of 50 - 1936 active elements (64 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 09:00:50.990538 - step 44 of 50 - 1930 active elements (70 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 10:00:50.990538 - step 45 of 50 - 1926 active elements (74 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 11:00:50.990538 - step 46 of 50 - 1923 active elements (77 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 12:00:50.990538 - step 47 of 50 - 1921 active elements (79 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 13:00:50.990538 - step 48 of 50 - 1920 active elements (80 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 14:00:50.990538 - step 49 of 50 - 1917 active elements (83 deactivated)
14:00:58 INFO    opendrift.models.basemodel:2882: 2023-09-03 15:00:50.990538 - step 50 of 50 - 1916 active elements (84 deactivated)

Print and plot results

print(o)
o.plot(fast=True)
o.animation(fast=True)
OpenDrift - OceanDrift 2023-09-01 14:00 to 2023-09-03 16:00 UTC (51 steps)
===========================
--------------------
Reader performance:
--------------------
global_landmask
 0:00:00.0  total
 0:00:00.0  preparing
 0:00:00.0  reading
 0:00:00.0  masking
--------------------
Performance:
    8.0 total time
    0.4 configuration
    6.2 preparing main loop
      6.1 making dynamical landmask
      0.0 moving elements to ocean
      0.4 readers
        0.0 global_landmask
        0.3 postprocessing
    1.3 main loop
      0.1 updating elements
    0.0 cleaning up
--------------------
===========================
Model:  OceanDrift     (OpenDrift version 1.10.7)
        1911 active Lagrangian3DArray particles  (89 deactivated, 0 scheduled)
-------------------
Environment variables:
  -----
  land_binary_mask
     1) global_landmask
  -----
Readers not added for the following variables:
  ocean_mixed_layer_thickness
  ocean_vertical_diffusivity
  sea_floor_depth_below_sea_level
  sea_surface_swell_wave_peak_period_from_variance_spectral_density
  sea_surface_swell_wave_significant_height
  sea_surface_swell_wave_to_direction
  sea_surface_wave_mean_period_from_variance_spectral_density_second_frequency_moment
  sea_surface_wave_period_at_variance_spectral_density_maximum
  sea_surface_wave_significant_height
  sea_surface_wave_stokes_drift_x_velocity
  sea_surface_wave_stokes_drift_y_velocity
  sea_surface_wind_wave_mean_period
  sea_surface_wind_wave_significant_height
  sea_surface_wind_wave_to_direction
  surface_downward_x_stress
  surface_downward_y_stress
  turbulent_generic_length_scale
  turbulent_kinetic_energy
  upward_sea_water_velocity
  x_sea_water_velocity
  x_wind
  y_sea_water_velocity
  y_wind

Time:
        Start: 2023-09-01 14:00:50.990538 UTC
        Present: 2023-09-03 16:00:50.990538 UTC
        Calculation steps: 50 * 1:00:00 - total time: 2 days, 2:00:00
        Output steps: 51 * 1:00:00
===========================

14:00:58 WARNING opendrift.models.basemodel:3226: Plotting fast. This will make your plots less accurate.
0.158576945415655 ALPHA
14:01:08 WARNING opendrift.models.basemodel:3226: Plotting fast. This will make your plots less accurate.
/opt/conda/envs/opendrift/lib/python3.11/site-packages/cartopy/mpl/geoaxes.py:1696: UserWarning: No data for colormapping provided via 'c'. Parameters 'cmap' will be ignored
  result = super().scatter(*args, **kwargs)
14:01:10 INFO    opendrift.models.basemodel:5350: Saving animation to /root/project/docs/source/gallery/animations/example_seed_from_shapefile_0.gif...
14:01:19 INFO    opendrift.models.basemodel:3848: Time to make animation: 0:00:10.842631
../_images/example_seed_from_shapefile_0.gif

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

Gallery generated by Sphinx-Gallery