newportxps 0.9__tar.gz → 2026.1.0__tar.gz

newportxps-2026.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2025 Matthew Newville, The University of Chicago
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXP80RESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE qUSE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: newportxps
-Version: 0.9
+Version: 2026.1.0
 Summary: Python interface to Newport XPS motion controllers
 Author-email: Matthew Newville <newville@cars.uchicago.edu>
-License: BSD License
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/pyepics/newportxps/
 Keywords: motion control,data collection
 Classifier: Development Status :: 5 - Production/Stable
@@ -11,16 +11,14 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Other Audience
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: Implementation :: Jython
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Education
 Classifier: Topic :: Scientific/Engineering
@@ -29,11 +27,13 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pysftp
+Requires-Dist: paramiko
 Requires-Dist: numpy
+Requires-Dist: tabulate
+Dynamic: license-file
 
 # newportxps
 

{newportxps-0.9 → newportxps-2026.1.0}/newportxps/XPS_C8_drivers.py

@@ -91,6 +91,7 @@ class XPS:
         # print("SEND REC ", command, type(command))
         suffix = ',EndOfAPI'
         try:
+            XPS.__sockets[socketId].settimeout(3600.0)
             XPS.__sockets[socketId].send(str2bytes(command))
             ret = bytes2str(XPS.__sockets[socketId].recv(1024))
             while (ret.find(suffix) == -1):
@@ -1139,7 +1140,7 @@ class XPS:
     def MultipleAxesPVTVerification (self, socketId, GroupName, TrajectoryFileName):
         command = 'MultipleAxesPVTVerification(' + GroupName + ',' + TrajectoryFileName + ')'
         return self.Send(socketId, command)
-    
+
     # MultipleAxesPTVerification :  Multiple axes PT trajectory verification
     def MultipleAxesPTVerification (self, socketId, GroupName, TrajectoryFileName):
         command = 'MultipleAxesPTVerification(' + GroupName + ',' + TrajectoryFileName + ')'
@@ -1156,7 +1157,7 @@ class XPS:
     def MultipleAxesPVTExecution (self, socketId, GroupName, TrajectoryFileName, ExecutionNumber):
         command = 'MultipleAxesPVTExecution(' + GroupName + ',' + TrajectoryFileName + ',' + str(ExecutionNumber) + ')'
         return self.Send(socketId, command)
-    
+
     # MultipleAxesPTExecution :  Multiple axes PT trajectory execution
     def MultipleAxesPTExecution (self, socketId, GroupName, TrajectoryFileName, ExecutionNumber):
         command = 'MultipleAxesPTExecution(' + GroupName + ',' + TrajectoryFileName + ',' + str(ExecutionNumber) + ')'

{newportxps-0.9 → 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-0.9 → newportxps-2026.1.0}/newportxps/ftp_wrapper.py

@@ -9,6 +9,15 @@ logger = logging.getLogger('paramiko')
 logger.setLevel(logging.ERROR)
 
 
+SFTP_ERROR_MESSAGE = """Could not connect to XPS with sftp: no host key.
+
+You may need to add a host key to your `ssh known_hosts` file, using
+   ssh-keyscan {host} >> ~/.ssh/known_hosts
+
+or first connecting with  `sftp Administrator@{host}` """
+
+import paramiko
+
 HAS_PYSFTP = False
 try:
     import pysftp
@@ -53,7 +62,9 @@ class FTPBaseWrapper(object):
 class SFTPWrapper(FTPBaseWrapper):
     """wrap ftp interactions for Newport XPS models D"""
     def __init__(self, host=None, username='Administrator',
-                 password='Administrator'):
+                 password='Administrator', use_paramiko=True):
+        self.use_paramiko = use_paramiko
+        self.ssh_client = None
         FTPBaseWrapper.__init__(self, host=host,
                                 username=username, password=password)
 
