Merge pull request #1047 from mickaelbegon/online_mac

macos_online_fix

Author: pariterre

README.md

@@ -788,14 +788,15 @@ One can refer to their respective solver's documentation to know which options e
 The `show_online_optim` parameter can be set to `True` so the graphs nicely update during the optimization with the default values.
 One can also directly declare `online_optim` as an `OnlineOptim` parameter to customize the behavior of the plotter. 
 Note that `show_online_optim` and `online_optim` are mutually exclusive.
-Please also note that `OnlineOptim.MULTIPROCESS` is not available on Windows and only none of them are available on Macos. 
-To see how to run the server on Windows, please refer to the `getting_started/pendulum.py` example.
+Please also note that `OnlineOptim.MULTIPROCESS` is not available on Windows or Macos.
+On Macos, the default backend is `OnlineOptim.MULTIPROCESS_SERVER`, while `OnlineOptim.SERVER` remains available if one wants to start `resources/plotting_server.py` manually.
+To see how to run the server explicitly, please refer to the `resources/plotting_server.py` example.
 It is expected to slow down the optimization a bit. 
 `show_options` can be also passed as a dict to the plotter to customize the plotter's behavior.
 If `online_optim` is set to `SERVER`, then a server must be started manually by instantiating an `PlottingServer` class (see `ressources/plotting_server.py`).
 The following keys are additional options when using `OnlineOptim.SERVER` and `OnlineOptim.MULTIPROCESS_SERVER`:
   - `host`: the host to use (default is `localhost`)
