add rotating dial to instrument progress monitoring

Author: j-atkins

src/virtualship/expedition/simulate_measurements.py

@@ -36,7 +36,6 @@ def simulate_measurements(
         expedition_dir = Path(expedition_dir)
 
     if len(measurements.ship_underwater_sts) > 0:
-        print("Simulating onboard salinity and temperature measurements.")
         if ship_config.ship_underwater_st_config is None:
             raise RuntimeError("No configuration for ship underwater ST provided.")
         if input_data.ship_underwater_st_fieldset is None:
@@ -49,7 +48,6 @@ def simulate_measurements(
         )
 
     if len(measurements.adcps) > 0:
-        print("Simulating onboard ADCP.")
         if ship_config.adcp_config is None:
             raise RuntimeError("No configuration for ADCP provided.")
         if input_data.adcp_fieldset is None:
@@ -64,7 +62,6 @@ def simulate_measurements(
         )
 
     if len(measurements.ctds) > 0:
-        print("Simulating CTD casts.")
         if ship_config.ctd_config is None:
             raise RuntimeError("No configuration for CTD provided.")
         if input_data.ctd_fieldset is None:
@@ -77,7 +74,6 @@ def simulate_measurements(
         )
 
     if len(measurements.ctd_bgcs) > 0:
-        print("Simulating BGC CTD casts.")
         if ship_config.ctd_bgc_config is None:
             raise RuntimeError("No configuration for CTD_BGC provided.")
         if input_data.ctd_bgc_fieldset is None:
@@ -90,7 +86,6 @@ def simulate_measurements(
         )
 
     if len(measurements.drifters) > 0:
-        print("Simulating drifters")
         if ship_config.drifter_config is None:
             raise RuntimeError("No configuration for drifters provided.")
         if input_data.drifter_fieldset is None:
@@ -105,7 +100,6 @@ def simulate_measurements(
         )
 
     if len(measurements.argo_floats) > 0:
-        print("Simulating argo floats")
         if ship_config.argo_float_config is None:
             raise RuntimeError("No configuration for argo floats provided.")
         if input_data.argo_float_fieldset is None:
@@ -119,7 +113,6 @@ def simulate_measurements(
         )
 
     if len(measurements.xbts) > 0:
-        print("Simulating XBTs")
         if ship_config.xbt_config is None:
             raise RuntimeError("No configuration for XBTs provided.")
         if input_data.xbt_fieldset is None:

src/virtualship/instruments/adcp.py

@@ -7,6 +7,7 @@
 
 from ..log_filter import Filter, external_logger
 from ..spacetime import Spacetime
+from ..utils import RotatePrint
 
 # we specifically use ScipyParticle because we have many small calls to execute
 # there is some overhead with JITParticle and this ends up being significantly faster
@@ -42,6 +43,8 @@ def simulate_adcp(
     :param num_bins: How many samples to take in the complete range between max_depth and min_depth.
     :param sample_points: The places and times to sample at.
     """
+    rotator = RotatePrint("Simulating onboard ADCP...")
+
     sample_points.sort(key=lambda p: p.time)
 
     bins = np.linspace(max_depth, min_depth, num_bins)
@@ -66,7 +69,10 @@ def simulate_adcp(
         handler.addFilter(Filter())
 
     # try/finally to ensure filter is always removed even if .execute fails (to avoid filter being appled universally)
+    # also suits starting and ending the rotator for custom log message
     try:
+        rotator.start()
+
         for point in sample_points:
             particleset.lon_nextloop[:] = point.location.lon
             particleset.lat_nextloop[:] = point.location.lat
@@ -85,5 +91,6 @@ def simulate_adcp(
             )
 
     finally:
+        rotator.stop()
         for handler in external_logger.handlers:
             handler.removeFilter(handler.filters[0])

src/virtualship/instruments/argo_float.py

@@ -132,6 +132,7 @@ def simulate_argo_floats(
     :param outputdt: Interval which dictates the update frequency of file output during simulation
     :param endtime: Stop at this time, or if None, continue until the end of the fieldset.
     """
+    print("Simulating argo floats...")
     DT = 10.0  # dt of Argo float simulation integrator
 
     if len(argo_floats) == 0:
@@ -178,7 +179,6 @@ def simulate_argo_floats(
 
     # try/finally to ensure filter is always removed even if .execute fails (to avoid filter being appled universally)
     try:
-        # execute simulation
         argo_float_particleset.execute(
             [
                 _argo_float_vertical_movement,
@@ -189,9 +189,10 @@ def simulate_argo_floats(
             endtime=actual_endtime,
             dt=DT,
             output_file=out_file,
-            verbose_progress=False,
+            verbose_progress=True,
         )
 
     finally:
+        print("... [COMPLETED]")
         for handler in external_logger.handlers:
             handler.removeFilter(handler.filters[0])

src/virtualship/instruments/ctd.py

@@ -9,6 +9,7 @@
 
 from ..log_filter import Filter, external_logger
 from ..spacetime import Spacetime
+from ..utils import RotatePrint
 
 
 @dataclass
@@ -69,6 +70,8 @@ def simulate_ctd(
     :param outputdt: Interval which dictates the update frequency of file output during simulation
     :raises ValueError: Whenever provided CTDs, fieldset, are not compatible with this function.
     """
+    rotator = RotatePrint("Simulating CTD casts...")
+
     WINCH_SPEED = 1.0  # sink and rise speed in m/s
     DT = 10.0  # dt of CTD simulation integrator
 
@@ -127,7 +130,10 @@ def simulate_ctd(
         handler.addFilter(Filter())
 
     # try/finally to ensure filter is always removed even if .execute fails (to avoid filter being appled universally)
+    # also suits starting and ending the rotator for custom log message
     try:
+        rotator.start()
+
         ctd_particleset.execute(
             [_sample_salinity, _sample_temperature, _ctd_cast],
             endtime=fieldset_endtime,
@@ -137,6 +143,7 @@ def simulate_ctd(
         )
 
     finally:
+        rotator.stop()
         for handler in external_logger.handlers:
             handler.removeFilter(handler.filters[0])
 

src/virtualship/instruments/ctd_bgc.py

@@ -9,6 +9,7 @@
 
 from ..log_filter import Filter, external_logger
 from ..spacetime import Spacetime
+from ..utils import RotatePrint
 
 
 @dataclass
@@ -69,6 +70,8 @@ def simulate_ctd_bgc(
     :param outputdt: Interval which dictates the update frequency of file output during simulation
     :raises ValueError: Whenever provided BGC CTDs, fieldset, are not compatible with this function.
     """
+    rotator = RotatePrint("Simulating BGC CTD casts...")
+
     WINCH_SPEED = 1.0  # sink and rise speed in m/s
     DT = 10.0  # dt of CTD simulation integrator
 
@@ -133,7 +136,10 @@ def simulate_ctd_bgc(
         handler.addFilter(Filter())
 
     # try/finally to ensure filter is always removed even if .execute fails (to avoid filter being appled universally)
+    # also suits starting and ending the rotator for custom log message
     try:
+        rotator.start()
+
         ctd_bgc_particleset.execute(
             [_sample_o2, _sample_chlorophyll, _ctd_bgc_cast],
             endtime=fieldset_endtime,
@@ -143,6 +149,7 @@ def simulate_ctd_bgc(
         )
 
     finally:
+        rotator.stop()
         for handler in external_logger.handlers:
             handler.removeFilter(handler.filters[0])
 

src/virtualship/instruments/drifter.py

@@ -59,6 +59,8 @@ def simulate_drifters(
     :param dt: Dt for integration.
     :param endtime: Stop at this time, or if None, continue until the end of the fieldset or until all drifters ended. If this is earlier than the last drifter ended or later than the end of the fieldset, a warning will be printed.
     """
+    print("Simulating drifters...")
+
     if len(drifters) == 0:
         print(
             "No drifters provided. Parcels currently crashes when providing an empty particle set, so no drifter simulation will be done and no files will be created."
@@ -102,16 +104,16 @@ def simulate_drifters(
 
     # try/finally to ensure filter is always removed even if .execute fails (to avoid filter being appled universally)
     try:
-        # execute simulation
         drifter_particleset.execute(
             [AdvectionRK4, _sample_temperature, _check_lifetime],
             endtime=actual_endtime,
             dt=dt,
             output_file=out_file,
-            verbose_progress=False,
+            verbose_progress=True,
         )
 
     finally:
+        print("... [COMPLETED]")
         for handler in external_logger.handlers:
             handler.removeFilter(handler.filters[0])
 

src/virtualship/instruments/ship_underwater_st.py

@@ -7,6 +7,7 @@
 
 from ..log_filter import Filter, external_logger
 from ..spacetime import Spacetime
+from ..utils import RotatePrint
 
 # we specifically use ScipyParticle because we have many small calls to execute
 # there is some overhead with JITParticle and this ends up being significantly faster
@@ -42,6 +43,8 @@ def simulate_ship_underwater_st(
     :param depth: The depth at which to measure. 0 is water surface, negative is into the water.
     :param sample_points: The places and times to sample at.
     """
+    rotator = RotatePrint("Simulating onboard salinity and temperature measurements...")
+
     sample_points.sort(key=lambda p: p.time)
 
     particleset = ParticleSet.from_list(
@@ -53,7 +56,6 @@ def simulate_ship_underwater_st(
         time=0,  # same for time
     )
 
-    # define output file for the simulation
     # outputdt set to infinie as we want to just want to write at the end of every call to 'execute'
     out_file = particleset.ParticleFile(name=out_path, outputdt=np.inf)
 
@@ -62,7 +64,10 @@ def simulate_ship_underwater_st(
         handler.addFilter(Filter())
 
     # try/finally to ensure filter is always removed even if .execute fails (to avoid filter being appled universally)
+    # also suits starting and ending the rotator for custom log message
     try:
+        rotator.start()
+
         # iterate over each point, manually set lat lon time, then
         # execute the particle set for one step, performing one set of measurement
         for point in sample_points:
@@ -83,5 +88,6 @@ def simulate_ship_underwater_st(
             )
 
     finally:
+        rotator.stop()
         for handler in external_logger.handlers:
             handler.removeFilter(handler.filters[0])

src/virtualship/instruments/xbt.py

@@ -9,6 +9,7 @@
 
 from ..log_filter import Filter, external_logger
 from ..spacetime import Spacetime
+from ..utils import RotatePrint
 
 
 @dataclass
@@ -70,6 +71,8 @@ def simulate_xbt(
     :param outputdt: Interval which dictates the update frequency of file output during simulation
     :raises ValueError: Whenever provided XBTs, fieldset, are not compatible with this function.
     """
+    rotator = RotatePrint("Simulating XBTs")
+
     DT = 10.0  # dt of XBT simulation integrator
 
     if len(xbts) == 0:
@@ -131,8 +134,10 @@ def simulate_xbt(
         handler.addFilter(Filter())
 
     # try/finally to ensure filter is always removed even if .execute fails (to avoid filter being appled universally)
+    # also suits starting and ending the rotator for custom log message
     try:
-        # execute simulation
+        rotator.start()
+
         xbt_particleset.execute(
             [_sample_temperature, _xbt_cast],
             endtime=fieldset_endtime,
@@ -142,6 +147,7 @@ def simulate_xbt(
         )
 
     finally:
+        rotator.stop()
         for handler in external_logger.handlers:
             handler.removeFilter(handler.filters[0])