@@ -64,19 +75,32 @@ class SFTPWrapper(FTPBaseWrapper):
             self.username = username
         if password is not None:
             self.password = password
+        if not self.use_paramiko and HAS_PYSFTP:
+            self._conn = pysftp.Connection(host,
+                                           username=username,
+                                           password=password)
+        else:
+            if self.ssh_client is None:
+                self.ssh_client = paramiko.SSHClient()
+                self.ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+
+            try:
+                self.ssh_client.connect(host, 22, username, password)
+
+            except paramiko.AuthenticationException:
+                print("Authentication failed. Check your username and password/key.")
+                raise ValueError(SFTP_ERROR_MESSAGE.format(host=self.host))
+            except paramiko.SSHException as e:
+                print(f"SSH connection error: {e}")
+                raise ValueError(SFTP_ERROR_MESSAGE.format(host=self.host))
+            finally:
+                self._conn = self.ssh_client.open_sftp()
 
-        if not HAS_PYSFTP:
-            raise ValueError("pysftp not installed.")
-        try:
-            self._conn = pysftp.Connection(self.host,
-                                           username=self.username,
-                                           password=self.password)
-        except:
-            print("ERROR: sftp connection to %s failed" % self.host)
-            print("You may need to add the host keys for your XPS to your")
-            print("ssh known_hosts file, using a command like this:")
-            print("  ssh-keyscan %s >> ~/.ssh/known_hosts" % self.host)
-
+    def cwd(self, remotedir):
+        if self.use_paramiko:
+            self._conn.chdir(remotedir)
+        elif hasattr(self._conn, 'cwd'):
+            self._conn.cwd(remotedir)
 
     def save(self, remotefile, localfile):
         "save remote file to local file"

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

@@ -1,6 +1,7 @@
  #!/usr/bin/env python
 
 import posixpath
+import atexit
 import sys
 import time
 import socket
@@ -28,7 +29,6 @@ def withConnectedXPS(fcn):
 
     return wrapper
 
-
 class NewportXPS:
     gather_header = '# XPS Gathering Data\n#--------------'
     def __init__(self, host, group=None,
@@ -88,19 +88,26 @@ 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)
 
+    def disconnect(self):
+        self.ftpconn.close()
+        if self._sid is not None:
+            self._xps.TCP_CloseSocket(self._sid)
+        self._sid = None
 
     def connect(self):
         self._sid = self._xps.TCP_ConnectToServer(self.host,
                                                   self.port, self.timeout)
+
+        atexit.register(self.disconnect)
         try:
             self._xps.Login(self._sid, self.username, self.password)
         except:
@@ -109,8 +116,7 @@ class NewportXPS:
         err, val = self._xps.FirmwareVersionGet(self._sid)
         self.firmware_version = val
         self.ftphome = ''
-
-        if any([m in self.firmware_version for m in ['XPS-D', 'HXP-D']]):
+        if any([m in self.firmware_version for m in ['XPS-D', 'HXP-D', 'XPS-RL']]):
             err, val = self._xps.Send(self._sid, 'InstallerVersionGet(char *)')
             self.firmware_version = val
             self.ftpconn = SFTPWrapper(**self.ftpargs)
@@ -120,6 +126,11 @@ class NewportXPS:
                 self.ftphome = '/Admin'
         self.read_systemini()
 
+    def clean_folders(self):
+        if 'xps-d' in self.firmware_version.lower():
+            self._xps.CleanTmpFolder(self._sid)
+            self._xps.CleanCoreDumpFolder(self._sid)
+
 
     def check_error(self, err, msg='', with_raise=True):
         if err != 0:
@@ -168,7 +179,7 @@ class NewportXPS:
         sconf.read_string(initext)
 
         # read and populate lists of groups first
-        for gtype, glist in sconf.items('GROUPS'): # ].items():
+        for gtype, glist in sconf.items('GROUPS'):
             if len(glist) > 0:
                 for gname in glist.split(','):
                     gname = gname.strip()
