Merge pull request #6 from AbberiorInstruments/bjoernthiel-remote-int…

…erface-change remote interface change: Imspector() -> get_application()
AbberiorInstruments · Jan 11, 2018 · 73f97f3 · 73f97f3
2 parents 04808a1 + c552a20
commit 73f97f3
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/docs/specpy.rst b/docs/specpy.rst
@@ -67,15 +67,15 @@ Imspector
 
 .. code-block:: python
 
-  Imspector()
+  get_application()
 
-first tries to return a local Imspector object (living in the same process) or 
-else returns a proxy Imspector object connected to the Imspector Application 
-running on `localhost`.
+first tries to return the local Imspector object (living in the same process) 
+or else returns a proxy Imspector object connected to the Imspector 
+Application running on `localhost`.
 
 .. code-block:: python
 
-  Imspector(host)
+  get_application(host)
 
 where :code:`host` is a host name returns a proxy Imspector object connected 
 to the Imspector Application running on the corresponding host.

diff --git a/docs/specpy/examples/data_analysis_example.py b/docs/specpy/examples/data_analysis_example.py
@@ -19,7 +19,7 @@
 import specpy as sp
 
 # connect to local Imspector and open an example file
-im = sp.Imspector()
+im = sp.get_application()
 measurement = im.open("data_analysis_example.msr")
 
 # set threshold

diff --git a/docs/specpy/examples/hello_imspector_example.py b/docs/specpy/examples/hello_imspector_example.py
@@ -15,7 +15,7 @@
 import specpy as sp
 
 # connect to local Imspector
-im = sp.Imspector()
+im = sp.get_application()
 
 # print Imspector host and version
 print('Connected to Imspector {} on {}'.format(im.version(), im.host()))
@@ -31,4 +31,4 @@
     time = msr.parameters('SimCam/ExposureTime')
     msr.set_parameters('SimCam/ExposureTime', 2 * time)
 
-# now have a look at Imspector, the parameter should have changed in the measurement properties of this measurement
+# now have a look at Imspector, the parameter should have changed in the measurement properties of this measurement
diff --git a/docs/specpy/examples/measurements_example.py b/docs/specpy/examples/measurements_example.py
@@ -23,7 +23,7 @@
 import specpy as sp
 
 # get imspector object and print version
-im = sp.Imspector()
+im = sp.get_application()
 print('Imspector {} on {}'.format(im.version(), im.host()))
 
 # print existing device drivers
@@ -79,4 +79,4 @@
 print('active configuration {}'.format(msr.active_configuration().name()))
 im.run(msr)
 print('number of stacks: {}'.format(msr.number_of_stacks()))
-pp.pprint(msr.stack_names())
+pp.pprint(msr.stack_names())