newportxps 2025.1.0__tar.gz → 2026.1.0__tar.gz

{newportxps-2025.1.0/newportxps.egg-info → newportxps-2026.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: newportxps
-Version: 2025.1.0
+Version: 2026.1.0
 Summary: Python interface to Newport XPS motion controllers
 Author-email: Matthew Newville <newville@cars.uchicago.edu>
 License-Expression: MIT
@@ -32,6 +32,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: paramiko
 Requires-Dist: numpy
+Requires-Dist: tabulate
 Dynamic: license-file
 
 # newportxps

{newportxps-2025.1.0 → newportxps-2026.1.0}/newportxps/__init__.py

@@ -1,3 +1,4 @@
 from .version import __version__, __version_tuple__
 
 from .newportxps import NewportXPS
+from .xps_main import xps_main

{newportxps-2025.1.0 → newportxps-2026.1.0}/newportxps/newportxps.py

@@ -29,7 +29,6 @@ def withConnectedXPS(fcn):
 
     return wrapper
 
-
 class NewportXPS:
     gather_header = '# XPS Gathering Data\n#--------------'
     def __init__(self, host, group=None,
@@ -89,11 +88,11 @@ class NewportXPS:
 
         for groupname, status in self.get_group_status().items():
             this = self.groups[groupname]
-            out.append(f"{groupname} ({this['category']}), Status: {status}")
+            out.append(f"#\n# {groupname} ({this['category']}), Status: {status}")
             for pos in this['positioners']:
                 stagename = f"{groupname}.{pos}"
                 stage = self.stages[stagename]
-                out.extend([f"# {stagename} ({stage['stagetype']})",
+                out.extend([f"  {stagename} ({stage['stagetype']})",
                             f"      Hardware Status: {hstat[stagename]}",
                             f"      Positioner Errors: {perrs[stagename]}"])
         return "\n".join(out)
@@ -761,7 +760,7 @@ class NewportXPS:
 
         if self.traj_group is None:
             raise XPSException("No trajectory group defined")
-
+        # print(f"Define Line traj {axis=}, {self.traj_group=}")
         for axname in (axis, axis.upper(), axis.lower(), axis.title()):
             stage = f"{self.traj_group}.{axname}"
             if stage in self.stages:
@@ -790,13 +789,14 @@ class NewportXPS:
         distance = (abs(stop - start) + abs(step))*1.0
         velocity = min(distance/scantime, max_velo)
         if verbose:
-            print(f"trajecory: {scantime=:.4f}, {pixeltime=:.4f}, {npulses=}, {start=:.4f}, {stop=:.4f}, {step=:.4f}")
-        ramptime = max(2.e-5, abs(velocity/accel))
-        rampdist = 0.5*velocity*ramptime
+            print(f"trajecory: {scantime=:.5f}, {pixeltime=:.5f}, {npulses=}, {start=:.5f}, {stop=:.5f}, {step=:.5f}")
+        ramptime = max(5.e-4, abs(velocity/accel))
+        rampdist = max(5.e-6, 0.5*velocity*ramptime)
         offset   = 0.5*step + scandir*rampdist
 
         trajbase = {'axes': [axis],
                     'type': 'line',
+                    'group': self.traj_group,
                     'pixeltime': pixeltime, 'uploaded': False,
                     'npulses': npulses+1, 'nsegments': 3}
 
@@ -847,7 +847,7 @@ class NewportXPS:
 
     @withConnectedXPS
     def define_array_trajectory(self, positions, dtime=1.0, max_accels=None,
-                                upload=True, name='array', verbose=True):
+                                upload=True, name='array', group=None, verbose=True):
         """define a PVT trajectory for the trajectory group from a dictionary of
         position arrays for each positioner in the trajectory group.
 
@@ -859,6 +859,7 @@ class NewportXPS:
         dtime:      float, time per segment
         max_accels: dict of {PosName: max_acceleration} to use.
         name:       name of trajectory (file will be f"{name}.trj")
+        group:      name of trajectory group
         upload:     bool, whether to upload trajectory
 
         Returns:
@@ -880,6 +881,8 @@ class NewportXPS:
            decelerate to zero velocity.
 
         """
+        if group is not None:
+            self.traj_group = group
         tgroup = self.traj_group
         if tgroup is None:
             raise XPSException("No trajectory group defined")
@@ -963,9 +966,9 @@ class NewportXPS:
                 velo[axes] = np.zeros(npulses+1, dtype=np.float64)
                 accel[axes] = np.zeros(npulses+1, dtype=np.float64)
 
-
         traj = {'axes': all_axes,
                 'type': 'array',
+                'group': self.traj_group,
                 'start': start, 'pixeltime': dtime,
                 'npulses': npulses+1, 'nsegments': npulses+1,
                 'uploaded': False}
@@ -994,20 +997,32 @@ class NewportXPS:
         return traj
 
 
+    def get_trajectory(self, name, verify_group=True):
+        """get defined trajectory by name, with error checking"""
+        traj = self.trajectories.get(name, None)
+        if traj is None:
+            raise XPSException(f"Cannot find trajectory named '{name}'")
+
+        if verify_group:
+            traj_group = traj.get('group', self.traj_group)
+            if traj_group != self.traj_group:
+                raise XPSException(f"trajectory '{name}' uses group '{traj_group}', not '{self.traj_group=}'")
+        return traj
+
     @withConnectedXPS
-    def move_to_trajectory_start(self, name):
+    def move_to_trajectory_start(self, name, group=None):
         """
         move to the start position of a named trajectory
         """
-        tgroup = self.traj_group
-        if tgroup is None:
-            raise XPSException("No trajectory group defined")
+        if group is not None:
+            self.traj_group = group
 
-        traj = self.trajectories.get(name, None)
-        if traj is None:
-            raise XPSException(f"Cannot find trajectory named '{name}'")
+        if self.traj_group is None:
+            raise XPSException("No trajectory group defined")
 
+        traj = self.get_trajectory(name, verify_group=True)
         if traj['type'] == 'line':
+            tgroup = traj['group']
             for pos, axes in zip(traj['start'], traj['axes']):
                 self.move_stage(f'{tgroup}.{axes}', pos)
 
@@ -1016,23 +1031,21 @@ class NewportXPS:
                 if pos is not None:
                     self.move_stage(f'{tgroup}.{axes}', pos)
 
-
     @withConnectedXPS
-    def arm_trajectory(self, name, verbose=False, move_to_start=True):
+    def arm_trajectory(self, name, verbose=False, move_to_start=True, group=None):
         """
         prepare to run a named (assumed uploaded) trajectory
         """
+        if group is not None:
+            self.traj_group = group
+
         if self.traj_group is None:
             print("Must set group name!")
 
-        traj = self.trajectories.get(name, None)
-        if traj is None:
-            raise XPSException(f"Cannot find trajectory '{name}'")
-
+        traj = self.get_trajectory(name, verify_group=True)
         if not traj['uploaded']:
             raise XPSException(f"trajectory '{name}' has not been uploaded")
 
-
         self.traj_state = ARMING
         self.traj_file = f'{name}.trj'
 
@@ -1078,7 +1091,7 @@ class NewportXPS:
         self.traj_state = ARMED
 
     @withConnectedXPS
-    def run_trajectory(self, name=None, save=True, clean=False,
+    def run_trajectory(self, name=None, save=True, clean=False, group=None,
                        output_file='Gather.dat', verbose=False, move_to_start=True):
 
         """run a trajectory in PVT mode
@@ -1093,7 +1106,8 @@ class NewportXPS:
                 self._xps.CleanCoreDumpFolder(self._sid)
 
         if name in self.trajectories and self.traj_state != ARMED:
-            self.arm_trajectory(name, verbose=verbose, move_to_start=move_to_start)
+            self.arm_trajectory(name, verbose=verbose, group=group,
+                                move_to_start=move_to_start)
 
         if self.traj_state != ARMED:
             raise XPSException("Must arm trajectory before running!")
@@ -1255,11 +1269,17 @@ class NewportXPS:
                                          start_values=None,
                                          stop_values=None,
                                          accel_values=None,
-                                         pulse_time=0.1, scan_time=10.0):
+                                         pulse_time=0.1, scan_time=10.0, group=None):
         """
         Clemens' code for line trajectories -- should probably be
         unified with define_line_trajectories(),
         """
+        if group is not None:
+            self.traj_group = group
+
+        if self.traj_group is None:
+            raise XPSException("No trajectory group defined")
+
         if start_values is None:
             start_values = np.zeros(len(self.traj_positioners))
         else:
@@ -1288,7 +1308,6 @@ class NewportXPS:
 
         ramp_time = 1.5 * max(abs(velocities / accel_values))
         ramp      = velocities * ramp_time
-        print("ramp : ", ramp_time, ramp)
 
         ramp_attr = {'ramptime': ramp_time}
         down_attr = {'ramptime': ramp_time}
@@ -1326,6 +1345,7 @@ class NewportXPS:
         trajectory_str += down_str + '\n'
 
         self.trajectories[name] = {'pulse_time': pulse_time,
+                                   'group': self.traj_group,
                                    'step_number': len(distances)}
 
         for ind, positioner in enumerate(self.traj_positioners):
@@ -1339,11 +1359,15 @@ class NewportXPS:
         return trajectory_str
 
     def run_line_trajectory_general(self, name='default', verbose=False, save=True,
-                                    outfile='Gather.dat'):
+                                    outfile='Gather.dat', group=None):
         """run trajectory in PVT mode"""
-        traj = self.trajectories.get(name, None)
-        if traj is None:
-            raise XPSException(f'Cannot find trajectory named {name}')
+        if group is not None:
+            self.traj_group = group
+
+        if self.traj_group is None:
+            raise XPSException("No trajectory group defined")
+
+        traj = self.get_trajectory(name, verify_group=True)
 
         traj_file = f'{name}.trj'
         dtime = traj['pulse_time']
@@ -1400,7 +1424,6 @@ class NewportXPS:
         return npulses
 
 
-
 if __name__ == '__main__':
     ipaddr = sys.argv[1]
     x = NewportXPS(ipaddr)

{newportxps-2025.1.0 → newportxps-2026.1.0}/newportxps/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '2025.1.0'
-__version_tuple__ = version_tuple = (2025, 1, 0)
+__version__ = version = '2026.1.0'
+__version_tuple__ = version_tuple = (2026, 1, 0)
 
-__commit_id__ = commit_id = 'gd77177eec'
+__commit_id__ = commit_id = 'g3f4cc44e3'

newportxps-2026.1.0/newportxps/xps_main.py

@@ -0,0 +1,125 @@
+#!/usr/bin/env python
+
+from pathlib import Path
+from argparse import ArgumentParser
+from tabulate import tabulate
+
+from .newportxps import NewportXPS
+
+HELP_MESSAGE = """xps: simple interaction with NewportXPS controllers
+    xps -h                            shows this message.
+    xps [ADDR] status                 print status and configuration for XPS
+    xps [ADDR] groups                 print list of groups
+    xps [ADDR] reboot                 reboot xps
+    xps [ADDR] initialize    [GROUP]  initialize group by name
+    xps [ADDR] initialize_all         initialize all group
+    xps [ADDR] home          [GROUP]  home group by name
+    xps [ADDR] home_all               home all groups
+    xps [ADDR] get_system_ini [FILE]  download system.ini to file
+    xps [ADDR] put_system_ini [FILE]  upload   system.ini from file
+    xps [ADDR] get_stages_ini [FILE]  download stages.ini to file
+    xps [ADDR] put_stages_ini [FILE]  upload   stages.ini from file
+
+ ADDR:  name or ip address for the controller
+ FILE:  name of file to save or read
+ GROUP: name of group to initialize or home
+"""
+
+def xps_main():
+    parser = ArgumentParser(prog='xps', description='NewportXPS controllers',
+                            add_help=False)
+    parser.add_argument('-h', '--help', dest='help', action='store_true',
+                        default=False, help='show help')
+    parser.add_argument('options', nargs='*')
+    args = parser.parse_args()
+
+    if args.help or len(args.options) == 0:
+        print(HELP_MESSAGE)
+        return
+
+    ipaddr = args.options.pop(0)
+    command = args.options.pop(0)
+    _argu  = ''
+    if len(args.options) > 0:
+        _argu = args.options.pop(0)
+
+    try:
+        this_xps = NewportXPS(ipaddr)
+    except XPSException:
+        print(f"cannot connect to NewportXPS at {ipaddr=}")
+        return
+    except Exception:
+        print(f"unknown error connecting to NewportXPS at {ipaddr=}")
+        return
+
+    if command == 'status':
+        print(this_xps.status_report())
+    elif command == 'groups':
+        headers =('Group Name', 'Positioners', 'Type')
+        dat = []
+        for gn, gd in this_xps.groups.items():
+            dat.append((gn, ', '.join(gd['positioners']), gd['category']))
+        print(tabulate(dat, headers))
+    elif command == 'initialize_all':
+        this_xps.initialize_allgroups()
+    elif command == 'initialize':
+        if len(_argu) < 1:
+            print("xps initialize needs a group name, or use `xps initialize_all`")
+            return
+        groupname = _argu
+        if groupname not in this_xps.groups.keys():
+            print(f"xps initialize needs a valid group name, one of {', '.join(this_xps.groups.keys())}")
+            return
+        this_xps.initialize_group(groupname)
+    elif command == 'home_all':
+        this_xps.homee_allgroups()
+    elif command == 'home':
+        if len(_argu) < 1:
+            print("xps home needs a group name, or use `xps home_all`")
+            return
+        groupname = _argu
+        if groupname not in this_xps.groups.keys():
+            print(f"xps home needs a valid group name, one of {', '.join(this_xps.groups.keys())}")
+            return
+        this_xps.home_group(groupname)
+
+    elif command == 'reboot':
+        print(f"rebooting {ipaddr}")
+        this_xps.reboot()
+
+    elif command == 'get_system_ini':
+        filename = _argu
+        if len(filename) < 1:
+            filename = f'system_{ipaddr}.ini'
+        this_xps.save_systemini(filename)
+        print(f"saved system.ini to {filename}")
+
+    elif command == 'get_stages_ini':
+        filename = _argu
+        if len(filename) < 1:
+            filename = f'stages_{ipaddr}.ini'
+        this_xps.save_stagesini(filename)
+        print(f"saved stages.ini to {filename}")
+
+    elif command == 'put_system_ini':
+        filename = _argu
+        if len(filename) < 1:
+            print("xps put_system_ini needs system.ini file")
+            return
+        text = open(filneme, 'r').read()
+        this_xps.upload_systemini(text)
+        print(f"uploaded text from {filename} as system.ini")
+
+    elif command == 'put_stages_ini':
+        filename = _argu
+        if len(filename) < 1:
+            print("xps put_stages_ini needs stages.ini file")
+            return
+        text = open(filneme, 'r').read()
+        this_xps.upload_stagesini(text)
+        print(f"uploaded text from {filename} as stages.ini")
+
+
+
+if __name__ == '__main__':
+    xps_main()

{newportxps-2025.1.0 → newportxps-2026.1.0/newportxps.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: newportxps
-Version: 2025.1.0
+Version: 2026.1.0
 Summary: Python interface to Newport XPS motion controllers
 Author-email: Matthew Newville <newville@cars.uchicago.edu>
 License-Expression: MIT
@@ -32,6 +32,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: paramiko
 Requires-Dist: numpy
+Requires-Dist: tabulate
 Dynamic: license-file
 
 # newportxps

{newportxps-2025.1.0 → newportxps-2026.1.0}/newportxps.egg-info/SOURCES.txt

@@ -17,8 +17,10 @@ newportxps/ftp_wrapper.py
 newportxps/newportxps.py
 newportxps/utils.py
 newportxps/version.py
+newportxps/xps_main.py
 newportxps.egg-info/PKG-INFO
 newportxps.egg-info/SOURCES.txt
 newportxps.egg-info/dependency_links.txt
+newportxps.egg-info/entry_points.txt
 newportxps.egg-info/requires.txt
 newportxps.egg-info/top_level.txt

newportxps-2026.1.0/newportxps.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+xps = newportxps:xps_main

{newportxps-2025.1.0 → newportxps-2026.1.0}/newportxps.egg-info/requires.txt

@@ -1,2 +1,3 @@
 paramiko
 numpy
+tabulate

{newportxps-2025.1.0 → newportxps-2026.1.0}/pyproject.toml

@@ -16,7 +16,7 @@ authors = [
     {name="Matthew Newville", email="newville@cars.uchicago.edu"},
 ]
 
-dependencies = ['paramiko', 'numpy']
+dependencies = ['paramiko', 'numpy', 'tabulate']
 description = "Python interface to Newport XPS motion controllers"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -52,3 +52,6 @@ classifiers = [
 
 [project.urls]
 Homepage = "https://github.com/pyepics/newportxps/"
+
+[project.scripts]
+xps = "newportxps:xps_main"