@@ -191,21 +202,19 @@ class NewportXPS:
 
         if len(pvtgroups) == 1:
             self.set_trajectory_group(pvtgroups[0])
-
         for sname in self.stages:
             ret = self._xps.PositionerMaximumVelocityAndAccelerationGet(self._sid, sname)
             try:
                 self.stages[sname]['max_velo']  = ret[1]
-                self.stages[sname]['max_accel'] = ret[2]/3.0
+                self.stages[sname]['max_accel'] = 0.75*ret[2]
             except:
-                print(f"could not set max velo/accel for {name}")
+                print(f"could not read max velo/accel for {sname}")
             ret = self._xps.PositionerUserTravelLimitsGet(self._sid, sname)
             try:
                 self.stages[sname]['low_limit']  = ret[1]
                 self.stages[sname]['high_limit'] = ret[2]
             except:
-                print(f"could not set limits for {sname}")
-
+                print(f"could not read limits for {sname}")
         return self.groups
 
     def download_trajectory(self, filename):
@@ -426,8 +435,8 @@ class NewportXPS:
                 print(f"Warning: could not enable trajectory group '{self.traj_group}'")
                 return
 
-        for i in range(64):
-            self._xps.EventExtendedRemove(self._sid, i)
+        #for i in range(64):
+        #    self._xps.EventExtendedRemove(self._sid, i)
 
         # build template for linear trajectory file:
         trajline1 = ['%(ramptime)f']
@@ -630,8 +639,6 @@ class NewportXPS:
             print("Do have a group to move")
             return
         ret = self._xps.GroupMoveAbort(self._sid, group)
-        print('abort group ', group, ret)
-
 
     @withConnectedXPS
     def move_group(self, group=None, **kws):
@@ -640,7 +647,7 @@ class NewportXPS:
         if group is None or group not in self.groups:
             group = self.traj_group
         if group is None:
-            print("Do have a group to move")
+            print("no group to move")
             return
         posnames = [p.lower() for p in self.groups[group]['positioners']]
         ret = self._xps.GroupPositionCurrentGet(self._sid, group, len(posnames))
@@ -742,8 +749,8 @@ class NewportXPS:
 
 
     @withConnectedXPS