-  - `port`: the port to use (default is `5030`)
+  - `port`: the port to use (default is `5030` for `OnlineOptim.SERVER` and a random available port for `OnlineOptim.MULTIPROCESS_SERVER`)
 
 If you want to see IPOPT's iterations over the course of the resolution of your opc, it is possible using the following:
 ```python    
@@ -1720,7 +1721,7 @@ The type of online plotter to use.
 
 The accepted values are:
 NONE: No online plotter.
-DEFAULT: Use the default online plotter depending on the OS (MULTIPROCESS on Linux, MULTIPROCESS_SERVER on Windows and NONE on MacOS).
+DEFAULT: Use the default online plotter depending on the OS (MULTIPROCESS on Linux, MULTIPROCESS_SERVER on Windows and macOS).
 MULTIPROCESS: The online plotter is in a separate process.
 SERVER: The online plotter is in a separate server.
 MULTIPROCESS_SERVER: The online plotter using the server automatically setup on a separate process.

bioptim/examples/getting_started/basic_ocp.py

@@ -156,8 +156,7 @@ def main():
     ocp.print(to_console=False, to_graph=False)
 
     # --- Solve the ocp --- #
-    # Default is OnlineOptim.MULTIPROCESS on Linux, OnlineOptim.MULTIPROCESS_SERVER on Windows and None on MacOS
-    # To see the graphs on MacOS, one must run the server manually (see resources/plotting_server.py)
+    # Default is OnlineOptim.MULTIPROCESS_SERVER on all platforms.
     solver = Solver.IPOPT(online_optim=OnlineOptim.DEFAULT)
 
     # # Show the constraints Jacobian sparsity
@@ -180,13 +179,16 @@ def main():
     sol.print_cost()
     # sol.graphs(show_bounds=True, save_name="results.png")
 
-    # --- Animate the solution --- #
-    viewer = "bioviz"
-    # viewer = "pyorerun"
-    sol.animate(n_frames=0, viewer=viewer, show_now=True)
+    # # --- Animate the solution --- #
+    # # To animate the solution, we can use the animate function. Uncomment the current block
+    # # to see the animation.
+    # # 'bioviz' must be installed to use the bioviz viewer.
+    # # Similarly, 'pyorerun' must be installed to use the pyorerun viewer.
+    # viewer = "bioviz"  # "pyorerun"
+    # sol.animate(n_frames=0, viewer=viewer, show_now=True)
 
     # # --- Saving the solver's output after the optimization --- #
-    # Here is an example of how we recommend to save the solution. Please note that sol.ocp is not picklable and that sol will be loaded using the current bioptim version, not the version at the time of the generation of the results.
+    # # Here is an example of how we recommend to save the solution. Please note that sol.ocp is not picklable and that sol will be loaded using the current bioptim version, not the version at the time of the generation of the results.
     # import pickle
     # import git
     # from datetime import date

bioptim/gui/online_callback_multiprocess_server.py

@@ -1,7 +1,10 @@
 from multiprocessing import Process
+import socket
 
 from .online_callback_server import PlottingServer, OnlineCallbackServer
 
+_DEFAULT_HOST = "localhost"
+
 
 def _start_server_internal(**kwargs):
     """
@@ -15,6 +18,12 @@ def _start_server_internal(**kwargs):
     PlottingServer(**kwargs)
 
 
+def _find_available_tcp_port(host: str) -> int:
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
+        sock.bind((host, 0))
+        return sock.getsockname()[1]
+
+
 class OnlineCallbackMultiprocessServer(OnlineCallbackServer):
     def __init__(self, *args, **kwargs):
         """
@@ -24,8 +33,12 @@ def __init__(self, *args, **kwargs):
         ----------
         Same as PlottingServer
         """
-        host = kwargs["host"] if "host" in kwargs else None
-        port = kwargs["port"] if "port" in kwargs else None
+        host = kwargs["host"] if "host" in kwargs else _DEFAULT_HOST
+        port = _find_available_tcp_port(host) if "port" not in kwargs or kwargs["port"] is None else kwargs["port"]
+
+        kwargs["host"] = host
+        kwargs["port"] = port
+
         log_level = None
         if "log_level" in kwargs:
             log_level = kwargs["log_level"]

bioptim/gui/online_callback_server.py

@@ -17,6 +17,7 @@
 from ..misc.parameters_types import (
     Bool,
     Int,
+    Float,
     Str,
     Bytes,
     StrOptional,
@@ -485,7 +486,8 @@ def __init__(
 
         self._host: Str = host if host else _DEFAULT_HOST
         self._port: Int = port if port else _DEFAULT_PORT
-        self._socket: socket.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        self._socket: socket.socket | None = None
+        self._reset_client_socket()
 
         self._should_wait_ok_to_client_on_new_data: Bool = platform.system() == "Darwin"
 
@@ -502,6 +504,14 @@ def __init__(
 
         self._initialize_connexion(**show_options)
 
+    def _reset_client_socket(self) -> None:
+        if self._socket is not None:
+            try:
+                self._socket.close()
+            except OSError:
+                pass
+        self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+
     def _initialize_connexion(self, retries: Int = 0, **show_options) -> None:
         """
         Initializes the connexion to the server
@@ -522,10 +532,11 @@ def _initialize_connexion(self, retries: Int = 0, **show_options) -> None:
             if retries > 5:
                 raise RuntimeError(
                     "Could not connect to the plotter server, make sure it is running by calling 'PlottingServer()' on "
-                    "another python instance or allowing for automatic start (Linux or Windows) of the server setting "
+                    "another python instance or allowing for automatic start (Linux, Windows or macOS) of the server setting "
                     "the online_option to 'OnlineOptim.MULTIPROCESS_SERVER' when instantiating your solver."
                 )
             else:
+                self._reset_client_socket()
                 time.sleep(1)
                 return self._initialize_connexion(retries + 1, **show_options)
 

bioptim/gui/plot.py

@@ -1190,8 +1190,13 @@ def _update_ydata(self, ydata: DMList | NpArrayList) -> None:
                         y_min = np.inf
                         for p in ax.get_children():
                             if isinstance(p, lines.Line2D):
-                                y_min = min(y_min, np.nanmin(p.get_ydata()))
-                                y_max = max(y_max, np.nanmax(p.get_ydata()))
+                                y_data = np.asarray(p.get_ydata())
+                                if y_data.size == 0 or np.isnan(y_data).all():
+                                    continue
+                                y_min = min(y_min, np.nanmin(y_data))
+                                y_max = max(y_max, np.nanmax(y_data))
+                        if not np.isfinite(y_min) or not np.isfinite(y_max):
+                            continue
                         ax.set_ylim(self._compute_ylim(y_min, y_max, 1.25))
 
         for p in self.plots_vertical_lines:

bioptim/interfaces/interface_utils.py

@@ -1,3 +1,4 @@
+import platform
 from time import perf_counter
 
 from casadi import Importer, Function, horzcat, vertcat, sum1, sum2, nlpsol, SX, MX, DM, reshape, jacobian
@@ -37,7 +38,14 @@ def generic_online_optim(interface: SolverInterface, ocp, show_options: AnyDictO
     online_optim = interface.opts.online_optim.get_default()
     if online_optim is None:
         return
-    elif online_optim == OnlineOptim.MULTIPROCESS:
+    if platform.system() == "Darwin" and online_optim == OnlineOptim.MULTIPROCESS:
+        raise NotImplementedError(
+            "online_optim MULTIPROCESS is not available on macOS. "
+            "Use OnlineOptim.MULTIPROCESS_SERVER for automatic plotting or OnlineOptim.SERVER with a manually started "
+            "PlottingServer."
+        )
+
+    if online_optim == OnlineOptim.MULTIPROCESS:
         to_call = OnlineCallbackMultiprocess
     elif online_optim == OnlineOptim.SERVER:
         to_call = OnlineCallbackServer

bioptim/misc/enums.py

@@ -102,7 +102,7 @@ class OnlineOptim(Enum):
     Attributes
     ----------
     NONE: No online plotting
-    DEFAULT: Default online plotting (MULTIPROCESS on Linux, MULTIPROCESS_SERVER on Windows and NONE on MacOS)
+    DEFAULT: Default online plotting (MULTIPROCESS on Linux and MULTIPROCESS_SERVER on Windows and macOS)
     MULTIPROCESS: Multiprocess online plotting
     SERVER: Server online plotting
     MULTIPROCESS_SERVER: Multiprocess server online plotting
@@ -117,9 +117,7 @@ def get_default(self):
         if self != OnlineOptim.DEFAULT:
             return self
 
-        if platform.system() == "Linux":
-            return OnlineOptim.MULTIPROCESS
-        elif platform.system() == "Windows":
+        if platform.system() in ("Linux", "Windows", "Darwin"):
             return OnlineOptim.MULTIPROCESS_SERVER
         else:
             return None

resources/plotting_server.py

@@ -7,8 +7,8 @@
 Since the server runs usings sockets, it is possible to run the server on a different machine than the one running the
 optimization. This is useful when the optimization is run on a cluster and the plotting server is run on a local machine.
 
-On Macos, this server is necessary as it won't connect using multiprocess. One can simply run the current script on
-another terminal to access the online graphs
+On Macos, this script is still useful if one wants to force OnlineOptim.SERVER explicitly or run the plotting server
+on a different machine.
 """
 
 from bioptim import PlottingServer

tests/shard1/test_global_fatigue.py

@@ -629,7 +629,7 @@ def test_fatigable_effort_torque_split(phase_dynamics):
     sol = ocp.solve()
 
     # Check objective function value
-    if platform.system() != "Windows":
+    if platform.system() == "Darwin":
         TestUtils.assert_objective_value(sol=sol, expected_value=124.09811263203727)
 
         # Check constraints