Doc: added example script

Author: PierreRaybaut

cdlclient/remote.py

@@ -215,11 +215,13 @@ class SimpleRemoteProxy(SimpleBaseProxy):
         True
         >>> proxy.get_object_titles()
         ['toto']
-        >>> proxy.get_object_from_title("toto")
+        >>> proxy["toto"]
         <cdlclient.model.signal.SignalObj at 0x7f7f1c0b4a90>
-        >>> proxy.get_object(1)
+        >>> "toto" in proxy
+        True
+        >>> proxy[1]
         <cdlclient.model.signal.SignalObj at 0x7f7f1c0b4a90>
-        >>> proxy.get_object(1).data
+        >>> proxy[1].data
         array([1., 2., 3.])
     """
 

doc/overview.rst

@@ -63,6 +63,15 @@ between your application and DataLab:
 
     Screenshot of remote client application test (``cdlclient.tests.remoteclient_app``)
 
+Example
+^^^^^^^
+
+Here is an example in Python 3 of a script that connects to a running DataLab
+instance, adds a signal and an image, and then runs calculations (the cell
+structure of the script make it convenient to be used in `Spyder`_ IDE):
+
+.. literalinclude:: remote_example.py
+
 Additional features
 ^^^^^^^^^^^^^^^^^^^
 

doc/remote_example.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+"""
+Example of remote control of DataLab current session,
+from a Python script running outside DataLab (e.g. in Spyder)
+
+Created on Fri May 12 12:28:56 2023
+
+@author: p.raybaut
+"""
+
+# %% Importing necessary modules
+
+# NumPy for numerical array computations:
+import numpy as np
+
+# DataLab remote control client:
+from cdlclient import SimpleRemoteProxy
+
+# %% Connecting to DataLab current session
+
+proxy = SimpleRemoteProxy()
+proxy.connect()
+
+# %% Executing commands in DataLab (...)
+
+z = np.random.rand(20, 20)
+proxy.add_image("toto", z)
+
+# %% Executing commands in DataLab (...)
+
+x = np.array([1.0, 2.0, 3.0])
+y = np.array([4.0, 5.0, -1.0])
+proxy.add_signal("toto", x, y)
+
+# %% Executing commands in DataLab (...)
+
+proxy.compute_derivative()
+
+# %% Executing commands in DataLab (...)
+
+proxy.set_current_panel("image")
+
+# %% Executing commands in DataLab (...)
+
+proxy.compute_fft()