-    def define_line_trajectories(self, axis, group=None, pixeltime=0.01,
-                                 scantime=None, start=0, stop=1, step=0.001,
+    def define_line_trajectories(self, axis, group=None, pixeltime=None,
+                                 scantime=None, start=0, stop=1, step=0.01,
                                  accel=None, upload=True, verbose=False):
         """defines 'forward' and 'backward' trajectories for a simple
         single element line scan using PVT Mode
@@ -753,15 +760,14 @@ 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:
                 break
 
-        # print(" Stage ", stage,  self.stages[stage])
-        max_velo  = 0.75*self.stages[stage]['max_velo']
-        max_accel = 0.5*self.stages[stage]['max_accel']
+        max_velo  = self.stages[stage]['max_velo']
+        max_accel = self.stages[stage]['max_accel']
 
         if accel is None:
             accel = max_accel
@@ -773,20 +779,24 @@ class NewportXPS:
         step = scandir*abs(step)
 
         npulses  = int((abs(stop - start) + abs(step)*1.1) / abs(step))
-        if pixeltime is None and scantime is not None:
-            scantime = float(abs(scantime))
-            pixeltime= scantime / (npulses-1)
-        scantime = pixeltime*npulses
+        if pixeltime is None:
+            if scantime is None:
+                raise ValueError("line trajectory must set pixeltime or scantime")
+            else:
+                pixeltime = float(abs(scantime))/(npulses-1)
+        scantime = float(abs(pixeltime))*npulses
 
         distance = (abs(stop - start) + abs(step))*1.0
         velocity = min(distance/scantime, max_velo)
-
-        ramptime = max(2.e-5, abs(velocity/accel))
-        rampdist = velocity*ramptime
-        offset   = step/2.0 + scandir*rampdist
+        if verbose:
+            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}
 
@@ -828,6 +838,8 @@ class NewportXPS:
                                        self.linear_template % back)
                 self.trajectories['foreward']['uploaded'] = True
                 self.trajectories['backward']['uploaded'] = True
+                self.trajectories['foreward']['text'] = self.linear_template % fore
+                self.trajectories['backward']['text'] = self.linear_template % back
                 ret = True
             except:
                 raise ValueError("error uploading trajectory")
@@ -835,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.
 
@@ -847,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:
@@ -868,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")
@@ -951,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}
@@ -966,7 +981,7 @@ class NewportXPS:
                 p, v = pos[axes][n], velo[axes][n]
                 line.extend([f"{p:.8f}", f"{v:.8f}"])
             buff.append(', '.join(line))
-
+        buff.append('')
         buff  = '\n'.join(buff)
         traj['pvt_buffer'] = buff
 
@@ -982,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)
 
@@ -1004,30 +1031,26 @@ 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'
 
         if move_to_start:
             self.move_to_trajectory_start(name)
-
         # move_kws = {}
         outputs = []
         for out in self.gather_outputs:
@@ -1049,33 +1072,33 @@ class NewportXPS:
 
         if verbose:
             print(" GatheringConfigurationSet outputs ", outputs)
-            print(" GatheringConfigurationSet returned ", ret)
+            print(" GatheringConfigurationSet returned ", ret, time.ctime())
             print(" segments, pixeltime" , end_segment, traj['pixeltime'])
 
         err, ret = self._xps.MultipleAxesPVTPulseOutputSet(self._sid, self.traj_group,
                                                            2, end_segment,
                                                            traj['pixeltime'])
-        self.check_error(err, msg="PVTPulseOutputSet", with_raise=False)
+        self.check_error(err, msg="PVTPulseOutputSet", with_raise=True)
         if verbose:
-            print(" PVTPulse  ", ret)
+            print(" PVTPulse  ", ret, time.ctime())
         err, ret = self._xps.MultipleAxesPVTVerification(self._sid,
                                                          self.traj_group,
                                                          self.traj_file)
 
-        self.check_error(err, msg="PVTVerification", with_raise=False)
+        self.check_error(err, msg="PVTVerification", with_raise=True)
         if verbose:
-            print(" PVTVerify  ", ret)
+            print(" PVTVerify  ", ret, time.ctime())
         self.traj_state = ARMED
 
     @withConnectedXPS
-    def run_trajectory(self, name=None, save=True, clean=False,
-                       output_file='Gather.dat', verbose=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
 
         The trajectory *must be in the ARMED state
         """
-
+        dt = debugtime()
         if 'xps-d' in self.firmware_version.lower():
             self._xps.CleanTmpFolder(self._sid)
 
@@ -1083,11 +1106,13 @@ class NewportXPS:
                 self._xps.CleanCoreDumpFolder(self._sid)
 
         if name in self.trajectories and self.traj_state != ARMED:
-            self.arm_trajectory(name, verbose=verbose)
+            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!")
 
+        dt.add('armed')
         tgroup = self.traj_group
         buffer = ('Always', f'{tgroup}.PVT.TrajectoryPulse',)
         err, ret = self._xps.EventExtendedConfigurationTriggerSet(self._sid, buffer,
@@ -1096,35 +1121,46 @@ class NewportXPS:
         self.check_error(err, msg="EventConfigTrigger")
         if verbose:
             print( " EventExtended Trigger Set ", ret)
-
+        dt.add('event trigger set')
         err, ret = self._xps.EventExtendedConfigurationActionSet(self._sid,
                                                             ('GatheringOneData',),
                                                             ('',), ('',),('',),('',))
         self.check_error(err, msg="EventConfigAction")
         if verbose:
             print( " EventExtended Action  Set ", ret)
-
+        dt.add('event action set')
         eventID, m = self._xps.EventExtendedStart(self._sid)
         self.traj_state = RUNNING
 
         if verbose:
             print( " EventExtended ExtendedStart ", eventID, m)
-
+        dt.add('event start')
         err, ret = self._xps.MultipleAxesPVTExecution(self._sid,
                                                       self.traj_group,
                                                       self.traj_file, 1)
         self.check_error(err, msg="PVT Execute", with_raise=False)
         if verbose:
-            print( " PVT Execute  ", ret)
-
+            print( " PVT Execute done ", ret)
+        dt.add('pvt execute')
         ret = self._xps.EventExtendedRemove(self._sid, eventID)
         ret = self._xps.GatheringStop(self._sid)
-
+        dt.add('gathering stop')
         self.traj_state = COMPLETE
         npulses = 0
         if save:
-            self.read_and_save(output_file, verbose=verbose)
+            npulses, buff = self.read_gathering(set_idle_when_done=False,
+                                                verbose=verbose)
+            dt.add('read gathering')
+            if npulses > 0:
+                self.save_gathering_file(output_file, buff,
+                                         verbose=verbose,
+                                         set_idle_when_done=False)
+                dt.add('saved gathering')
+            self.ngathered = npulses
+            # self.read_and_save(output_file, verbose=verbose)
         self.traj_state = IDLE
+        if verbose:
+            dt.show()
         return npulses
 
     @withConnectedXPS
@@ -1156,16 +1192,18 @@ class NewportXPS:
         t0 = time.time()
         while npulses < 1:
             try:
-                ret, npulses, nx = self._xps.GatheringCurrentNumberGet(self._sid)
+                gdat = self._xps.GatheringCurrentNumberGet(self._sid)
             except SyntaxError:
                 print("#XPS Gathering Read failed, will try again")
-                pass
+            if len(gdat) == 3:
+                ret, npulses, nx = gdat
+            if npulses < 1 or ret != 0:
+                time.sleep(0.1)
+
             if time.time()-t0 > 5:
                 print("Failed to get gathering size after 5 seconds: return 0 points")
                 print("Gather Returned: ", ret, npulses, nx, self._xps, time.ctime())
                 return (0, ' \n')
-            if npulses < 1 or ret != 0:
-                time.sleep(0.05)
         dt.add("gather num %d npulses=%d (%d)" % (ret, npulses, self.nsegments))
         counter = 0
         while npulses < 1 and counter < 5:
@@ -1177,7 +1215,7 @@ class NewportXPS:
         try:
             ret, buff = self._xps.GatheringDataMultipleLinesGet(self._sid, 0, npulses)
         except ValueError:
-            print("Failed to read gathering: ", ret, buff)
+            print("Failed to read gathering: ", ret)
             return (0, ' \n')
         dt.add("gather after multilinesget  %d" % ret)
         nchunks = -1
@@ -1231,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:
@@ -1264,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}
@@ -1302,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):
@@ -1315,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']
@@ -1337,9 +1385,8 @@ class NewportXPS:
 
         outputs = []
         for out in self.gather_outputs:
-            for i, ax in enumerate(traj['axes']):
+            for ax in traj['axes']:
                 outputs.append(f'{self.traj_group}.{ax}.{out}')
-                # move_kws[ax] = float(traj['start'][i])
 
         o = " ".join(outputs)
         self.gather_titles = f"{self.gather_header}\n#{o}\n"
@@ -1350,7 +1397,7 @@ class NewportXPS:
                                                            2, step_number + 1, dtime)
         self.check_error(err, msg="MultipleAxesPVTPulseOutputSet", with_raise=False)
 
-        err, ret = self._xps.MultipleAxesPVTVerification(self._sid, self.traj_group, traj_file)
+        err, _ = self._xps.MultipleAxesPVTVerification(self._sid, self.traj_group, traj_file)
         self.check_error(err, msg="MultipleAxesPVTVerification", with_raise=False)
 
         buffer = ('Always', self.traj_group + '.PVT.TrajectoryPulse')
@@ -1363,7 +1410,7 @@ class NewportXPS:
                                                                  ('',), ('',), ('',), ('',))
         self.check_error(err, msg="EventExtendedConfigurationActionSet", with_raise=False)
 
-        eventID, m = self._xps.EventExtendedStart(self._sid)
+        eventID, _ = self._xps.EventExtendedStart(self._sid)
 
         self._xps.MultipleAxesPVTExecution(self._sid, self.traj_group, traj_file, 1)
         self._xps.EventExtendedRemove(self._sid, eventID)
@@ -1371,15 +1418,13 @@ class NewportXPS:
 
         npulses = 0
         if save:
-            npulses, outbuff = self.read_and_save(outfile)
+            npulses, _ = self.read_and_save(outfile)
 
         self._xps.GroupMoveRelative(self._sid, self.traj_group, ramps)
         return npulses
 
 
-
 if __name__ == '__main__':
-    import sys
     ipaddr = sys.argv[1]
     x = NewportXPS(ipaddr)
     x.read_systemini()

newportxps-2026.1.0/newportxps/version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '2026.1.0'
+__version_tuple__ = version_tuple = (2026, 1, 0)
+
+__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-0.9 → newportxps-2026.1.0/newportxps.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: newportxps
-Version: 0.9
+Version: 2026.1.0
 Summary: Python interface to Newport XPS motion controllers
 Author-email: Matthew Newville <newville@cars.uchicago.edu>
-License: BSD License
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/pyepics/newportxps/
 Keywords: motion control,data collection
 Classifier: Development Status :: 5 - Production/Stable
@@ -11,16 +11,14 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Other Audience
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: Implementation :: Jython
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Education
 Classifier: Topic :: Scientific/Engineering
@@ -29,11 +27,13 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pysftp
+Requires-Dist: paramiko
 Requires-Dist: numpy
+Requires-Dist: tabulate
+Dynamic: license-file
 
 # newportxps
 

{newportxps-0.9 → 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-2026.1.0/newportxps.egg-info/requires.txt

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

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

@@ -16,13 +16,14 @@ authors = [
     {name="Matthew Newville", email="newville@cars.uchicago.edu"},
 ]
 
-dependencies = ['pysftp', 'numpy']
+dependencies = ['paramiko', 'numpy', 'tabulate']
 description = "Python interface to Newport XPS motion controllers"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 keywords = ["motion control", "data collection"]
 
-license = {text = "BSD License"}
+license = "MIT"
+license-files = ["LICENSE"]
 
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -30,16 +31,14 @@ classifiers = [
     "Intended Audience :: Education",
     "Intended Audience :: Other Audience",
     "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: Implementation :: Jython",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Programming Language :: Python :: Implementation :: PyPy",
     "Topic :: Education",
     "Topic :: Scientific/Engineering",
@@ -53,3 +52,6 @@ classifiers = [
 
 [project.urls]
 Homepage = "https://github.com/pyepics/newportxps/"
+
+[project.scripts]
+xps = "newportxps:xps_main"

newportxps-0.9/LICENSE

@@ -1,25 +0,0 @@
-BSD 2-Clause License
-
-Copyright (c) 2018, Matthew Newville, The University of Chicago
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

newportxps-0.9/newportxps/version.py

@@ -1,16 +0,0 @@
-# file generated by setuptools_scm
-# don't change, don't track in version control
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple, Union
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-else:
-    VERSION_TUPLE = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-
-__version__ = version = '0.9'
-__version_tuple__ = version_tuple = (0, 9)

newportxps-0.9/newportxps.egg-info/requires.txt

@@ -1,2 +0,0 @@
-pysftp
-numpy