Skip to content

PyTao

Class to run and interact with Tao. Requires libtao shared object.

Setup:

import os import sys TAO_PYTHON_DIR=os.environ['ACC_ROOT_DIR'] + '/tao/python' sys.path.insert(0, TAO_PYTHON_DIR)

import tao_ctypes tao = tao_ctypes.Tao() tao.init("command line args here...")

Source code in pytao/tao_ctypes/core.py 
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
class Tao:
    """
    Class to run and interact with Tao. Requires libtao shared object.

    Setup:

    import os
    import sys
    TAO_PYTHON_DIR=os.environ['ACC_ROOT_DIR'] + '/tao/python'
    sys.path.insert(0, TAO_PYTHON_DIR)

    import tao_ctypes
    tao = tao_ctypes.Tao()
    tao.init("command line args here...")
    """

    #---------------------------------------------

    def __init__(self, init='', so_lib=''):
        # TL/DR; Leave this import out of the global scope.
        #
        # Make it lazy import to avoid cyclical dependency.
        # at __init__.py there is an import for Tao which
        # would cause interface_commands to be imported always
        # once we import pytao.
        # If by any chance the interface_commands.py is broken and
        # we try to autogenerate it will complain about the broken
        # interface_commands file.

        from pytao import interface_commands 
        from pytao.tao_ctypes import extra_commands

        # Library needs to be set.
        self.so_lib_file = None
        if so_lib == '':
            # Search
            ACC_ROOT_DIR = os.getenv('ACC_ROOT_DIR', '')
            if ACC_ROOT_DIR:
                BASE_DIR = os.path.join(ACC_ROOT_DIR, 'production', 'lib')
                self.so_lib_file = find_libtao(BASE_DIR)
        else:
            self.so_lib_file = so_lib

        if self.so_lib_file:
            self.so_lib = ctypes.CDLL(self.so_lib_file)
        else:
            lib, lib_file = auto_discovery_libtao()

            if lib:
                self.so_lib = lib
                self.so_lib_file = lib_file
            else:
                raise ValueError(f'Shared object libtao library not found.')

        self.so_lib.tao_c_out_io_buffer_get_line.restype = ctypes.c_char_p
        self.so_lib.tao_c_out_io_buffer_reset.restype = None

        # Extra methods
        self._import_commands(interface_commands)
        self._import_commands(extra_commands)

        try:
            self.register_cell_magic()
        except:
            pass

        if init:
            self.init(init)


    def _import_commands(self, module):
        deny_list = getattr(module, '__deny_list', [])
        # Add in methods from `interface_commands`
        methods = [m for m in dir(module) if not m.startswith('__') and m not in deny_list]
        for m in methods:
            func = module.__dict__[m]
            setattr(self, m, types.MethodType(func, self))            

    #---------------------------------------------
    # Used by init and cmd routines

    def get_output(self, reset=True):
        """
        Returns a list of output strings.
        If reset, the internal Tao buffers will be reset.
        """
        n_lines = self.so_lib.tao_c_out_io_buffer_num_lines()
        lines = [self.so_lib.tao_c_out_io_buffer_get_line(i).decode('utf-8') for i in range(1, n_lines+1)]
        if reset:
            self.so_lib.tao_c_out_io_buffer_reset()
        return lines

    def reset_output(self):
        """
        Resets all output buffers
        """
        self.so_lib.tao_c_out_io_buffer_reset()

    #---------------------------------------------
    # Init Tao

    def init(self, cmd):

        if not tao_ctypes.initialized:
            logger.debug(f'Initializing Tao with: {cmd}')
            err = self.so_lib.tao_c_init_tao(cmd.encode('utf-8'))
            if err != 0:
                raise ValueError(f'Unable to init Tao with: {cmd}')
            tao_ctypes.initialized = True
            return self.get_output()
        else:
            # Reinit
            return self.cmd(f'reinit tao -clear {cmd}', raises=True)

    #---------------------------------------------
    # Send a command to Tao and return the output

    def cmd(self, cmd, raises=True):
        """
        Runs a command, and returns the text output

        cmd: command string
        raises: will raise an exception of [ERROR or [FATAL is detected in the output

        Returns a list of strings
        """

        logger.debug(f'Tao> {cmd}')

        self.so_lib.tao_c_command(cmd.encode('utf-8'))
        lines = self.get_output()

        # Error checking
        if not raises:
            return lines

        err = error_in_lines(lines)
        if err:
            raise RuntimeError(f'Command: {cmd} causes error: {err}')

        return lines

    def cmds(self, cmds, 
             suppress_lattice_calc=True, 
             suppress_plotting=True, 
             raises=True):
        """
        Runs a list of commands

        Args:
            cmds: list of commands

            suppress_lattice_calc: bool, optional
                If True, will suppress lattice calc when applying the commands
                Default: True

            suppress_plotting: bool, optional
                If True, will suppress plotting when applying commands
                Default: True

            raises: bool, optional
                If True will raise an exception of [ERROR or [FATAL is detected in the 
                output
                Default: True

        Returns:
            list of results corresponding to the commands

        """
        # Get globals to detect plotting
        g = self.tao_global()
        ploton, laton = g['plot_on'], g['lattice_calc_on']

        if suppress_plotting and ploton:
            self.cmd('set global plot_on = F')
        if suppress_lattice_calc and laton:
            self.cmd('set global lattice_calc_on = F')            

        # Actually apply commands
        results = []
        for cmd in cmds:
            res = self.cmd(cmd, raises=raises)
            results.append(res)

        if suppress_plotting and ploton:
            self.cmd('set global plot_on = T')
        if suppress_lattice_calc and laton:
            self.cmd('set global lattice_calc_on = T')               

        return results



    #---------------------------------------------
    # Get real array output.
    # Only python commands that load the real array buffer can be used with this method.

    def cmd_real (self, cmd, raises=True):
        logger.debug(f'Tao> {cmd}')

        self.so_lib.tao_c_command(cmd.encode('utf-8'))
        n = self.so_lib.tao_c_real_array_size()
        # Empty array
        if n == 0:
            return np.array([], dtype=float)     

        self.so_lib.tao_c_get_real_array.restype = ctypes.POINTER(ctypes.c_double * n)

        # Check the output for errors
        lines = self.get_output(reset=False)
        err = error_in_lines(lines)
        if err:
            self.reset_output()
            if raises:
                raise RuntimeError(err)
            else:
                return None

        # Extract array data
        # This is a pointer to the scratch space.
        array = np.ctypeslib.as_array(
            (ctypes.c_double * n).from_address(ctypes.addressof(self.so_lib.tao_c_get_real_array().contents)))

        array = array.copy()
        self.reset_output()

        return array  

    #----------
    # Get integer array output.
    # Only python commands that load the integer array buffer can be used with this method.

    def cmd_integer (self, cmd, raises=True):
        logger.debug(f'Tao> {cmd}')

        self.so_lib.tao_c_command(cmd.encode('utf-8'))
        n = self.so_lib.tao_c_integer_array_size()
        # Empty array
        if n == 0:
            return np.array([], dtype=int)

        self.so_lib.tao_c_get_integer_array.restype = ctypes.POINTER(ctypes.c_int * n)

        # Check the output for errors
        lines = self.get_output(reset=False)
        err = error_in_lines(lines)
        if err:
            self.reset_output()
            if raises:
                raise RuntimeError(err)
            else:
                return None  

        # Extract array data
        # This is a pointer to the scratch space.
        array = np.ctypeslib.as_array(
            (ctypes.c_int * n).from_address(ctypes.addressof(self.so_lib.tao_c_get_integer_array().contents)))

        array = array.copy()
        self.reset_output()

        return array  



    #---------------------------------------------

    def register_cell_magic(self):
      """
      Registers a cell magic in Jupyter notebooks
      Invoke by
      %%tao
      sho lat
      """

      from IPython.core.magic import register_cell_magic
      @register_cell_magic
      def tao(line, cell):
          cell = cell.format(**globals())
          cmds=cell.split('\n')
          output = []
          for c in cmds:
              print('-------------------------')
              print('Tao> '+c)
              res = self.cmd(c)
              for l in res:
                   print(l)
      del tao

__init__(init='', so_lib='')

Source code in pytao/tao_ctypes/core.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def __init__(self, init='', so_lib=''):
    # TL/DR; Leave this import out of the global scope.
    #
    # Make it lazy import to avoid cyclical dependency.
    # at __init__.py there is an import for Tao which
    # would cause interface_commands to be imported always
    # once we import pytao.
    # If by any chance the interface_commands.py is broken and
    # we try to autogenerate it will complain about the broken
    # interface_commands file.

    from pytao import interface_commands 
    from pytao.tao_ctypes import extra_commands

    # Library needs to be set.
    self.so_lib_file = None
    if so_lib == '':
        # Search
        ACC_ROOT_DIR = os.getenv('ACC_ROOT_DIR', '')
        if ACC_ROOT_DIR:
            BASE_DIR = os.path.join(ACC_ROOT_DIR, 'production', 'lib')
            self.so_lib_file = find_libtao(BASE_DIR)
    else:
        self.so_lib_file = so_lib

    if self.so_lib_file:
        self.so_lib = ctypes.CDLL(self.so_lib_file)
    else:
        lib, lib_file = auto_discovery_libtao()

        if lib:
            self.so_lib = lib
            self.so_lib_file = lib_file
        else:
            raise ValueError(f'Shared object libtao library not found.')

    self.so_lib.tao_c_out_io_buffer_get_line.restype = ctypes.c_char_p
    self.so_lib.tao_c_out_io_buffer_reset.restype = None

    # Extra methods
    self._import_commands(interface_commands)
    self._import_commands(extra_commands)

    try:
        self.register_cell_magic()
    except:
        pass

    if init:
        self.init(init)

cmd(cmd, raises=True)

Runs a command, and returns the text output

cmd: command string raises: will raise an exception of [ERROR or [FATAL is detected in the output

Returns a list of strings

Source code in pytao/tao_ctypes/core.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
def cmd(self, cmd, raises=True):
    """
    Runs a command, and returns the text output

    cmd: command string
    raises: will raise an exception of [ERROR or [FATAL is detected in the output

    Returns a list of strings
    """

    logger.debug(f'Tao> {cmd}')

    self.so_lib.tao_c_command(cmd.encode('utf-8'))
    lines = self.get_output()

    # Error checking
    if not raises:
        return lines

    err = error_in_lines(lines)
    if err:
        raise RuntimeError(f'Command: {cmd} causes error: {err}')

    return lines

cmds(cmds, suppress_lattice_calc=True, suppress_plotting=True, raises=True)

Runs a list of commands

Parameters:

Name Type Description Default
cmds

list of commands

 required
suppress_lattice_calc

bool, optional If True, will suppress lattice calc when applying the commands Default: True

 True
suppress_plotting

bool, optional If True, will suppress plotting when applying commands Default: True

 True
raises

bool, optional If True will raise an exception of [ERROR or [FATAL is detected in the output Default: True

 True

Returns:

Type Description

list of results corresponding to the commands
Source code in pytao/tao_ctypes/core.py 
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
def cmds(self, cmds, 
         suppress_lattice_calc=True, 
         suppress_plotting=True, 
         raises=True):
    """
    Runs a list of commands

    Args:
        cmds: list of commands

        suppress_lattice_calc: bool, optional
            If True, will suppress lattice calc when applying the commands
            Default: True

        suppress_plotting: bool, optional
            If True, will suppress plotting when applying commands
            Default: True

        raises: bool, optional
            If True will raise an exception of [ERROR or [FATAL is detected in the 
            output
            Default: True

    Returns:
        list of results corresponding to the commands

    """
    # Get globals to detect plotting
    g = self.tao_global()
    ploton, laton = g['plot_on'], g['lattice_calc_on']

    if suppress_plotting and ploton:
        self.cmd('set global plot_on = F')
    if suppress_lattice_calc and laton:
        self.cmd('set global lattice_calc_on = F')            

    # Actually apply commands
    results = []
    for cmd in cmds:
        res = self.cmd(cmd, raises=raises)
        results.append(res)

    if suppress_plotting and ploton:
        self.cmd('set global plot_on = T')
    if suppress_lattice_calc and laton:
        self.cmd('set global lattice_calc_on = T')               

    return results

get_output(reset=True)

Returns a list of output strings. If reset, the internal Tao buffers will be reset.

Source code in pytao/tao_ctypes/core.py 
100
101
102
103
104
105
106
107
108
109
def get_output(self, reset=True):
    """
    Returns a list of output strings.
    If reset, the internal Tao buffers will be reset.
    """
    n_lines = self.so_lib.tao_c_out_io_buffer_num_lines()
    lines = [self.so_lib.tao_c_out_io_buffer_get_line(i).decode('utf-8') for i in range(1, n_lines+1)]
    if reset:
        self.so_lib.tao_c_out_io_buffer_reset()
    return lines

register_cell_magic()

Registers a cell magic in Jupyter notebooks Invoke by %%tao sho lat

Source code in pytao/tao_ctypes/core.py 
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
def register_cell_magic(self):
  """
  Registers a cell magic in Jupyter notebooks
  Invoke by
  %%tao
  sho lat
  """

  from IPython.core.magic import register_cell_magic
  @register_cell_magic
  def tao(line, cell):
      cell = cell.format(**globals())
      cmds=cell.split('\n')
      output = []
      for c in cmds:
          print('-------------------------')
          print('Tao> '+c)
          res = self.cmd(c)
          for l in res:
               print(l)
  del tao

reset_output()

Resets all output buffers

Source code in pytao/tao_ctypes/core.py 
111
112
113
114
115
def reset_output(self):
    """
    Resets all output buffers
    """
    self.so_lib.tao_c_out_io_buffer_reset()

beam(tao, *, ix_uni='', verbose=False, as_dict=True, raises=True)

Output beam parameters that are not in the beam_init structure.

Parameters

ix_uni : optional

Returns

string_list

Notes

Command syntax: python beam {ix_uni}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe.

Note: To set beam_init parameters use the "set beam" command.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/csr_beam_tracking/tao.init args: ix_uni: 1

Source code in pytao/interface_commands.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def beam(tao, *, ix_uni='', verbose=False, as_dict=True, raises=True):
    """

    Output beam parameters that are not in the beam_init structure.

    Parameters
    ----------
    ix_uni : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python beam {ix_uni}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.

    Note: To set beam_init parameters use the "set beam" command.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/csr_beam_tracking/tao.init
     args:
       ix_uni: 1

    """
    cmd = f'python beam {ix_uni}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='beam', cmd_type='string_list')

beam_init(tao, *, ix_uni='', verbose=False, as_dict=True, raises=True)

Output beam_init parameters.

Parameters

ix_uni : optional

Returns

string_list

Notes

Command syntax: python beam_init {ix_uni}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe.

Note: To set beam_init parameters use the "set beam_init" command

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/csr_beam_tracking/tao.init args: ix_uni: 1

Source code in pytao/interface_commands.py 
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def beam_init(tao, *, ix_uni='', verbose=False, as_dict=True, raises=True):
    """

    Output beam_init parameters.

    Parameters
    ----------
    ix_uni : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python beam_init {ix_uni}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.

    Note: To set beam_init parameters use the "set beam_init" command

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/csr_beam_tracking/tao.init
     args:
       ix_uni: 1

    """
    cmd = f'python beam_init {ix_uni}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='beam_init', cmd_type='string_list')

bmad_com(tao, *, verbose=False, as_dict=True, raises=True)

Output bmad_com structure components.

Returns

string_list

Notes

Command syntax: python bmad_com

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def bmad_com(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output bmad_com structure components.

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python bmad_com

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:

    """
    cmd = f'python bmad_com'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='bmad_com', cmd_type='string_list')

branch1(tao, ix_uni, ix_branch, *, verbose=False, as_dict=True, raises=True)

Output lattice branch information for a particular lattice branch.

Parameters

ix_uni : "" ix_branch : ""

Returns

string_list

Notes

Command syntax: python branch1 {ix_uni}@{ix_branch}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe. {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1 ix_branch: 0

Source code in pytao/interface_commands.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
def branch1(tao, ix_uni, ix_branch, *, verbose=False, as_dict=True, raises=True):
    """

    Output lattice branch information for a particular lattice branch.

    Parameters
    ----------
    ix_uni : ""
    ix_branch : ""

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python branch1 {ix_uni}@{ix_branch}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ix_uni: 1
       ix_branch: 0

    """
    cmd = f'python branch1 {ix_uni}@{ix_branch}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='branch1', cmd_type='string_list')

building_wall_graph(tao, graph, *, verbose=False, as_dict=True, raises=True)

Output (x, y) points for drawing the building wall for a particular graph.

Parameters

graph

Returns

string_list

Notes

Command syntax: python building_wall_graph {graph}

Where

{graph} is a plot region graph name.

Note: The graph defines the coordinate system for the (x, y) points.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall args: graph: floor_plan.g

Source code in pytao/interface_commands.py 
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
def building_wall_graph(tao, graph, *, verbose=False, as_dict=True, raises=True):
    """

    Output (x, y) points for drawing the building wall for a particular graph.

    Parameters
    ----------
    graph

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python building_wall_graph {graph}

    Where:
      {graph} is a plot region graph name.

    Note: The graph defines the coordinate system for the (x, y) points.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall
     args:
       graph: floor_plan.g

    """
    cmd = f'python building_wall_graph {graph}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='building_wall_graph', cmd_type='string_list')

building_wall_list(tao, *, ix_section='', verbose=False, as_dict=True, raises=True)

Output List of building wall sections or section points

Parameters

ix_section : optional

Returns

string_list

Notes

Command syntax: python building_wall_list {ix_section}

Where

{ix_section} is a building wall section index.

If {ix_section} is not present, a list of building wall sections is given. If {ix_section} is present, a list of section points is given.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall args: ix_section:

2

init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall args: ix_section: 1

Source code in pytao/interface_commands.py 
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
def building_wall_list(tao, *, ix_section='', verbose=False, as_dict=True, raises=True):
    """

    Output List of building wall sections or section points

    Parameters
    ----------
    ix_section : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python building_wall_list {ix_section}

    Where:
      {ix_section} is a building wall section index.

    If {ix_section} is not present, a list of building wall sections is given.
    If {ix_section} is present, a list of section points is given.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall
     args:
       ix_section:

    Example: 2
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall
     args:
       ix_section: 1

    """
    cmd = f'python building_wall_list {ix_section}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='building_wall_list', cmd_type='string_list')

building_wall_point(tao, ix_section, ix_point, z, x, radius, z_center, x_center, *, verbose=False, as_dict=True, raises=True)

add or delete a building wall point

Parameters

ix_section ix_point z x radius z_center x_center

Returns

None

Notes

Command syntax: python building_wall_point {ix_section}^^{ix_point}^^{z}^^{x}^^{radius}^^{z_center}^^{x_center}

Where

{ix_section} -- Section index. {ix_point} -- Point index. Points of higher indexes will be moved up if adding a point and down if deleting. {z}, etc... -- See tao_building_wall_point_struct components. -- If {z} is set to "delete" then delete the point.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall args: ix_section: 1 ix_point: 1 z: 0 x: 0 radius: 0 z_center: 0 x_center: 0

Source code in pytao/interface_commands.py 
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
def building_wall_point(tao, ix_section, ix_point, z, x, radius, z_center, x_center, *, verbose=False, as_dict=True, raises=True):
    """

    add or delete a building wall point

    Parameters
    ----------
    ix_section
    ix_point
    z
    x
    radius
    z_center
    x_center

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python building_wall_point {ix_section}^^{ix_point}^^{z}^^{x}^^{radius}^^{z_center}^^{x_center}

    Where:
      {ix_section}    -- Section index.
      {ix_point}      -- Point index. Points of higher indexes will be moved up 
                           if adding a point and down if deleting.
      {z}, etc...     -- See tao_building_wall_point_struct components.
                      -- If {z} is set to "delete" then delete the point.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall
     args:
       ix_section: 1
       ix_point: 1
       z: 0
       x: 0
       radius: 0
       z_center: 0
       x_center: 0

    """
    cmd = f'python building_wall_point {ix_section}^^{ix_point}^^{z}^^{x}^^{radius}^^{z_center}^^{x_center}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='building_wall_point', cmd_type='None')

building_wall_section(tao, ix_section, sec_name, sec_constraint, *, verbose=False, as_dict=True, raises=True)

Add or delete a building wall section

Parameters

ix_section sec_name sec_constraint

Returns

None

Notes

Command syntax: python building_wall_section {ix_section}^^{sec_name}^^{sec_constraint}

Where

{ix_section} -- Section index. Sections with higher indexes will be moved up if adding a section and down if deleting. {sec_name} -- Section name. {sec_constraint} -- A section constraint name or "delete". Must be one of: delete -- Delete section. Anything else will add the section. none left_side right_side

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_section: 1 sec_name: test sec_constraint: none

Source code in pytao/interface_commands.py 
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
def building_wall_section(tao, ix_section, sec_name, sec_constraint, *, verbose=False, as_dict=True, raises=True):
    """

    Add or delete a building wall section

    Parameters
    ----------
    ix_section
    sec_name
    sec_constraint

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python building_wall_section {ix_section}^^{sec_name}^^{sec_constraint}

    Where:
      {ix_section}      -- Section index. Sections with higher indexes will be
                             moved up if adding a section and down if deleting.
      {sec_name}        -- Section name.
      {sec_constraint}  -- A section constraint name or "delete". Must be one of:
          delete          -- Delete section. Anything else will add the section.
          none
          left_side
          right_side

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ix_section: 1
       sec_name: test
       sec_constraint: none

    """
    cmd = f'python building_wall_section {ix_section}^^{sec_name}^^{sec_constraint}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='building_wall_section', cmd_type='None')

bunch1(tao, ele_id, coordinate, *, which='model', ix_bunch='1', verbose=False, as_dict=True, raises=True)

Outputs Bunch parameters at the exit end of a given lattice element.

Parameters

ele_id coordinate which : default=model ix_bunch : default=1

Returns

real_array if coordinate != 'state' integer_array if coordinate == 'state'

Notes

Command syntax: python bunch1 {ele_id}|{which} {ix_bunch} {coordinate}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {ix_bunch} is the bunch index. {coordinate} is one of: x, px, y, py, z, pz, "s", "t", "charge", "p0c", "state"

For example, if {coordinate} = "px", the phase space px coordinate of each particle of the bunch is displayed. The "state" of a particle is an integer. A value of 1 means alive and any other value means the particle has been lost.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/csr_beam_tracking/tao.init args: ele_id: end coordinate: x which: model ix_bunch: 1

Source code in pytao/interface_commands.py 
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
def bunch1(tao, ele_id, coordinate, *, which='model', ix_bunch='1', verbose=False, as_dict=True, raises=True):
    """

    Outputs Bunch parameters at the exit end of a given lattice element.

    Parameters
    ----------
    ele_id
    coordinate
    which : default=model
    ix_bunch : default=1

    Returns
    -------
    real_array
        if coordinate != 'state'
    integer_array
        if coordinate == 'state'

    Notes
    -----
    Command syntax:
      python bunch1 {ele_id}|{which} {ix_bunch} {coordinate}

    Where:
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {ix_bunch} is the bunch index.
      {coordinate} is one of: x, px, y, py, z, pz, "s", "t", "charge", "p0c", "state"

    For example, if {coordinate} = "px", the phase space px coordinate of each particle
    of the bunch is displayed. The "state" of a particle is an integer. A value of 1 means
    alive and any other value means the particle has been lost.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/csr_beam_tracking/tao.init
     args:
       ele_id: end
       coordinate: x
       which: model
       ix_bunch: 1

    """
    cmd = f'python bunch1 {ele_id}|{which} {ix_bunch} {coordinate}'
    if verbose: print(cmd)
    if coordinate != 'state':
        return __execute(tao, cmd, as_dict, raises, method_name='bunch1', cmd_type='real_array')
    if coordinate == 'state':
        return __execute(tao, cmd, as_dict, raises, method_name='bunch1', cmd_type='integer_array')

bunch_comb(tao, who, *, ix_uni='', ix_branch='', ix_bunch='1', flags='-array_out', verbose=False, as_dict=True, raises=True)

Outputs bunch parameters at a comb point. Also see the "write bunch_comb" and "show bunch -comb" commands.

Parameters

who ix_uni : optional ix_branch : optional ix_bunch : default=1 flags : default=-array_out

Returns

string_list if '-array_out' not in flags real_array if '-array_out' in flags

Notes

Command syntax: python bunch_comb {flags} {who} {ix_uni}@{ix_branch} {ix_bunch}

Where

{flags} are optional switches: -array_out : If present, the output will be available in the tao_c_interface_com%c_real. {ix_uni} is a universe index. Defaults to s%global%default_universe. {ix_branch} is a branch index. Defaults to s%global%default_branch. {ix_bunch} is the bunch index. Defaults to 1. {who} is one of: x, px, y, py, z, pz, t, s, spin.x, spin.y, spin.z, p0c, beta -- centroid x.Q, y.Q, z.Q, a.Q, b.Q, c.Q where Q is one of: beta, alpha, gamma, phi, eta, etap, sigma, sigma_p, emit, norm_emit sigma.IJ where I, J in range [1,6] rel_min.I, rel_max.I where I in range [1,6] charge_live, n_particle_live, n_particle_lost_in_ele, ix_ele

Note: If ix_uni or ix_branch is present, "@" must be present.

Example

python bunch_comb py 2@1 1

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/csr_beam_tracking/tao.init args: who: x.beta

Source code in pytao/interface_commands.py 
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
def bunch_comb(tao, who, *, ix_uni='', ix_branch='', ix_bunch='1', flags='-array_out', verbose=False, as_dict=True, raises=True):
    """

    Outputs bunch parameters at a comb point. 
    Also see the "write bunch_comb" and "show bunch -comb" commands.

    Parameters
    ----------
    who
    ix_uni : optional
    ix_branch : optional
    ix_bunch : default=1
    flags : default=-array_out

    Returns
    -------
    string_list
        if '-array_out' not in flags
    real_array
        if '-array_out' in flags

    Notes
    -----
    Command syntax:
      python bunch_comb {flags} {who} {ix_uni}@{ix_branch} {ix_bunch}

    Where:
      {flags} are optional switches:
          -array_out : If present, the output will be available in the tao_c_interface_com%c_real.
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {ix_branch} is a branch index. Defaults to s%global%default_branch.
      {ix_bunch} is the bunch index. Defaults to 1.
      {who} is one of:
          x, px, y, py, z, pz, t, s, spin.x, spin.y, spin.z, p0c, beta     -- centroid 
          x.Q, y.Q, z.Q, a.Q, b.Q, c.Q where Q is one of: beta, alpha, gamma, phi, eta, etap,
                                                                    sigma, sigma_p, emit, norm_emit
        sigma.IJ where I, J in range [1,6]
        rel_min.I, rel_max.I where I in range [1,6]
        charge_live, n_particle_live, n_particle_lost_in_ele, ix_ele

      Note: If ix_uni or ix_branch is present, "@" must be present.

    Example:
      python bunch_comb py 2@1 1

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/csr_beam_tracking/tao.init
     args:
       who: x.beta

    """
    cmd = f'python bunch_comb {flags} {who} {ix_uni}@{ix_branch} {ix_bunch}'
    if verbose: print(cmd)
    if '-array_out' not in flags:
        return __execute(tao, cmd, as_dict, raises, method_name='bunch_comb', cmd_type='string_list')
    if '-array_out' in flags:
        return __execute(tao, cmd, as_dict, raises, method_name='bunch_comb', cmd_type='real_array')

bunch_params(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Outputs bunch parameters at the exit end of a given lattice element.

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python bunch_params {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python bunch_params end|model ! parameters at model lattice element named "end".

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/csr_beam_tracking/tao.init args: ele_id: end which: model

Source code in pytao/interface_commands.py 
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
def bunch_params(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Outputs bunch parameters at the exit end of a given lattice element.

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python bunch_params {ele_id}|{which}

    Where:
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python bunch_params end|model  ! parameters at model lattice element named "end".

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/csr_beam_tracking/tao.init
     args:
       ele_id: end
       which: model

    """
    cmd = f'python bunch_params {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='bunch_params', cmd_type='string_list')

constraints(tao, who, *, verbose=False, as_dict=True, raises=True)

Output optimization data and variable parameters that contribute to the merit function.

Parameters

who

Returns

string_list

Notes

Command syntax: python constraints {who}

Where

{who} is one of: "data" or "var"

Data constraints output is

data name constraint type evaluation element name start element name end/reference element name measured value ref value (only relavent if global%opt_with_ref = T) model value base value (only relavent if global%opt_with_base = T) weight merit value location where merit is evaluated (if there is a range)

Var constraints output is: var name Associated varible attribute meas value ref value (only relavent if global%opt_with_ref = T) model value base value (only relavent if global%opt_with_base = T) weight merit value dmerit/dvar

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: who: data

2

init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: who:var

Source code in pytao/interface_commands.py 
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
def constraints(tao, who, *, verbose=False, as_dict=True, raises=True):
    """

    Output optimization data and variable parameters that contribute to the merit function.

    Parameters
    ----------
    who

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python constraints {who}

    Where:
      {who} is one of: "data" or "var"

    Data constraints output is:
      data name
      constraint type
      evaluation element name
      start element name
      end/reference element name
      measured value
      ref value (only relavent if global%opt_with_ref = T)
      model value
      base value (only relavent if global%opt_with_base = T)
      weight
      merit value
      location where merit is evaluated (if there is a range)
    Var constraints output is:
      var name
      Associated varible attribute
      meas value
      ref value (only relavent if global%opt_with_ref = T)
      model value
      base value (only relavent if global%opt_with_base = T)
      weight
      merit value
      dmerit/dvar

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       who: data

    Example: 2
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       who:var

    """
    cmd = f'python constraints {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='constraints', cmd_type='string_list')

da_aperture(tao, *, ix_uni='', verbose=False, as_dict=True, raises=True)

Output dynamic aperture data

Parameters

ix_uni : optional

Returns

string_list

Notes

Command syntax: python da_aperture {ix_uni}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe.

Source code in pytao/interface_commands.py 
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
def da_aperture(tao, *, ix_uni='', verbose=False, as_dict=True, raises=True):
    """

    Output dynamic aperture data

    Parameters
    ----------
    ix_uni : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python da_aperture {ix_uni}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.

    """
    cmd = f'python da_aperture {ix_uni}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='da_aperture', cmd_type='string_list')

da_params(tao, *, ix_uni='', verbose=False, as_dict=True, raises=True)

Output dynamic aperture input parameters

Parameters

ix_uni : optional

Returns

string_list

Notes

Command syntax: python da_params {ix_uni}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe.

Source code in pytao/interface_commands.py 
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
def da_params(tao, *, ix_uni='', verbose=False, as_dict=True, raises=True):
    """

    Output dynamic aperture input parameters

    Parameters
    ----------
    ix_uni : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python da_params {ix_uni}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.

    """
    cmd = f'python da_params {ix_uni}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='da_params', cmd_type='string_list')

data(tao, d2_name, d1_name, *, ix_uni='', dat_index='1', verbose=False, as_dict=True, raises=True)

Output Individual datum parameters.

Parameters

d2_name d1_name ix_uni : optional dat_index : default=1

Returns

string_list

Notes

Command syntax: python data {ix_uni}@{d2_name}.{d1_name}[{dat_index}]

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe. {d2_name} is the name of the d2_data structure the datum is in. {d1_datum} is the name of the d1_data structure the datum is in. {dat_index} is the index of the datum.

Use the "python data-d1" command to get detailed info on a specific d1 array.

Example

python data 1@orbit.x[10]

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: ix_uni: d2_name: twiss d1_name: end dat_index: 1

2

init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: ix_uni: 1 d2_name: twiss d1_name: end dat_index: 1

Source code in pytao/interface_commands.py 
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
def data(tao, d2_name, d1_name, *, ix_uni='', dat_index='1', verbose=False, as_dict=True, raises=True):
    """

    Output Individual datum parameters.

    Parameters
    ----------
    d2_name
    d1_name
    ix_uni : optional
    dat_index : default=1

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python data {ix_uni}@{d2_name}.{d1_name}[{dat_index}]

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {d2_name} is the name of the d2_data structure the datum is in.
      {d1_datum} is the name of the d1_data structure the datum is in.
      {dat_index} is the index of the datum.

    Use the "python data-d1" command to get detailed info on a specific d1 array.

    Example:
      python data 1@orbit.x[10]

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       ix_uni:
       d2_name: twiss
       d1_name: end 
       dat_index: 1  

    Example: 2
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       ix_uni: 1
       d2_name: twiss
       d1_name: end
       dat_index: 1

    """
    cmd = f'python data {ix_uni}@{d2_name}.{d1_name}[{dat_index}]'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='data', cmd_type='string_list')

data_d1_array(tao, d2_datum, *, ix_uni='', verbose=False, as_dict=True, raises=True)

Output list of d1 arrays for a given data_d2.

Parameters

d2_datum ix_uni : optional

Returns

string_list

Notes

Command syntax: python data_d1_array {d2_datum}

{d2_datum} should be of the form {ix_uni}@{d2_datum_name}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: ix_uni: 1 d2_datum: twiss

Source code in pytao/interface_commands.py 
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
def data_d1_array(tao, d2_datum, *, ix_uni='', verbose=False, as_dict=True, raises=True):
    """

    Output list of d1 arrays for a given data_d2.

    Parameters
    ----------
    d2_datum
    ix_uni : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python data_d1_array {d2_datum}

    {d2_datum} should be of the form
      {ix_uni}@{d2_datum_name}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       ix_uni: 1 
       d2_datum: twiss

    """
    cmd = f'python data_d1_array {d2_datum}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='data_d1_array', cmd_type='string_list')

data_d2(tao, d2_name, *, ix_uni='', verbose=False, as_dict=True, raises=True)

Output information on a d2_datum.

Parameters

d2_name ix_uni : optional

Returns

string_list

Notes

Command syntax: python data_d2 {ix_uni}@{d2_name}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe. {d2_name} is the name of the d2_data structure.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: ix_uni: 1 d2_name: twiss

Source code in pytao/interface_commands.py 
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
def data_d2(tao, d2_name, *, ix_uni='', verbose=False, as_dict=True, raises=True):
    """

    Output information on a d2_datum.

    Parameters
    ----------
    d2_name
    ix_uni : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python data_d2 {ix_uni}@{d2_name}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {d2_name} is the name of the d2_data structure.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       ix_uni: 1
       d2_name: twiss

    """
    cmd = f'python data_d2 {ix_uni}@{d2_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='data_d2', cmd_type='string_list')

data_d2_array(tao, ix_uni, *, verbose=False, as_dict=True, raises=True)

Output data d2 info for a given universe.

Parameters

ix_uni

Returns

string_list

Notes

Command syntax: python data_d2_array {ix_uni}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe.

Example

python data_d2_array 1

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni : 1

Source code in pytao/interface_commands.py 
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
def data_d2_array(tao, ix_uni, *, verbose=False, as_dict=True, raises=True):
    """

    Output data d2 info for a given universe.

    Parameters
    ----------
    ix_uni

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python data_d2_array {ix_uni}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.

    Example:
      python data_d2_array 1

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ix_uni : 1 

    """
    cmd = f'python data_d2_array {ix_uni}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='data_d2_array', cmd_type='string_list')

data_d2_create(tao, d2_name, n_d1_data, d_data_arrays_name_min_max, *, ix_uni='', verbose=False, as_dict=True, raises=True)

Create a d2 data structure along with associated d1 and data arrays.

Parameters

d2_name n_d1_data d_data_arrays_name_min_max ix_uni : optional

Returns

None

Notes

Command syntax: python data_d2_create {ix_uni}@{d2_name}^^{n_d1_data}^^{d_data_arrays_name_min_max}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe. {d2_name} is the name of the d2_data structure to create. {n_d1_data} is the number of associated d1 data structures. {d_data_arrays_name_min_max} has the form {name1}^^{lower_bound1}^^{upper_bound1}^^....^^{nameN}^^{lower_boundN}^^{upper_boundN} where {name} is the data array name and {lower_bound} and {upper_bound} are the bounds of the array.

Example

python data_d2_create 2@orbit^^2^^x^^0^^45^^y^^1^^47

This example creates a d2 data structure called "orbit" with two d1 structures called "x" and "y".

The "x" d1 structure has an associated data array with indexes in the range [0, 45]. The "y" d1 structure has an associated data arrray with indexes in the range [1, 47].

Use the "set data" command to set created datum parameters.

When setting multiple data parameters,

temporarily toggle s%global%lattice_calc_on to False

("set global lattice_calc_on = F") to prevent Tao trying to evaluate the partially created datum and generating unwanted error messages.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: ix_uni: 1 d2_name: orbit n_d1_data: 2 d_data_arrays_name_min_max: x^^0^^45^^y^^1^^47

Source code in pytao/interface_commands.py 
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
def data_d2_create(tao, d2_name, n_d1_data, d_data_arrays_name_min_max, *, ix_uni='', verbose=False, as_dict=True, raises=True):
    """

    Create a d2 data structure along with associated d1 and data arrays.

    Parameters
    ----------
    d2_name
    n_d1_data
    d_data_arrays_name_min_max
    ix_uni : optional

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python data_d2_create {ix_uni}@{d2_name}^^{n_d1_data}^^{d_data_arrays_name_min_max}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {d2_name} is the name of the d2_data structure to create.
      {n_d1_data} is the number of associated d1 data structures.
      {d_data_arrays_name_min_max} has the form
        {name1}^^{lower_bound1}^^{upper_bound1}^^....^^{nameN}^^{lower_boundN}^^{upper_boundN}
      where {name} is the data array name and {lower_bound} and {upper_bound} are the bounds of the array.

    Example:
      python data_d2_create 2@orbit^^2^^x^^0^^45^^y^^1^^47
    This example creates a d2 data structure called "orbit" with 
    two d1 structures called "x" and "y".

    The "x" d1 structure has an associated data array with indexes in the range [0, 45].
    The "y" d1 structure has an associated data arrray with indexes in the range [1, 47].

    Use the "set data" command to set created datum parameters.

    Note: When setting multiple data parameters, 
          temporarily toggle s%global%lattice_calc_on to False
      ("set global lattice_calc_on = F") to prevent Tao trying to 
          evaluate the partially created datum and generating unwanted error messages.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       ix_uni: 1
       d2_name: orbit
       n_d1_data: 2 
       d_data_arrays_name_min_max: x^^0^^45^^y^^1^^47

    """
    cmd = f'python data_d2_create {ix_uni}@{d2_name}^^{n_d1_data}^^{d_data_arrays_name_min_max}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='data_d2_create', cmd_type='None')

data_d2_destroy(tao, d2_name, *, ix_uni='', verbose=False, as_dict=True, raises=True)

Destroy a d2 data structure along with associated d1 and data arrays.

Parameters

d2_name ix_uni : optional

Returns

None

Notes

Command syntax: python data_d2_destroy {ix_uni}@{d2_name}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe. {d2_name} is the name of the d2_data structure to destroy.

Example

python data_d2_destroy 2@orbit

This destroys the orbit d2_data structure in universe 2.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: d2_name: orbit

Source code in pytao/interface_commands.py 
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
def data_d2_destroy(tao, d2_name, *, ix_uni='', verbose=False, as_dict=True, raises=True):
    """

    Destroy a d2 data structure along with associated d1 and data arrays.

    Parameters
    ----------
    d2_name
    ix_uni : optional

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python data_d2_destroy {ix_uni}@{d2_name}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {d2_name} is the name of the d2_data structure to destroy.

    Example:
      python data_d2_destroy 2@orbit
    This destroys the orbit d2_data structure in universe 2.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       d2_name: orbit

    """
    cmd = f'python data_d2_destroy {ix_uni}@{d2_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='data_d2_destroy', cmd_type='None')

data_d_array(tao, d2_name, d1_name, *, ix_uni='', verbose=False, as_dict=True, raises=True)

Output list of datums for a given d1_data structure.

Parameters

d2_name d1_name ix_uni : optional

Returns

datums: list of dicts Each dict has keys: 'ix_d1', 'data_type', 'merit_type', 'ele_ref_name', 'ele_start_name', 'ele_name', 'meas_value', 'model_value', 'design_value', 'useit_opt', 'useit_plot', 'good_user', 'weight', 'exists'

Notes

Command syntax: python data_d_array {ix_uni}@{d2_name}.{d1_name}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe. {d2_name} is the name of the containing d2_data structure. {d1_name} is the name of the d1_data structure containing the array of datums.

Example

python data_d_array 1@orbit.x

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: ix_uni: 1 d2_name: twiss d1_name: end

Source code in pytao/interface_commands.py 
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
def data_d_array(tao, d2_name, d1_name, *, ix_uni='', verbose=False, as_dict=True, raises=True):
    """

    Output list of datums for a given d1_data structure.

    Parameters
    ----------
    d2_name
    d1_name
    ix_uni : optional

    Returns
    -------
    datums: list of dicts
        Each dict has keys:
        'ix_d1', 'data_type', 'merit_type', 
        'ele_ref_name', 'ele_start_name', 'ele_name', 
        'meas_value', 'model_value', 'design_value', 
        'useit_opt', 'useit_plot', 'good_user', 
        'weight', 'exists'

    Notes
    -----
    Command syntax:
      python data_d_array {ix_uni}@{d2_name}.{d1_name}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {d2_name} is the name of the containing d2_data structure.
      {d1_name} is the name of the d1_data structure containing the array of datums.

    Example:
      python data_d_array 1@orbit.x

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       ix_uni: 1 
       d2_name: twiss
       d1_name: end

    """
    cmd = f'python data_d_array {ix_uni}@{d2_name}.{d1_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='data_d_array', cmd_type='string_list')

data_parameter(tao, data_array, parameter, *, verbose=False, as_dict=True, raises=True)

Output an array of values for a particular datum parameter for a given array of datums,

Parameters

data_array parameter

Returns

string_list

Notes

Command syntax: python data_parameter {data_array} {parameter}

{parameter} may be any tao_data_struct parameter. Example: python data_parameter orbit.x model_value

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: data_array: twiss.end parameter: model_value

Source code in pytao/interface_commands.py 
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
def data_parameter(tao, data_array, parameter, *, verbose=False, as_dict=True, raises=True):
    """

    Output an array of values for a particular datum parameter for a given array of datums, 

    Parameters
    ----------
    data_array
    parameter

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python data_parameter {data_array} {parameter}

    {parameter} may be any tao_data_struct parameter.
    Example:
      python data_parameter orbit.x model_value

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       data_array: twiss.end 
       parameter: model_value

    """
    cmd = f'python data_parameter {data_array} {parameter}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='data_parameter', cmd_type='string_list')

data_set_design_value(tao, *, verbose=False, as_dict=True, raises=True)

Set the design (and base & model) values for all datums.

Returns

None

Notes

Command syntax: python data_set_design_value

Example

python data_set_design_value

Note: Use the "data_d2_create" and "datum_create" first to create datums.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args:

Source code in pytao/interface_commands.py 
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
def data_set_design_value(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Set the design (and base & model) values for all datums.

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python data_set_design_value

    Example:
      python data_set_design_value

    Note: Use the "data_d2_create" and "datum_create" first to create datums.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:

    """
    cmd = f'python data_set_design_value'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='data_set_design_value', cmd_type='None')

datum_create(tao, datum_name, data_type, *, ele_ref_name='', ele_start_name='', ele_name='', merit_type='', meas='0', good_meas='F', ref='0', good_ref='F', weight='0', good_user='T', data_source='lat', eval_point='END', s_offset='0', ix_bunch='0', invalid_value='0', spin_axis_n0_1='', spin_axis_n0_2='', spin_axis_n0_3='', spin_axis_l_1='', spin_axis_l_2='', spin_axis_l_3='', verbose=False, as_dict=True, raises=True)

Create a datum.

Parameters

datum_name ! EG: orb.x[3] data_type ! EG: orbit.x ele_ref_name : optional ele_start_name : optional ele_name : optional merit_type : optional meas : default=0 good_meas : default=F ref : default=0 good_ref : default=F weight : default=0 good_user : default=T data_source : default=lat eval_point : default=END s_offset : default=0 ix_bunch : default=0 invalid_value : default=0 spin_axis%n0(1) : optional spin_axis%n0(2) : optional spin_axis%n0(3) : optional spin_axis%l(1) : optional spin_axis%l(2) : optional spin_axis%l(3) : optional

Returns

string_list

Notes

Command syntax: python datum_create {datum_name}^^{data_type}^^{ele_ref_name}^^{ele_start_name}^^ {ele_name}^^{merit_type}^^{meas}^^{good_meas}^^{ref}^^ {good_ref}^^{weight}^^{good_user}^^{data_source}^^ {eval_point}^^{s_offset}^^{ix_bunch}^^{invalid_value}^^ {spin_axis%n0(1)}^^{spin_axis%n0(2)}^^{spin_axis%n0(3)}^^ {spin_axis%l(1)}^^{spin_axis%l(2)}^^{spin_axis%l(3)}

The 3 values for spin_axis%n0, as a group, are optional.

Also the 3 values for spin_axis%l are, as a group, optional.

Note: Use the "data_d2_create" first to create a d2 structure with associated d1 arrays. Note: After creating all your datums, use the "data_set_design_value" routine to set the design (and model) values.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: datum_name: twiss.end[6] data_type: beta.y ele_ref_name: ele_start_name: ele_name: P1 merit_type: target meas: 0 good_meas: T ref: 0 good_ref: T weight: 0.3 good_user: T data_source: lat eval_point: END s_offset: 0 ix_bunch: 1 invalid_value: 0

Source code in pytao/interface_commands.py 
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
def datum_create(tao, datum_name, data_type, *, ele_ref_name='', ele_start_name='', ele_name='', merit_type='', meas='0', good_meas='F', ref='0', good_ref='F', weight='0', good_user='T', data_source='lat', eval_point='END', s_offset='0', ix_bunch='0', invalid_value='0', spin_axis_n0_1='', spin_axis_n0_2='', spin_axis_n0_3='', spin_axis_l_1='', spin_axis_l_2='', spin_axis_l_3='', verbose=False, as_dict=True, raises=True):
    """

    Create a datum.

    Parameters
    ----------
    datum_name          ! EG: orb.x[3]
    data_type           ! EG: orbit.x
    ele_ref_name : optional
    ele_start_name : optional
    ele_name : optional
    merit_type : optional
    meas : default=0
    good_meas : default=F
    ref : default=0
    good_ref : default=F
    weight : default=0
    good_user : default=T
    data_source : default=lat
    eval_point : default=END
    s_offset : default=0
    ix_bunch : default=0
    invalid_value : default=0
    spin_axis%n0(1) : optional
    spin_axis%n0(2) : optional
    spin_axis%n0(3) : optional
    spin_axis%l(1) : optional
    spin_axis%l(2) : optional
    spin_axis%l(3) : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python datum_create {datum_name}^^{data_type}^^{ele_ref_name}^^{ele_start_name}^^
                          {ele_name}^^{merit_type}^^{meas}^^{good_meas}^^{ref}^^
                          {good_ref}^^{weight}^^{good_user}^^{data_source}^^
                          {eval_point}^^{s_offset}^^{ix_bunch}^^{invalid_value}^^
                          {spin_axis%n0(1)}^^{spin_axis%n0(2)}^^{spin_axis%n0(3)}^^
                          {spin_axis%l(1)}^^{spin_axis%l(2)}^^{spin_axis%l(3)}

    Note: The 3 values for spin_axis%n0, as a group, are optional. 
          Also the 3 values for spin_axis%l are, as a group, optional.
    Note: Use the "data_d2_create" first to create a d2 structure with associated d1 arrays.
    Note: After creating all your datums, use the "data_set_design_value" routine to 
          set the design (and model) values.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       datum_name: twiss.end[6]
       data_type: beta.y
       ele_ref_name:
       ele_start_name:
       ele_name: P1
       merit_type: target
       meas: 0
       good_meas: T
       ref: 0
       good_ref: T
       weight: 0.3
       good_user: T
       data_source: lat
       eval_point: END
       s_offset: 0
       ix_bunch: 1
       invalid_value: 0

    """
    cmd = f'python datum_create {datum_name}^^{data_type}^^{ele_ref_name}^^{ele_start_name}^^{ele_name}^^{merit_type}^^{meas}^^{good_meas}^^{ref}^^{good_ref}^^{weight}^^{good_user}^^{data_source}^^{eval_point}^^{s_offset}^^{ix_bunch}^^{invalid_value}^^{spin_axis_n0_1}^^{spin_axis_n0_2}^^{spin_axis_n0_3}^^{spin_axis_l_1}^^{spin_axis_l_2}^^{spin_axis_l_3}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='datum_create', cmd_type='string_list')

datum_has_ele(tao, datum_type, *, verbose=False, as_dict=True, raises=True)

Output whether a datum type has an associated lattice element

Parameters

datum_type

Returns

string_list

Notes

Command syntax: python datum_has_ele {datum_type}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: datum_type: twiss.end

Source code in pytao/interface_commands.py 
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
def datum_has_ele(tao, datum_type, *, verbose=False, as_dict=True, raises=True):
    """

    Output whether a datum type has an associated lattice element

    Parameters
    ----------
    datum_type

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python datum_has_ele {datum_type}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       datum_type: twiss.end 

    """
    cmd = f'python datum_has_ele {datum_type}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='datum_has_ele', cmd_type='string_list')

derivative(tao, *, verbose=False, as_dict=True, raises=True)

Output optimization derivatives

Returns

out : dict Dictionary with keys corresponding to universe indexes (int), with dModel_dVar as the value: np.ndarray with shape (n_data, n_var)

Notes

Command syntax: python derivative

Note: To save time, this command will not recalculate derivatives. Use the "derivative" command beforehand to recalcuate if needed.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args:

Source code in pytao/interface_commands.py 
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
def derivative(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output optimization derivatives

    Returns
    -------
    out : dict
        Dictionary with keys corresponding to universe indexes (int),
        with dModel_dVar as the value:
            np.ndarray with shape (n_data, n_var)    

    Notes
    -----
    Command syntax:
      python derivative

    Note: To save time, this command will not recalculate derivatives. 
    Use the "derivative" command beforehand to recalcuate if needed.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:

    """
    cmd = f'python derivative'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='derivative', cmd_type='string_list')

ele_ac_kicker(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output element ac_kicker parameters

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:ac_kicker {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:ac_kicker 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model

Source code in pytao/interface_commands.py 
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
def ele_ac_kicker(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element ac_kicker parameters

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:ac_kicker {ele_id}|{which}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:ac_kicker 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model

    """
    cmd = f'python ele:ac_kicker {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_ac_kicker', cmd_type='string_list')

ele_cartesian_map(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True)

Output element cartesian_map parameters

Parameters

ele_id index who which : default=model

Returns

string_list

Notes

Command syntax: python ele:cartesian_map {ele_id}|{which} {index} {who}

Where

{ele_id} is an element name or index {which} is one of: "model", "base" or "design" {index} is the index number in the ele%cartesian_map(:) array {who} is one of: "base", or "terms"

Example

python ele:cartesian_map 3@1>>7|model 2 base

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_em_field args: ele_id: 1@0>>1 which: model index: 1 who: base

Source code in pytao/interface_commands.py 
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
def ele_cartesian_map(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element cartesian_map parameters

    Parameters
    ----------
    ele_id
    index
    who
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:cartesian_map {ele_id}|{which} {index} {who}

    Where:
      {ele_id} is an element name or index
      {which} is one of: "model", "base" or "design"
      {index} is the index number in the ele%cartesian_map(:) array
      {who} is one of: "base", or "terms"

    Example:
      python ele:cartesian_map 3@1>>7|model 2 base
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_em_field
     args:
      ele_id: 1@0>>1
      which: model
      index: 1
      who: base

    """
    cmd = f'python ele:cartesian_map {ele_id}|{which} {index} {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_cartesian_map', cmd_type='string_list')

ele_chamber_wall(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True)

Output element beam chamber wall parameters

Parameters

ele_id index who which : default=model

Returns

string_list

Notes

Command syntax: python ele:chamber_wall {ele_id}|{which} {index} {who}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {index} is index of the wall. {who} is one of: "x" ! Return min/max in horizontal plane "y" ! Return min/max in vertical plane

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall3d args: ele_id: 1@0>>1 which: model index: 1 who: x

Source code in pytao/interface_commands.py 
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
def ele_chamber_wall(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element beam chamber wall parameters

    Parameters
    ----------
    ele_id
    index
    who
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:chamber_wall {ele_id}|{which} {index} {who}

    Where:
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {index} is index of the wall.
      {who} is one of:
        "x"       ! Return min/max in horizontal plane
        "y"       ! Return min/max in vertical plane

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall3d
     args:
      ele_id: 1@0>>1
      which: model
      index: 1
      who: x

    """
    cmd = f'python ele:chamber_wall {ele_id}|{which} {index} {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_chamber_wall', cmd_type='string_list')

ele_control_var(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output list of element control variables. Used for group, overlay and ramper type elements.

Parameters

ele_id which : default=model

Returns

dict of attributes and values

Notes

Command syntax: python ele:control_var {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:control_var 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>873 which: model

Source code in pytao/interface_commands.py 
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
def ele_control_var(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output list of element control variables.
    Used for group, overlay and ramper type elements.

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    dict of attributes and values

    Notes
    -----
    Command syntax:
      python ele:control_var {ele_id}|{which}

    Where:
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:control_var 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>873
      which: model

    """
    cmd = f'python ele:control_var {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_control_var', cmd_type='string_list')

ele_cylindrical_map(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True)

Output element cylindrical_map

Parameters

ele_id index who which : default=model

Returns

string_list

Notes

Command syntax: python ele:cylindrical_map {ele_id}|{which} {index} {who}

Where {ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {index} is the index number in the ele%cylindrical_map(:) array {who} is one of: "base", or "terms"

Example

python ele:cylindrical_map 3@1>>7|model 2 base

This gives map #2 of element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_em_field args: ele_id: 1@0>>5 which: model index: 1 who: base

Source code in pytao/interface_commands.py 
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
def ele_cylindrical_map(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element cylindrical_map

    Parameters
    ----------
    ele_id
    index
    who
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:cylindrical_map {ele_id}|{which} {index} {who}

    Where 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {index} is the index number in the ele%cylindrical_map(:) array
      {who} is one of: "base", or "terms"

    Example:
      python ele:cylindrical_map 3@1>>7|model 2 base
    This gives map #2 of element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_em_field
     args:
      ele_id: 1@0>>5
      which: model
      index: 1
      who: base

    """
    cmd = f'python ele:cylindrical_map {ele_id}|{which} {index} {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_cylindrical_map', cmd_type='string_list')

ele_elec_multipoles(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output element electric multipoles

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:elec_multipoles {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:elec_multipoles 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model

Source code in pytao/interface_commands.py 
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
def ele_elec_multipoles(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element electric multipoles

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:elec_multipoles {ele_id}|{which}

    Where:
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:elec_multipoles 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model

    """
    cmd = f'python ele:elec_multipoles {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_elec_multipoles', cmd_type='string_list')

ele_floor(tao, ele_id, *, which='model', where='end', verbose=False, as_dict=True, raises=True)

Output element floor coordinates. The output gives two lines. "Reference" is without element misalignments and "Actual" is with misalignments.

Parameters

ele_id which : default=model where : default=end

Returns

string_list

Notes

Command syntax: python ele:floor {ele_id}|{which} {where}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {where} is an optional argument which, if present, is one of beginning ! Upstream end center ! Middle of element end ! Downstream end (default)

Note: {where} ignored for photonic elements crystal, mirror, and multilayer_mirror.

Example

python ele:floor 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model where:

2

init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model where: center

Source code in pytao/interface_commands.py 
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
def ele_floor(tao, ele_id, *, which='model', where='end', verbose=False, as_dict=True, raises=True):
    """

    Output element floor coordinates. The output gives two lines. "Reference" is
    without element misalignments and "Actual" is with misalignments.

    Parameters
    ----------
    ele_id
    which : default=model
    where : default=end

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:floor {ele_id}|{which} {where}

    Where:
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {where} is an optional argument which, if present, is one of
        beginning  ! Upstream end
        center     ! Middle of element
        end        ! Downstream end (default)
    Note: {where} ignored for photonic elements crystal, mirror, and multilayer_mirror.

    Example:
      python ele:floor 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model
      where: 

    Example: 2
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model
      where: center

    """
    cmd = f'python ele:floor {ele_id}|{which} {where}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_floor', cmd_type='string_list')

ele_gen_attribs(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output element general attributes

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:gen_attribs {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:gen_attribs 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model

Source code in pytao/interface_commands.py 
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
def ele_gen_attribs(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element general attributes

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:gen_attribs {ele_id}|{which}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:gen_attribs 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model

    """
    cmd = f'python ele:gen_attribs {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_gen_attribs', cmd_type='string_list')

ele_gen_grad_map(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True)

Output element gen_grad_map

Parameters

ele_id index who which : default=model

Returns

string_list

Notes

Command syntax: python ele:gen_grad_map {ele_id}|{which} {index} {who}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {index} is the index number in the ele%gen_grad_map(:) array {who} is one of: "base", or "derivs".

Example

python ele:gen_grad_map 3@1>>7|model 2 base

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_em_field args: ele_id: 1@0>>9 which: model index: 1 who: derivs

Source code in pytao/interface_commands.py 
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
def ele_gen_grad_map(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element gen_grad_map 

    Parameters
    ----------
    ele_id
    index
    who
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:gen_grad_map {ele_id}|{which} {index} {who}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {index} is the index number in the ele%gen_grad_map(:) array
      {who} is one of: "base", or "derivs".

    Example:
      python ele:gen_grad_map 3@1>>7|model 2 base
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_em_field
     args:
      ele_id: 1@0>>9
      which: model
      index: 1
      who: derivs

    """
    cmd = f'python ele:gen_grad_map {ele_id}|{which} {index} {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_gen_grad_map', cmd_type='string_list')

ele_grid_field(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True)

Output element grid_field

Parameters

ele_id index who which : default=model

Returns

string_list

Notes

Command syntax: python ele:grid_field {ele_id}|{which} {index} {who}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {index} is the index number in the ele%grid_field(:) array. {who} is one of: "base", or "points"

Example

python ele:grid_field 3@1>>7|model 2 base

This gives grid #2 of element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_grid args: ele_id: 1@0>>1 which: model index: 1 who: base

Source code in pytao/interface_commands.py 
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
def ele_grid_field(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element grid_field

    Parameters
    ----------
    ele_id
    index
    who
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:grid_field {ele_id}|{which} {index} {who}

    Where:
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {index} is the index number in the ele%grid_field(:) array.
      {who} is one of: "base", or "points"

    Example:
      python ele:grid_field 3@1>>7|model 2 base
    This gives grid #2 of element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_grid
     args:
      ele_id: 1@0>>1
      which: model
      index: 1
      who: base 

    """
    cmd = f'python ele:grid_field {ele_id}|{which} {index} {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_grid_field', cmd_type='string_list')

ele_head(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output "head" Element attributes

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:head {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:head 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model

Source code in pytao/interface_commands.py 
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
def ele_head(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output "head" Element attributes

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:head {ele_id}|{which}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:head 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model

    """
    cmd = f'python ele:head {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_head', cmd_type='string_list')

ele_lord_slave(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output the lord/slave tree of an element.

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:lord_slave {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:lord_slave 3@1>>7|model

This gives lord and slave info on element number 7 in branch 1 of universe 3. Note: The lord/slave info is independent of the setting of {which}.

The output is a number of lines, each line giving information on an element (element index, etc.). Some lines begin with the word "Element". After each "Element" line, there are a number of lines (possibly zero) that begin with the word "Slave or "Lord". These "Slave" and "Lord" lines are the slaves and lords of the "Element" element.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model

Source code in pytao/interface_commands.py 
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
def ele_lord_slave(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output the lord/slave tree of an element.

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:lord_slave {ele_id}|{which}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:lord_slave 3@1>>7|model
    This gives lord and slave info on element number 7 in branch 1 of universe 3.
    Note: The lord/slave info is independent of the setting of {which}.

    The output is a number of lines, each line giving information on an element (element index, etc.).
    Some lines begin with the word "Element". 
    After each "Element" line, there are a number of lines (possibly zero) that begin with the word "Slave or "Lord".
    These "Slave" and "Lord" lines are the slaves and lords of the "Element" element.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model

    """
    cmd = f'python ele:lord_slave {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_lord_slave', cmd_type='string_list')

ele_mat6(tao, ele_id, *, which='model', who='mat6', verbose=False, as_dict=True, raises=True)

Output element mat6

Parameters

ele_id which : default=model who : default=mat6

Returns

string_list

Notes

Command syntax: python ele:mat6 {ele_id}|{which} {who}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {who} is one of: "mat6", "vec0", or "err"

Example

python ele:mat6 3@1>>7|model mat6

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model who: mat6

Source code in pytao/interface_commands.py 
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
def ele_mat6(tao, ele_id, *, which='model', who='mat6', verbose=False, as_dict=True, raises=True):
    """

    Output element mat6

    Parameters
    ----------
    ele_id
    which : default=model
    who : default=mat6

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:mat6 {ele_id}|{which} {who}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {who} is one of: "mat6", "vec0", or "err"

    Example:
      python ele:mat6 3@1>>7|model mat6
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model
      who: mat6

    """
    cmd = f'python ele:mat6 {ele_id}|{which} {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_mat6', cmd_type='string_list')

ele_methods(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output element methods

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:methods {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:methods 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model

Source code in pytao/interface_commands.py 
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
def ele_methods(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element methods

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:methods {ele_id}|{which}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:methods 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model

    """
    cmd = f'python ele:methods {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_methods', cmd_type='string_list')

ele_multipoles(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output element multipoles

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:multipoles {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:multipoles 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model

Source code in pytao/interface_commands.py 
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
def ele_multipoles(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element multipoles

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:multipoles {ele_id}|{which}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:multipoles 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model

    """
    cmd = f'python ele:multipoles {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_multipoles', cmd_type='string_list')

ele_orbit(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output element orbit

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:orbit {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:orbit 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model

Source code in pytao/interface_commands.py 
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
def ele_orbit(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element orbit

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:orbit {ele_id}|{which}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:orbit 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model

    """
    cmd = f'python ele:orbit {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_orbit', cmd_type='string_list')

ele_param(tao, ele_id, who, *, which='model', verbose=False, as_dict=True, raises=True)

Output lattice element parameter

Parameters

ele_id who which : default=model

Returns

string_list

Notes

Command syntax: python ele:param {ele_id}|{which} {who}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {who} values are the same as {who} values for "python lat_list". Note: Here {who} must be a single parameter and not a list.

Example

python ele:param 3@1>>7|model e_tot

This gives E_tot of element number 7 in branch 1 of universe 3.

Note: On output the {variable} component will always be "F" (since this command cannot tell if a parameter is allowed to vary).

Also see: "python lat_list".

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_photon args: ele_id: 1@0>>1 which: model who: orbit.vec.1

Source code in pytao/interface_commands.py 
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
def ele_param(tao, ele_id, who, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output lattice element parameter

    Parameters
    ----------
    ele_id
    who
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:param {ele_id}|{which} {who}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {who} values are the same as {who} values for "python lat_list".
            Note: Here {who} must be a single parameter and not a list.

    Example:
      python ele:param 3@1>>7|model e_tot
    This gives E_tot of element number 7 in branch 1 of universe 3.

    Note: On output the {variable} component will always be "F" (since this 
    command cannot tell if a parameter is allowed to vary).

    Also see: "python lat_list".

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_photon
     args:
      ele_id: 1@0>>1
      which: model
      who: orbit.vec.1

    """
    cmd = f'python ele:param {ele_id}|{which} {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_param', cmd_type='string_list')

ele_photon(tao, ele_id, who, *, which='model', verbose=False, as_dict=True, raises=True)

Output element photon parameters

Parameters

ele_id who which : default=model

Returns

string_list

Notes

Command syntax: python ele:photon {ele_id}|{which} {who}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {who} is one of: "base", "material", or "curvature"

Example

python ele:photon 3@1>>7|model base

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_photon args: ele_id: 1@0>>1 which: model who: base

Source code in pytao/interface_commands.py 
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
def ele_photon(tao, ele_id, who, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element photon parameters

    Parameters
    ----------
    ele_id
    who
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:photon {ele_id}|{which} {who}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {who} is one of: "base", "material", or "curvature"

    Example:
      python ele:photon 3@1>>7|model base
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_photon
     args:
      ele_id: 1@0>>1
      which: model
      who: base

    """
    cmd = f'python ele:photon {ele_id}|{which} {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_photon', cmd_type='string_list')

ele_spin_taylor(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output element spin_taylor parameters

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:spin_taylor {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:spin_taylor 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_spin args: ele_id: 1@0>>2 which: model

Source code in pytao/interface_commands.py 
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
def ele_spin_taylor(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element spin_taylor parameters

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:spin_taylor {ele_id}|{which}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:spin_taylor 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_spin
     args:
      ele_id: 1@0>>2
      which: model

    """
    cmd = f'python ele:spin_taylor {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_spin_taylor', cmd_type='string_list')

ele_taylor(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output element taylor map

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:taylor {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:taylor 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_taylor args: ele_id: 1@0>>34 which: model

Source code in pytao/interface_commands.py 
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
def ele_taylor(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element taylor map 

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:taylor {ele_id}|{which}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:taylor 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_taylor
     args:
      ele_id: 1@0>>34
      which: model

    """
    cmd = f'python ele:taylor {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_taylor', cmd_type='string_list')

ele_twiss(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True)

Output element Twiss parameters

Parameters

ele_id which : default=model

Returns

string_list

Notes

Command syntax: python ele:twiss {ele_id}|{which}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design"

Example

python ele:twiss 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>1 which: model

Source code in pytao/interface_commands.py 
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
def ele_twiss(tao, ele_id, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element Twiss parameters

    Parameters
    ----------
    ele_id
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:twiss {ele_id}|{which}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"

    Example:
      python ele:twiss 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
      ele_id: 1@0>>1
      which: model

    """
    cmd = f'python ele:twiss {ele_id}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_twiss', cmd_type='string_list')

ele_wake(tao, ele_id, who, *, which='model', verbose=False, as_dict=True, raises=True)

Output element wake.

Parameters

ele_id who which : default=model

Returns

string_list

Notes

Command syntax: python ele:wake {ele_id}|{which} {who}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {Who} is one of: "sr_long" "sr_long_table" "sr_trans" "sr_trans_table" "lr_mode_table" "base"

Example

python ele:wake 3@1>>7|model

This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wake args: ele_id: 1@0>>1 which: model who: sr_long

Source code in pytao/interface_commands.py 
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
def ele_wake(tao, ele_id, who, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element wake.

    Parameters
    ----------
    ele_id
    who
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:wake {ele_id}|{which} {who}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {Who} is one of:
          "sr_long"        "sr_long_table"
          "sr_trans"       "sr_trans_table"
          "lr_mode_table"  "base"

    Example:
      python ele:wake 3@1>>7|model
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wake
     args:
      ele_id: 1@0>>1
      which: model
      who: sr_long

    """
    cmd = f'python ele:wake {ele_id}|{which} {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_wake', cmd_type='string_list')

ele_wall3d(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True)

Output element wall3d parameters.

Parameters

ele_id index who which : default=model

Returns

string_list

Notes

Command syntax: python ele:wall3d {ele_id}|{which} {index} {who}

Where

{ele_id} is an element name or index. {which} is one of: "model", "base" or "design" {index} is the index number in the ele%wall3d(:) array (size obtained from "ele:head"). {who} is one of: "base", or "table".

Example: python ele:wall3d 3@1>>7|model 2 base This gives element number 7 in branch 1 of universe 3.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall3d args: ele_id: 1@0>>1 which: model index: 1 who: table

Source code in pytao/interface_commands.py 
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
def ele_wall3d(tao, ele_id, index, who, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output element wall3d parameters.

    Parameters
    ----------
    ele_id
    index
    who
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ele:wall3d {ele_id}|{which} {index} {who}

    Where: 
      {ele_id} is an element name or index.
      {which} is one of: "model", "base" or "design"
      {index} is the index number in the ele%wall3d(:) array (size obtained from "ele:head").
      {who} is one of: "base", or "table".
    Example:
      python ele:wall3d 3@1>>7|model 2 base
    This gives element number 7 in branch 1 of universe 3.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_wall3d
     args:
      ele_id: 1@0>>1
      which: model
      index: 1
      who: table

    """
    cmd = f'python ele:wall3d {ele_id}|{which} {index} {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ele_wall3d', cmd_type='string_list')

em_field(tao, ele_id, x, y, z, t_or_z, *, which='model', verbose=False, as_dict=True, raises=True)

Output EM field at a given point generated by a given element.

Parameters

ele_id x y z t_or_z which : default=model

Returns

string_list

Notes

Command syntax: python em_field {ele_id}|{which} {x} {y} {z} {t_or_z}

Where

{which} is one of: "model", "base" or "design" {x}, {y} -- Transverse coords. {z} -- Longitudinal coord with respect to entrance end of element. {t_or_z} -- time or phase space z depending if lattice is setup for absolute time tracking.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele_id: 1@0>>22 which: model x: 0 y: 0 z: 0 t_or_z: 0

Source code in pytao/interface_commands.py 
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
def em_field(tao, ele_id, x, y, z, t_or_z, *, which='model', verbose=False, as_dict=True, raises=True):
    """

    Output EM field at a given point generated by a given element.

    Parameters
    ----------
    ele_id
    x
    y
    z
    t_or_z
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python em_field {ele_id}|{which} {x} {y} {z} {t_or_z}

    Where:
      {which} is one of: "model", "base" or "design"
      {x}, {y}  -- Transverse coords.
      {z}       -- Longitudinal coord with respect to entrance end of element.
      {t_or_z}  -- time or phase space z depending if lattice is setup for absolute time tracking.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ele_id: 1@0>>22
       which: model
       x: 0
       y: 0
       z: 0
       t_or_z: 0

    """
    cmd = f'python em_field {ele_id}|{which} {x} {y} {z} {t_or_z}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='em_field', cmd_type='string_list')

enum(tao, enum_name, *, verbose=False, as_dict=True, raises=True)

Output list of possible values for enumerated numbers.

Parameters

enum_name

Returns

string_list

Notes

Command syntax: python enum {enum_name}

Example

python enum tracking_method

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: enum_name: tracking_method

Source code in pytao/interface_commands.py 
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
def enum(tao, enum_name, *, verbose=False, as_dict=True, raises=True):
    """

    Output list of possible values for enumerated numbers.

    Parameters
    ----------
    enum_name

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python enum {enum_name}

    Example:
      python enum tracking_method

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       enum_name: tracking_method

    """
    cmd = f'python enum {enum_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='enum', cmd_type='string_list')

evaluate(tao, expression, *, flags='-array_out', verbose=False, as_dict=True, raises=True)

Output the value of an expression. The result may be a vector.

Parameters

expression flags : default=-array_out If -array_out, the output will be available in the tao_c_interface_com%c_real.

Returns

string_list if '-array_out' not in flags real_array if '-array_out' in flags

Notes

Command syntax: python evaluate {flags} {expression}

Where

Optional {flags} are: -array_out : If present, the output will be available in the tao_c_interface_com%c_real. {expression} is expression to be evaluated.

Example

python evaluate 3+data::cbar.11[1:10]|model

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: expression: data::cbar.11[1:10]|model

Source code in pytao/interface_commands.py 
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
def evaluate(tao, expression, *, flags='-array_out', verbose=False, as_dict=True, raises=True):
    """

    Output the value of an expression. The result may be a vector.

    Parameters
    ----------
    expression
    flags : default=-array_out
        If -array_out, the output will be available in the tao_c_interface_com%c_real.

    Returns
    -------
    string_list
        if '-array_out' not in flags
    real_array
        if '-array_out' in flags

    Notes
    -----
    Command syntax:
      python evaluate {flags} {expression}

    Where:
      Optional {flags} are:
          -array_out : If present, the output will be available in the tao_c_interface_com%c_real.
      {expression} is expression to be evaluated.

    Example:
      python evaluate 3+data::cbar.11[1:10]|model

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       expression: data::cbar.11[1:10]|model

    """
    cmd = f'python evaluate {flags} {expression}'
    if verbose: print(cmd)
    if '-array_out' not in flags:
        return __execute(tao, cmd, as_dict, raises, method_name='evaluate', cmd_type='string_list')
    if '-array_out' in flags:
        return __execute(tao, cmd, as_dict, raises, method_name='evaluate', cmd_type='real_array')

floor_orbit(tao, graph, *, verbose=False, as_dict=True, raises=True)

Output (x, y) coordinates for drawing the particle orbit on a floor plan.

Parameters

graph

Returns

string_list

Notes

Command syntax: python floor_orbit {graph}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_floor_orbit args: graph: r33.g

Source code in pytao/interface_commands.py 
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
def floor_orbit(tao, graph, *, verbose=False, as_dict=True, raises=True):
    """

    Output (x, y) coordinates for drawing the particle orbit on a floor plan.

    Parameters
    ----------
    graph

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python floor_orbit {graph}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_floor_orbit
     args:
       graph: r33.g 

    """
    cmd = f'python floor_orbit {graph}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='floor_orbit', cmd_type='string_list')

floor_plan(tao, graph, *, verbose=False, as_dict=True, raises=True)

Output (x,y) points and other information that can be used for drawing a floor_plan.

Parameters

graph

Returns

string_list

Notes

Command syntax: python floor_plan {graph}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: graph: r13.g

Source code in pytao/interface_commands.py 
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
def floor_plan(tao, graph, *, verbose=False, as_dict=True, raises=True):
    """

    Output (x,y) points and other information that can be used for drawing a floor_plan.

    Parameters
    ----------
    graph

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python floor_plan {graph}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       graph: r13.g

    """
    cmd = f'python floor_plan {graph}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='floor_plan', cmd_type='string_list')

global_opti_de(tao, *, verbose=False, as_dict=True, raises=True)

Output DE optimization parameters.

Returns

string_list

Notes

Command syntax: python global:opti_de

Output syntax is parameter list form. See documentation at the beginning of this file.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
def global_opti_de(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output DE optimization parameters.

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python global:opti_de

    Output syntax is parameter list form. See documentation at the beginning of this file.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:

    """
    cmd = f'python global:opti_de'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='global_opti_de', cmd_type='string_list')

global_optimization(tao, *, verbose=False, as_dict=True, raises=True)

Output optimization parameters. Also see global:opti_de.

Returns

string_list

Notes

Command syntax: python global:optimization

Output syntax is parameter list form. See documentation at the beginning of this file.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
def global_optimization(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output optimization parameters.
    Also see global:opti_de.

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python global:optimization

    Output syntax is parameter list form. See documentation at the beginning of this file.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:

    """
    cmd = f'python global:optimization'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='global_optimization', cmd_type='string_list')

help(tao, *, verbose=False, as_dict=True, raises=True)

Output list of "help xxx" topics

Returns

string_list

Notes

Command syntax: python help

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
def help(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output list of "help xxx" topics

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python help

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:

    """
    cmd = f'python help'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='help', cmd_type='string_list')

inum(tao, who, *, verbose=False, as_dict=True, raises=True)

Output list of possible values for an INUM parameter. For example, possible index numbers for the branches of a lattice.

Parameters

who

Returns

string_list

Notes

Command syntax: python inum {who}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: who: ix_universe

Source code in pytao/interface_commands.py 
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
def inum(tao, who, *, verbose=False, as_dict=True, raises=True):
    """

    Output list of possible values for an INUM parameter.
    For example, possible index numbers for the branches of a lattice.

    Parameters
    ----------
    who

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python inum {who}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       who: ix_universe

    """
    cmd = f'python inum {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='inum', cmd_type='string_list')

lat_branch_list(tao, *, ix_uni='', verbose=False, as_dict=True, raises=True)

Output lattice branch list

Parameters

ix_uni : optional

Returns

string_list

Notes

Command syntax: python lat_branch_list {ix_uni}

Output syntax

branch_index;branch_name;n_ele_track;n_ele_max

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1

Source code in pytao/interface_commands.py 
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
def lat_branch_list(tao, *, ix_uni='', verbose=False, as_dict=True, raises=True):
    """

    Output lattice branch list

    Parameters
    ----------
    ix_uni : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python lat_branch_list {ix_uni}

    Output syntax:
      branch_index;branch_name;n_ele_track;n_ele_max

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ix_uni: 1

    """
    cmd = f'python lat_branch_list {ix_uni}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='lat_branch_list', cmd_type='string_list')

lat_calc_done(tao, branch_name, *, verbose=False, as_dict=True, raises=True)

Output if a lattice recalculation has been proformed since the last time "python lat_calc_done" was called.

Parameters

branch_name

Returns

string_list

Notes

Command syntax: python lat_calc_done

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: branch_name: 1@0

Source code in pytao/interface_commands.py 
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
def lat_calc_done(tao, branch_name, *, verbose=False, as_dict=True, raises=True):
    """

    Output if a lattice recalculation has been proformed since the last 
      time "python lat_calc_done" was called.

    Parameters
    ----------
    branch_name

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python lat_calc_done

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       branch_name: 1@0

    """
    cmd = f'python lat_calc_done'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='lat_calc_done', cmd_type='string_list')

lat_ele_list(tao, *, branch_name='', verbose=False, as_dict=True, raises=True)

Output lattice element list.

Parameters

branch_name : optional

Returns

list of str of element names

Notes

Command syntax: python lat_ele_list {branch_name}

{branch_name} should have the form: {ix_uni}@{ix_branch}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: branch_name: 1@0

Source code in pytao/interface_commands.py 
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
def lat_ele_list(tao, *, branch_name='', verbose=False, as_dict=True, raises=True):
    """

    Output lattice element list.

    Parameters
    ----------
    branch_name : optional

    Returns
    -------
    list of str of element names

    Notes
    -----
    Command syntax:
      python lat_ele_list {branch_name}

    {branch_name} should have the form:
      {ix_uni}@{ix_branch}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       branch_name: 1@0

    """
    cmd = f'python lat_ele_list {branch_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='lat_ele_list', cmd_type='string_list')

lat_list(tao, elements, who, *, ix_uni='', ix_branch='', which='model', flags='-array_out -track_only', verbose=False, as_dict=True, raises=True)

Output list of parameters at ends of lattice elements

Parameters

elements who ix_uni : optional ix_branch : optional which : default=model flags : optional, default=-array_out -track_only

Returns

string_list if ('-array_out' not in flags) or (who in ['ele.name', 'ele.key']) integer_array if '-array_out' in flags and who in ['orbit.state', 'ele.ix_ele'] real_array if ('-array_out' in flags) or ('real:' in who)

Notes

Command syntax: python lat_list {flags} {ix_uni}@{ix_branch}>>{elements}|{which} {who}

Where

Optional {flags} are: -no_slaves : If present, multipass_slave and super_slave elements will not be matched to. -track_only : If present, lord elements will not be matched to. -index_order : If present, order elements by element index instead of the standard s-position. -array_out : If present, the output will be available in the tao_c_interface_com%c_real or tao_c_interface_com%c_integer arrays. See the code below for when %c_real vs %c_integer is used. Note: Only a single {who} item permitted when -array_out is present.

{which} is one of: "model", "base" or "design"

{who} is a comma deliminated list of: orbit.floor.x, orbit.floor.y, orbit.floor.z ! Floor coords at particle orbit. orbit.spin.1, orbit.spin.2, orbit.spin.3, orbit.vec.1, orbit.vec.2, orbit.vec.3, orbit.vec.4, orbit.vec.5, orbit.vec.6, orbit.t, orbit.beta, orbit.state, ! Note: state is an integer. alive$ = 1, anything else is lost. orbit.energy, orbit.pc, ele.name, ele.key, ele.ix_ele, ele.ix_branch ele.a.beta, ele.a.alpha, ele.a.eta, ele.a.etap, ele.a.gamma, ele.a.phi, ele.b.beta, ele.b.alpha, ele.b.eta, ele.b.etap, ele.b.gamma, ele.b.phi, ele.x.eta, ele.x.etap, ele.y.eta, ele.y.etap, ele.ref_time, ele.ref_time_start ele.s, ele.l ele.e_tot, ele.p0c ele.mat6 ! Output: mat6(1,:), mat6(2,:), ... mat6(6,:) ele.vec0 ! Output: vec0(1), ... vec0(6) ele.{attribute} Where {attribute} is a Bmad syntax element attribute. (EG: ele.beta_a, ele.k1, etc.) ele.c_mat ! Output: c_mat11, c_mat12, c_mat21, c_mat22. ele.gamma_c ! Parameter associated with coupling c-matrix.

{elements} is a string to match element names to. Use "*" to match to all elements.

Examples:

python lat_list -track 3@0>>Q|base ele.s,orbit.vec.2 python lat_list 3@0>>Q|base real:ele.s

Also see: "python ele:param"

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1
ix_branch: 0 elements: Q* which: model who: orbit.floor.x

2

init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1
ix_branch: 0 elements: Q* which: design who: ele.ix_ele

Source code in pytao/interface_commands.py 
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
def lat_list(tao, elements, who, *, ix_uni='', ix_branch='', which='model', flags='-array_out -track_only', verbose=False, as_dict=True, raises=True):
    """

    Output list of parameters at ends of lattice elements

    Parameters
    ----------
    elements
    who
    ix_uni : optional
    ix_branch : optional
    which : default=model
    flags : optional, default=-array_out -track_only

    Returns
    -------
    string_list
        if ('-array_out' not in flags) or (who in ['ele.name', 'ele.key'])
    integer_array
        if '-array_out' in flags and who in ['orbit.state', 'ele.ix_ele']
    real_array
        if ('-array_out' in flags) or ('real:' in who) 

    Notes
    -----
    Command syntax:
      python lat_list {flags} {ix_uni}@{ix_branch}>>{elements}|{which} {who}

    Where:
     Optional {flags} are:
      -no_slaves : If present, multipass_slave and super_slave elements will not be matched to.
      -track_only : If present, lord elements will not be matched to.
      -index_order : If present, order elements by element index instead of the standard s-position.
      -array_out : If present, the output will be available in the tao_c_interface_com%c_real or
        tao_c_interface_com%c_integer arrays. See the code below for when %c_real vs %c_integer is used.
        Note: Only a single {who} item permitted when -array_out is present.

      {which} is one of: "model", "base" or "design"

      {who} is a comma deliminated list of:
        orbit.floor.x, orbit.floor.y, orbit.floor.z    ! Floor coords at particle orbit.
        orbit.spin.1, orbit.spin.2, orbit.spin.3,
        orbit.vec.1, orbit.vec.2, orbit.vec.3, orbit.vec.4, orbit.vec.5, orbit.vec.6,
        orbit.t, orbit.beta,
        orbit.state,     ! Note: state is an integer. alive$ = 1, anything else is lost.
        orbit.energy, orbit.pc,
        ele.name, ele.key, ele.ix_ele, ele.ix_branch
        ele.a.beta, ele.a.alpha, ele.a.eta, ele.a.etap, ele.a.gamma, ele.a.phi,
        ele.b.beta, ele.b.alpha, ele.b.eta, ele.b.etap, ele.b.gamma, ele.b.phi,
        ele.x.eta, ele.x.etap,
        ele.y.eta, ele.y.etap,
        ele.ref_time, ele.ref_time_start
        ele.s, ele.l
        ele.e_tot, ele.p0c
        ele.mat6      ! Output: mat6(1,:), mat6(2,:), ... mat6(6,:)
        ele.vec0      ! Output: vec0(1), ... vec0(6)
        ele.{attribute} Where {attribute} is a Bmad syntax element attribute. (EG: ele.beta_a, ele.k1, etc.)
        ele.c_mat     ! Output: c_mat11, c_mat12, c_mat21, c_mat22.
        ele.gamma_c   ! Parameter associated with coupling c-matrix.

      {elements} is a string to match element names to.
        Use "*" to match to all elements.

    Examples:
      python lat_list -track 3@0>>Q*|base ele.s,orbit.vec.2
      python lat_list 3@0>>Q*|base real:ele.s    

    Also see: "python ele:param"

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ix_uni: 1  
       ix_branch: 0 
       elements: Q* 
       which: model
       who: orbit.floor.x

    Example: 2
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ix_uni: 1  
       ix_branch: 0 
       elements: Q* 
       which: design
       who: ele.ix_ele

    """
    cmd = f'python lat_list {flags} {ix_uni}@{ix_branch}>>{elements}|{which} {who}'
    if verbose: print(cmd)
    if ('-array_out' not in flags) or (who in ['ele.name', 'ele.key']):
        return __execute(tao, cmd, as_dict, raises, method_name='lat_list', cmd_type='string_list')
    if '-array_out' in flags and who in ['orbit.state', 'ele.ix_ele']:
        return __execute(tao, cmd, as_dict, raises, method_name='lat_list', cmd_type='integer_array')
    if ('-array_out' in flags) or ('real:' in who) :
        return __execute(tao, cmd, as_dict, raises, method_name='lat_list', cmd_type='real_array')

lat_param_units(tao, param_name, *, verbose=False, as_dict=True, raises=True)

Output units of a parameter associated with a lattice or lattice element.

Parameters

param_name

Returns

string_list

Notes

Command syntax: python lat_param_units {param_name}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: param_name: L

Source code in pytao/interface_commands.py 
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
def lat_param_units(tao, param_name, *, verbose=False, as_dict=True, raises=True):
    """

    Output units of a parameter associated with a lattice or lattice element.

    Parameters
    ----------
    param_name

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python lat_param_units {param_name}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       param_name: L   

    """
    cmd = f'python lat_param_units {param_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='lat_param_units', cmd_type='string_list')

matrix(tao, ele1_id, ele2_id, *, verbose=False, as_dict=True, raises=True)

Output matrix value from the exit end of one element to the exit end of the other.

Parameters

ele1_id ele2_id

Returns

dict with keys: 'mat6' : np.array of shape (6,6) 'vec6' : np.array of shape(6)

Notes

Command syntax: python matrix {ele1_id} {ele2_id}

Where

{ele1_id} is the start element. {ele2_id} is the end element.

If {ele2_id} = {ele1_id}, the 1-turn transfer map is computed. Note: {ele2_id} should just be an element name or index without universe, branch, or model/base/design specification.

Example

python matrix 2@1>>q01w|design q02w

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele1_id: 1@0>>q01w|design ele2_id: q02w

Source code in pytao/interface_commands.py 
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
def matrix(tao, ele1_id, ele2_id, *, verbose=False, as_dict=True, raises=True):
    """

    Output matrix value from the exit end of one element to the exit end of the other.

    Parameters
    ----------
    ele1_id
    ele2_id

    Returns
    -------
    dict with keys:
        'mat6' : np.array of shape (6,6)
        'vec6' : np.array of shape(6)

    Notes
    -----
    Command syntax:
      python matrix {ele1_id} {ele2_id}

    Where:
      {ele1_id} is the start element.
      {ele2_id} is the end element.
    If {ele2_id} = {ele1_id}, the 1-turn transfer map is computed.
    Note: {ele2_id} should just be an element name or index without universe, branch, or model/base/design specification.

    Example:
      python matrix 2@1>>q01w|design q02w

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ele1_id: 1@0>>q01w|design
       ele2_id: q02w

    """
    cmd = f'python matrix {ele1_id} {ele2_id}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='matrix', cmd_type='string_list')

merit(tao, *, verbose=False, as_dict=True, raises=True)

Output merit value.

Returns

merit: float Value of the merit function

Notes

Command syntax: python merit

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
def merit(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output merit value.

    Returns
    -------
    merit: float
        Value of the merit function

    Notes
    -----
    Command syntax:
      python merit

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:

    """
    cmd = f'python merit'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='merit', cmd_type='string_list')

orbit_at_s(tao, *, ix_uni='', ele='', s_offset='', which='model', verbose=False, as_dict=True, raises=True)

Output twiss at given s position.

Parameters

ix_uni : optional ele : optional s_offset : optional which : default=model

Returns

string_list

Notes

Command syntax: python orbit_at_s {ix_uni}@{ele}->{s_offset}|{which}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe. {ele} is an element name or index. Default at the Beginning element at start of branch 0. {s_offset} is the offset of the evaluation point from the downstream end of ele. Default is 0. If {s_offset} is present, the preceeding "->" sign must be present. EG: Something like "23|model" will {which} is one of: "model", "base" or "design".

Example

python orbit_at_s Q10->0.4|model ! Orbit at 0.4 meters from Q10 element exit end in model lattice.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1 ele: 10 s_offset: 0.7 which: model

Source code in pytao/interface_commands.py 
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
def orbit_at_s(tao, *, ix_uni='', ele='', s_offset='', which='model', verbose=False, as_dict=True, raises=True):
    """

    Output twiss at given s position.

    Parameters
    ----------
    ix_uni : optional
    ele : optional
    s_offset : optional
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python orbit_at_s {ix_uni}@{ele}->{s_offset}|{which}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {ele} is an element name or index. Default at the Beginning element at start of branch 0.
      {s_offset} is the offset of the evaluation point from the downstream end of ele. Default is 0.
         If {s_offset} is present, the preceeding "->" sign must be present. EG: Something like "23|model" will
      {which} is one of: "model", "base" or "design".

    Example:
      python orbit_at_s Q10->0.4|model   ! Orbit at 0.4 meters from Q10 element exit end in model lattice.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ix_uni: 1
       ele: 10
       s_offset: 0.7
       which: model

    """
    cmd = f'python orbit_at_s {ix_uni}@{ele}->{s_offset}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='orbit_at_s', cmd_type='string_list')

place_buffer(tao, *, verbose=False, as_dict=True, raises=True)

Output the place command buffer and reset the buffer. The contents of the buffer are the place commands that the user has issued. See the Tao manual for more details.

Returns

None

Notes

Command syntax: python place_buffer

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
def place_buffer(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output the place command buffer and reset the buffer.
    The contents of the buffer are the place commands that the user has issued.
    See the Tao manual for more details.

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python place_buffer

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:

    """
    cmd = f'python place_buffer'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='place_buffer', cmd_type='None')

plot1(tao, name, *, verbose=False, as_dict=True, raises=True)

Output info on a given plot.

Parameters

name

Returns

string_list

Notes

Command syntax: python plot1 {name}

{name} should be the region name if the plot is associated with a region. Output syntax is parameter list form. See documentation at the beginning of this file.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: name: beta

Source code in pytao/interface_commands.py 
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
def plot1(tao, name, *, verbose=False, as_dict=True, raises=True):
    """

    Output info on a given plot.

    Parameters
    ----------
    name

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python plot1 {name}

    {name} should be the region name if the plot is associated with a region.
    Output syntax is parameter list form. See documentation at the beginning of this file.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       name: beta

    """
    cmd = f'python plot1 {name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='plot1', cmd_type='string_list')

plot_curve(tao, curve_name, *, verbose=False, as_dict=True, raises=True)

Output curve information for a plot.

Parameters

curve_name

Returns

string_list

Notes

Command syntax: python plot_curve {curve_name}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: curve_name: r13.g.a

Source code in pytao/interface_commands.py 
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
def plot_curve(tao, curve_name, *, verbose=False, as_dict=True, raises=True):
    """

    Output curve information for a plot.

    Parameters
    ----------
    curve_name

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python plot_curve {curve_name}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       curve_name: r13.g.a

    """
    cmd = f'python plot_curve {curve_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='plot_curve', cmd_type='string_list')

plot_curve_manage(tao, graph_name, curve_index, curve_name, *, verbose=False, as_dict=True, raises=True)

Template plot curve creation/destruction

Parameters

graph_name curve_index curve_name

Returns

None

Notes

Command syntax: python plot_curve_manage {graph_name}^^{curve_index}^^{curve_name}

If {curve_index} corresponds to an existing curve then this curve is deleted. In this case the {curve_name} is ignored and does not have to be present. If {curve_index} does not not correspond to an existing curve, {curve_index} must be one greater than the number of curves.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: graph_name: beta.g curve_index: 1 curve_name: r13.g.a

Source code in pytao/interface_commands.py 
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
def plot_curve_manage(tao, graph_name, curve_index, curve_name, *, verbose=False, as_dict=True, raises=True):
    """

    Template plot curve creation/destruction

    Parameters
    ----------
    graph_name
    curve_index
    curve_name

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python plot_curve_manage {graph_name}^^{curve_index}^^{curve_name}

    If {curve_index} corresponds to an existing curve then this curve is deleted.
    In this case the {curve_name} is ignored and does not have to be present.
    If {curve_index} does not not correspond to an existing curve, {curve_index}
    must be one greater than the number of curves.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       graph_name: beta.g
       curve_index: 1
       curve_name: r13.g.a

    """
    cmd = f'python plot_curve_manage {graph_name}^^{curve_index}^^{curve_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='plot_curve_manage', cmd_type='None')

plot_graph(tao, graph_name, *, verbose=False, as_dict=True, raises=True)

Output graph info.

Parameters

graph_name

Returns

string_list

Notes

Command syntax: python plot_graph {graph_name}

{graph_name} is in the form: {p_name}.{g_name} where {p_name} is the plot region name if from a region or the plot name if a template plot. This name is obtained from the python plot_list command. {g_name} is the graph name obtained from the python plot1 command.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: graph_name: beta.g

Source code in pytao/interface_commands.py 
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
def plot_graph(tao, graph_name, *, verbose=False, as_dict=True, raises=True):
    """

    Output graph info.

    Parameters
    ----------
    graph_name

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python plot_graph {graph_name}

    {graph_name} is in the form:
      {p_name}.{g_name}
    where
      {p_name} is the plot region name if from a region or the plot name if a template plot.
      This name is obtained from the python plot_list command.
      {g_name} is the graph name obtained from the python plot1 command.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       graph_name: beta.g

    """
    cmd = f'python plot_graph {graph_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='plot_graph', cmd_type='string_list')

plot_graph_manage(tao, plot_name, graph_index, graph_name, *, verbose=False, as_dict=True, raises=True)

Template plot graph creation/destruction

Parameters

plot_name graph_index graph_name

Returns

None

Notes

Command syntax: python plot_graph_manage {plot_name}^^{graph_index}^^{graph_name}

If {graph_index} corresponds to an existing graph then this graph is deleted. In this case the {graph_name} is ignored and does not have to be present. If {graph_index} does not not correspond to an existing graph, {graph_index} must be one greater than the number of graphs.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: plot_name: beta graph_index: 1 graph_name: beta.g

Source code in pytao/interface_commands.py 
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
def plot_graph_manage(tao, plot_name, graph_index, graph_name, *, verbose=False, as_dict=True, raises=True):
    """

    Template plot graph creation/destruction

    Parameters
    ----------
    plot_name
    graph_index
    graph_name

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python plot_graph_manage {plot_name}^^{graph_index}^^{graph_name}

    If {graph_index} corresponds to an existing graph then this graph is deleted.
    In this case the {graph_name} is ignored and does not have to be present.
    If {graph_index} does not not correspond to an existing graph, {graph_index}
    must be one greater than the number of graphs.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       plot_name: beta
       graph_index: 1
       graph_name: beta.g

    """
    cmd = f'python plot_graph_manage {plot_name}^^{graph_index}^^{graph_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='plot_graph_manage', cmd_type='None')

plot_histogram(tao, curve_name, *, verbose=False, as_dict=True, raises=True)

Output plot histogram info.

Parameters

curve_name

Returns

string_list

Notes

Command syntax: python plot_histogram {curve_name}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: curve_name: r33.g.x

Source code in pytao/interface_commands.py 
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
def plot_histogram(tao, curve_name, *, verbose=False, as_dict=True, raises=True):
    """

    Output plot histogram info.

    Parameters
    ----------
    curve_name

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python plot_histogram {curve_name}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       curve_name: r33.g.x

    """
    cmd = f'python plot_histogram {curve_name}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='plot_histogram', cmd_type='string_list')

plot_lat_layout(tao, ix_uni, ix_branch, *, verbose=False, as_dict=True, raises=True)

Output plot Lat_layout info

Parameters

ix_uni: 1 ix_branch: 0

Returns

string_list

Notes

Command syntax: python plot_lat_layout {ix_uni}@{ix_branch}

The returned list of element positions is not ordered in increasing

longitudinal position.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1 ix_branch: 0

Source code in pytao/interface_commands.py 
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
def plot_lat_layout(tao, ix_uni: 1, ix_branch: 0, *, verbose=False, as_dict=True, raises=True):
    """

    Output plot Lat_layout info

    Parameters
    ----------
    ix_uni: 1
    ix_branch: 0

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python plot_lat_layout {ix_uni}@{ix_branch}

    Note: The returned list of element positions is not ordered in increasing
          longitudinal position.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ix_uni: 1
       ix_branch: 0 

    """
    cmd = f'python plot_lat_layout {ix_uni}@{ix_branch}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='plot_lat_layout', cmd_type='string_list')

plot_line(tao, region_name, graph_name, curve_name, *, x_or_y='', verbose=False, as_dict=True, raises=True)

Output points used to construct the "line" associated with a plot curve.

Parameters

region_name graph_name curve_name x_or_y : optional

Returns

string_list if x_or_y == '' real_array if x_or_y != ''

Notes

Command syntax: python plot_line {region_name}.{graph_name}.{curve_name} {x_or_y}

Optional {x-or-y} may be set to "x" or "y" to get the smooth line points x or y component put into the real array buffer. Note: The plot must come from a region, and not a template, since no template plots have associated line data. Examples: python plot_line r13.g.a ! String array output. python plot_line r13.g.a x ! x-component of line points loaded into the real array buffer. python plot_line r13.g.a y ! y-component of line points loaded into the real array buffer.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_plot_line -external_plotting args: region_name: beta graph_name: g curve_name: a x_or_y:

2

init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_plot_line -external_plotting args: region_name: beta graph_name: g curve_name: a x_or_y: y

Source code in pytao/interface_commands.py 
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
def plot_line(tao, region_name, graph_name, curve_name, *, x_or_y='', verbose=False, as_dict=True, raises=True):
    """

    Output points used to construct the "line" associated with a plot curve.

    Parameters
    ----------
    region_name
    graph_name
    curve_name
    x_or_y : optional

    Returns
    -------
    string_list
        if x_or_y == ''
    real_array
        if x_or_y != ''

    Notes
    -----
    Command syntax:
      python plot_line {region_name}.{graph_name}.{curve_name} {x_or_y}

    Optional {x-or-y} may be set to "x" or "y" to get the smooth line points x or y 
    component put into the real array buffer.
    Note: The plot must come from a region, and not a template, since no template plots 
          have associated line data.
    Examples:
      python plot_line r13.g.a   ! String array output.
      python plot_line r13.g.a x ! x-component of line points loaded into the real array buffer.
      python plot_line r13.g.a y ! y-component of line points loaded into the real array buffer.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_plot_line -external_plotting
     args:
       region_name: beta
       graph_name: g
       curve_name: a
       x_or_y:

    Example: 2
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_plot_line -external_plotting
     args:
       region_name: beta
       graph_name: g
       curve_name: a
       x_or_y: y

    """
    cmd = f'python plot_line {region_name}.{graph_name}.{curve_name} {x_or_y}'
    if verbose: print(cmd)
    if x_or_y == '':
        return __execute(tao, cmd, as_dict, raises, method_name='plot_line', cmd_type='string_list')
    if x_or_y != '':
        return __execute(tao, cmd, as_dict, raises, method_name='plot_line', cmd_type='real_array')

plot_list(tao, r_or_g, *, verbose=False, as_dict=True, raises=True)

Output list of plot templates or plot regions.

Parameters

r_or_g

Returns

if r_or_g == 't' dict with template_name:index if r_or_g == 'r' list of dicts with keys: region ix plot_name visible x1, x2, y1, y1

Notes

Command syntax: python plot_list {r_or_g}

where "{r/g}" is: "r" ! list regions of the form ix;region_name;plot_name;visible;x1;x2;y1;y2 "t" ! list template plots of the form ix;name

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: r_or_g: r

Source code in pytao/interface_commands.py 
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
def plot_list(tao, r_or_g, *, verbose=False, as_dict=True, raises=True):
    """

    Output list of plot templates or plot regions.

    Parameters
    ----------
    r_or_g

    Returns
    -------
    if r_or_g == 't'
        dict with template_name:index
    if r_or_g == 'r'
        list of dicts with keys:
            region
            ix
            plot_name
            visible
            x1, x2, y1, y1

    Notes
    -----
    Command syntax:
      python plot_list {r_or_g}

    where "{r/g}" is:
      "r"      ! list regions of the form ix;region_name;plot_name;visible;x1;x2;y1;y2
      "t"      ! list template plots of the form ix;name

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       r_or_g: r

    """
    cmd = f'python plot_list {r_or_g}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='plot_list', cmd_type='string_list')

plot_symbol(tao, region_name, graph_name, curve_name, x_or_y, *, verbose=False, as_dict=True, raises=True)

Output locations to draw symbols for a plot curve.

Parameters

region_name graph_name curve_name x_or_y

Returns

string_list if x_or_y == '' real_array if x_or_y != ''

Notes

Command syntax: python plot_symbol {region_name}.{graph_name}.{curve_name} {x_or_y}

Optional {x_or_y} may be set to "x" or "y" to get the symbol x or y positions put into the real array buffer. Note: The plot must come from a region, and not a template, since no template plots have associated symbol data. Examples: python plot_symbol r13.g.a ! String array output. python plot_symbol r13.g.a x ! x-component of the symbol positions loaded into the real array buffer. python plot_symbol r13.g.a y ! y-component of the symbol positions loaded into the real array buffer.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_plot_line -external_plotting args: region_name: r13 graph_name: g curve_name: a x_or_y:

2

init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_plot_line -external_plotting args: region_name: r13 graph_name: g curve_name: a x_or_y: y

Source code in pytao/interface_commands.py 
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
def plot_symbol(tao, region_name, graph_name, curve_name, x_or_y, *, verbose=False, as_dict=True, raises=True):
    """

    Output locations to draw symbols for a plot curve.

    Parameters
    ----------
    region_name
    graph_name
    curve_name
    x_or_y

    Returns
    -------
    string_list
        if x_or_y == ''
    real_array
        if x_or_y != ''

    Notes
    -----
    Command syntax:
      python plot_symbol {region_name}.{graph_name}.{curve_name} {x_or_y}

    Optional {x_or_y} may be set to "x" or "y" to get the symbol x or y 
    positions put into the real array buffer.
    Note: The plot must come from a region, and not a template, 
          since no template plots have associated symbol data.
    Examples:
      python plot_symbol r13.g.a       ! String array output.
      python plot_symbol r13.g.a x     ! x-component of the symbol positions 
                                         loaded into the real array buffer.
      python plot_symbol r13.g.a y     ! y-component of the symbol positions 
                                         loaded into the real array buffer.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_plot_line -external_plotting
     args:
       region_name: r13
       graph_name: g
       curve_name: a
       x_or_y: 

    Example: 2
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_plot_line -external_plotting
     args:
       region_name: r13
       graph_name: g
       curve_name: a
       x_or_y: y

    """
    cmd = f'python plot_symbol {region_name}.{graph_name}.{curve_name} {x_or_y}'
    if verbose: print(cmd)
    if x_or_y == '':
        return __execute(tao, cmd, as_dict, raises, method_name='plot_symbol', cmd_type='string_list')
    if x_or_y != '':
        return __execute(tao, cmd, as_dict, raises, method_name='plot_symbol', cmd_type='real_array')

plot_template_manage(tao, template_location, template_name, *, n_graph='-1', graph_names='', verbose=False, as_dict=True, raises=True)

Template plot creation or destruction.

Parameters

template_location template_name n_graph : default=-1 graph_names : default=

Returns

None

Notes

Command syntax: python plot_template_manage {template_location}^^{template_name}^^ {n_graph}^^{graph_names}

Where

{template_location} is the location to place or delete a template plot. Use "@Tnnn" syntax for the location. {template_name} is the name of the template plot. If deleting a plot this name is immaterial. {n_graph} is the number of associated graphs. If set to -1 then any existing template plot is deleted. {graph_names} are the names of the graphs. graph_names should be in the form: graph1_name^^graph2_name^^...^^graphN_name for N=n_graph names

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: template_location: @T1 template_name: beta n_graph: 2 graph_names: g1^^g2

Source code in pytao/interface_commands.py 
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
def plot_template_manage(tao, template_location, template_name, *, n_graph='-1', graph_names='', verbose=False, as_dict=True, raises=True):
    """

    Template plot creation or destruction.

    Parameters
    ----------
    template_location
    template_name
    n_graph : default=-1
    graph_names : default=

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python plot_template_manage {template_location}^^{template_name}^^
                             {n_graph}^^{graph_names}

    Where:
      {template_location} is the location to place or delete a template plot. Use "@Tnnn" syntax for the location.
      {template_name} is the name of the template plot. If deleting a plot this name is immaterial.
      {n_graph} is the number of associated graphs. If set to -1 then any existing template plot is deleted.
      {graph_names} are the names of the graphs.  graph_names should be in the form:
         graph1_name^^graph2_name^^...^^graphN_name
      for N=n_graph names

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       template_location: @T1
       template_name: beta
       n_graph: 2
       graph_names: g1^^g2

    """
    cmd = f'python plot_template_manage {template_location}^^{template_name}^^{n_graph}^^{graph_names}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='plot_template_manage', cmd_type='None')

plot_transfer(tao, from_plot, to_plot, *, verbose=False, as_dict=True, raises=True)

Output transfer plot parameters from the "from plot" to the "to plot" (or plots).

Parameters

from_plot to_plot

Returns

None

Notes

Command syntax: python plot_transfer {from_plot} {to_plot}

To avoid confusion, use "@Tnnn" and "@Rnnn" syntax for {from_plot}. If {to_plot} is not present and {from_plot} is a template plot, the "to plots" are the equivalent region plots with the same name. And vice versa if {from_plot} is a region plot.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: from_plot: r13 to_plot: r23

Source code in pytao/interface_commands.py 
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
def plot_transfer(tao, from_plot, to_plot, *, verbose=False, as_dict=True, raises=True):
    """

    Output transfer plot parameters from the "from plot" to the "to plot" (or plots).

    Parameters
    ----------
    from_plot
    to_plot

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python plot_transfer {from_plot} {to_plot}

    To avoid confusion, use "@Tnnn" and "@Rnnn" syntax for {from_plot}.
    If {to_plot} is not present and {from_plot} is a template plot, the "to plots" 
     are the equivalent region plots with the same name. And vice versa 
     if {from_plot} is a region plot.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       from_plot: r13
       to_plot: r23 

    """
    cmd = f'python plot_transfer {from_plot} {to_plot}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='plot_transfer', cmd_type='None')

ptc_com(tao, *, verbose=False, as_dict=True, raises=True)

Output Ptc_com structure components.

Returns

string_list

Notes

Command syntax: python ptc_com

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
def ptc_com(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output Ptc_com structure components.

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ptc_com

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init 
     args:

    """
    cmd = f'python ptc_com'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ptc_com', cmd_type='string_list')

ring_general(tao, *, ix_uni='', ix_branch='', which='model', verbose=False, as_dict=True, raises=True)

Output lattice branch with closed geometry info (emittances, etc.)

Parameters

ix_uni : optional ix_branch : optional which : default=model

Returns

string_list

Notes

Command syntax: python ring_general {ix_uni}@{ix_branch}|{which}

where {which} is one of: model base design Example: python ring_general 1@0|model

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1 ix_branch: 0 which: model

Source code in pytao/interface_commands.py 
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
def ring_general(tao, *, ix_uni='', ix_branch='', which='model', verbose=False, as_dict=True, raises=True):
    """

    Output lattice branch with closed geometry info (emittances, etc.)

    Parameters
    ----------
    ix_uni : optional
    ix_branch : optional
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python ring_general {ix_uni}@{ix_branch}|{which}

    where {which} is one of:
      model
      base
      design
    Example:
      python ring_general 1@0|model

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
        ix_uni: 1
        ix_branch: 0
        which: model

    """
    cmd = f'python ring_general {ix_uni}@{ix_branch}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='ring_general', cmd_type='string_list')

shape_list(tao, who, *, verbose=False, as_dict=True, raises=True)

Output lat_layout or floor_plan shapes list

Parameters

who

Returns

string_list

Notes

Command syntax: python shape_list {who}

{who} is one of: lat_layout floor_plan

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: who: floor_plan

Source code in pytao/interface_commands.py 
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
def shape_list(tao, who, *, verbose=False, as_dict=True, raises=True):
    """

    Output lat_layout or floor_plan shapes list

    Parameters
    ----------
    who

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python shape_list {who}

    {who} is one of:
      lat_layout
      floor_plan

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       who: floor_plan  

    """
    cmd = f'python shape_list {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='shape_list', cmd_type='string_list')

shape_manage(tao, who, index, add_or_delete, *, verbose=False, as_dict=True, raises=True)

Element shape creation or destruction

Parameters

who index add_or_delete

Returns

string_list

Notes

Command syntax: python shape_manage {who} {index} {add_or_delete}

{who} is one of: lat_layout floor_plan {add_or_delete} is one of: add -- Add a shape at {index}. Shapes with higher index get moved up one to make room. delete -- Delete shape at {index}. Shapes with higher index get moved down one to fill the gap.

Example

python shape_manage floor_plan 2 add

Note: After adding a shape use "python shape_set" to set shape parameters. This is important since an added shape is in a ill-defined state.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: who: floor_plan index: 1 add_or_delete: add

Source code in pytao/interface_commands.py 
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
def shape_manage(tao, who, index, add_or_delete, *, verbose=False, as_dict=True, raises=True):
    """

    Element shape creation or destruction

    Parameters
    ----------
    who
    index
    add_or_delete

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python shape_manage {who} {index} {add_or_delete}

    {who} is one of:
      lat_layout
      floor_plan
    {add_or_delete} is one of:
      add     -- Add a shape at {index}. 
                 Shapes with higher index get moved up one to make room.
      delete  -- Delete shape at {index}. 
                 Shapes with higher index get moved down one to fill the gap.

    Example:
      python shape_manage floor_plan 2 add
    Note: After adding a shape use "python shape_set" to set shape parameters.
    This is important since an added shape is in a ill-defined state.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       who: floor_plan
       index: 1
       add_or_delete: add

    """
    cmd = f'python shape_manage {who} {index} {add_or_delete}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='shape_manage', cmd_type='string_list')

shape_pattern_list(tao, *, ix_pattern='', verbose=False, as_dict=True, raises=True)

Output list of shape patterns or shape pattern points

Parameters

ix_pattern : optional

Returns

string_list

Notes

Command syntax: python shape_pattern_list {ix_pattern}

If optional {ix_pattern} index is omitted then list all the patterns. If {ix_pattern} is present, list points of given pattern.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_shape args: ix_pattern:

Source code in pytao/interface_commands.py 
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
def shape_pattern_list(tao, *, ix_pattern='', verbose=False, as_dict=True, raises=True):
    """

    Output list of shape patterns or shape pattern points

    Parameters
    ----------
    ix_pattern : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python shape_pattern_list {ix_pattern}

    If optional {ix_pattern} index is omitted then list all the patterns.
    If {ix_pattern} is present, list points of given pattern.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_shape
     args:
       ix_pattern: 

    """
    cmd = f'python shape_pattern_list {ix_pattern}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='shape_pattern_list', cmd_type='string_list')

shape_pattern_manage(tao, ix_pattern, pat_name, pat_line_width, *, verbose=False, as_dict=True, raises=True)

Add or remove shape pattern

Parameters

ix_pattern pat_name pat_line_width

Returns

None

Notes

Command syntax: python shape_pattern_manage {ix_pattern}^^{pat_name}^^{pat_line_width}

Where

{ix_pattern} -- Pattern index. Patterns with higher indexes will be moved up if adding a pattern and down if deleting. {pat_name} -- Pattern name. {pat_line_width} -- Line width. Integer. If set to "delete" then section will be deleted.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_shape args: ix_pattern : 1 pat_name : new_pat pat_line_width : 1

Source code in pytao/interface_commands.py 
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
def shape_pattern_manage(tao, ix_pattern, pat_name, pat_line_width, *, verbose=False, as_dict=True, raises=True):
    """

    Add or remove shape pattern

    Parameters
    ----------
    ix_pattern
    pat_name
    pat_line_width

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python shape_pattern_manage {ix_pattern}^^{pat_name}^^{pat_line_width}

    Where:
      {ix_pattern}      -- Pattern index. Patterns with higher indexes will be moved up 
                                          if adding a pattern and down if deleting.
      {pat_name}        -- Pattern name.
      {pat_line_width}  -- Line width. Integer. If set to "delete" then section 
                                                will be deleted.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_shape
     args:
       ix_pattern : 1
       pat_name : new_pat
       pat_line_width : 1

    """
    cmd = f'python shape_pattern_manage {ix_pattern}^^{pat_name}^^{pat_line_width}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='shape_pattern_manage', cmd_type='None')

shape_pattern_point_manage(tao, ix_pattern, ix_point, s, x, *, verbose=False, as_dict=True, raises=True)

Add or remove shape pattern point

Parameters

ix_pattern ix_point s x

Returns

None

Notes

Command syntax: python shape_pattern_point_manage {ix_pattern}^^{ix_point}^^{s}^^{x}

Where

{ix_pattern} -- Pattern index. {ix_point} -- Point index. Points of higher indexes will be moved up if adding a point and down if deleting. {s}, {x} -- Point location. If {s} is "delete" then delete the point.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_shape args: ix_pattern: 1 ix_point: 1 s: 0 x: 0

Source code in pytao/interface_commands.py 
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
def shape_pattern_point_manage(tao, ix_pattern, ix_point, s, x, *, verbose=False, as_dict=True, raises=True):
    """

    Add or remove shape pattern point

    Parameters
    ----------
    ix_pattern
    ix_point
    s
    x

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python shape_pattern_point_manage {ix_pattern}^^{ix_point}^^{s}^^{x}

    Where:
      {ix_pattern}      -- Pattern index.
      {ix_point}        -- Point index. Points of higher indexes will be moved up
                                        if adding a point and down if deleting.
      {s}, {x}          -- Point location. If {s} is "delete" then delete the point.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_shape
     args:
       ix_pattern: 1
       ix_point: 1
       s: 0
       x: 0

    """
    cmd = f'python shape_pattern_point_manage {ix_pattern}^^{ix_point}^^{s}^^{x}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='shape_pattern_point_manage', cmd_type='None')

shape_set(tao, who, shape_index, ele_name, shape, color, shape_size, type_label, shape_draw, multi_shape, line_width, *, verbose=False, as_dict=True, raises=True)

Set lat_layout or floor_plan shape parameters.

Parameters

who shape_index ele_name shape color shape_size type_label shape_draw multi_shape line_width

Returns

None

Notes

Command syntax: python shape_set {who}^^{shape_index}^^{ele_name}^^{shape}^^{color}^^ {shape_size}^^{type_label}^^{shape_draw}^^ {multi_shape}^^{line_width}

{who} is one of: lat_layout floor_plan

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: who: floor_plan shape_index: 1 ele_name: Q1 shape: circle color: shape_size: type_label: shape_draw: multi_shape: line_width:

Source code in pytao/interface_commands.py 
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
def shape_set(tao, who, shape_index, ele_name, shape, color, shape_size, type_label, shape_draw, multi_shape, line_width, *, verbose=False, as_dict=True, raises=True):
    """

    Set lat_layout or floor_plan shape parameters.

    Parameters
    ----------
    who
    shape_index
    ele_name
    shape
    color
    shape_size
    type_label
    shape_draw
    multi_shape
    line_width

    Returns
    -------
    None

    Notes
    -----
    Command syntax:
      python shape_set {who}^^{shape_index}^^{ele_name}^^{shape}^^{color}^^
                       {shape_size}^^{type_label}^^{shape_draw}^^
                       {multi_shape}^^{line_width}

    {who} is one of:
      lat_layout
      floor_plan

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       who: floor_plan
       shape_index: 1
       ele_name: Q1
       shape: circle
       color:
       shape_size:
       type_label:
       shape_draw:
       multi_shape:
       line_width:

    """
    cmd = f'python shape_set {who}^^{shape_index}^^{ele_name}^^{shape}^^{color}^^{shape_size}^^{type_label}^^{shape_draw}^^{multi_shape}^^{line_width}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='shape_set', cmd_type='None')

show(tao, line, *, verbose=False, as_dict=True, raises=True)

Output the output from a show command.

Parameters

line

Returns

string_list

Notes

Command syntax: python show {line}

{line} is the string to pass through to the show command. Example: python show lattice -python

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: line: -python

Source code in pytao/interface_commands.py 
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
def show(tao, line, *, verbose=False, as_dict=True, raises=True):
    """

    Output the output from a show command.

    Parameters
    ----------
    line

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python show {line}

    {line} is the string to pass through to the show command.
    Example:
      python show lattice -python

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       line: -python

    """
    cmd = f'python show {line}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='show', cmd_type='string_list')

space_charge_com(tao, *, verbose=False, as_dict=True, raises=True)

Output space_charge_com structure parameters.

Returns

string_list

Notes

Command syntax: python space_charge_com

Output syntax is parameter list form. See documentation at the beginning of this file.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
def space_charge_com(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output space_charge_com structure parameters.

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python space_charge_com

    Output syntax is parameter list form. See documentation at the beginning of this file.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:

    """
    cmd = f'python space_charge_com'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='space_charge_com', cmd_type='string_list')

species_to_int(tao, species_str, *, verbose=False, as_dict=True, raises=True)

Convert species name to corresponding integer

Parameters

species_str

Returns

string_list

Notes

Command syntax: python species_to_int {species_str}

Example

python species_to_int CO2++

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: species_str: electron

Source code in pytao/interface_commands.py 
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
def species_to_int(tao, species_str, *, verbose=False, as_dict=True, raises=True):
    """

    Convert species name to corresponding integer

    Parameters
    ----------
    species_str

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python species_to_int {species_str}

    Example:
      python species_to_int CO2++

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       species_str: electron

    """
    cmd = f'python species_to_int {species_str}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='species_to_int', cmd_type='string_list')

species_to_str(tao, species_int, *, verbose=False, as_dict=True, raises=True)

Convert species integer id to corresponding

Parameters

species_int

Returns

string_list

Notes

Command syntax: python species_to_str {species_int}

Example

python species_to_str -1 ! Returns 'Electron'

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: species_int: -1

Source code in pytao/interface_commands.py 
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
def species_to_str(tao, species_int, *, verbose=False, as_dict=True, raises=True):
    """

    Convert species integer id to corresponding

    Parameters
    ----------
    species_int

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python species_to_str {species_int}

    Example:
      python species_to_str -1     ! Returns 'Electron'

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       species_int: -1

    """
    cmd = f'python species_to_str {species_int}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='species_to_str', cmd_type='string_list')

spin_invariant(tao, who, *, ix_uni='', ix_branch='', which='model', flags='-array_out', verbose=False, as_dict=True, raises=True)

Output closed orbit spin axes n0, l0, or m0 at the ends of all lattice elements in a branch. n0, l0, and m0 are solutions of the T-BMT equation. n0 is periodic while l0 and m0 are not. At the beginning of the branch, the orientation of the l0 or m0 axes in the plane perpendicular to the n0 axis is chosen a bit arbitrarily. See the Bmad manual for more details.

Parameters

who ix_uni : optional ix_branch : optional which : default=model flags : default=-array_out

Returns

string_list if '-array_out' not in flags real_array if '-array_out' in flags

Notes

Command syntax: python spin_invariant {flags} {who} {ix_uni}@{ix_branch}|{which}

Where

{flags} are optional switches: -array_out : If present, the output will be available in the tao_c_interface_com%c_real. {who} is one of: l0, n0, or m0 {ix_uni} is a universe index. Defaults to s%global%default_universe. {ix_branch} is a branch index. Defaults to s%global%default_branch. {which} is one of: model base design

Example

python spin_invariant 1@0|model

Note: This command is under development. If you want to use please contact David Sagan.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: who: l0 ix_uni: 1 ix_branch: 0 which: model

Source code in pytao/interface_commands.py 
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
def spin_invariant(tao, who, *, ix_uni='', ix_branch='', which='model', flags='-array_out', verbose=False, as_dict=True, raises=True):
    """

    Output closed orbit spin axes n0, l0, or m0 at the ends of all lattice elements in a branch.
    n0, l0, and m0 are solutions of the T-BMT equation.
    n0 is periodic while l0 and m0 are not. At the beginning of the branch, the orientation of the 
    l0 or m0 axes in the plane perpendicular to the n0 axis is chosen a bit arbitrarily.
    See the Bmad manual for more details.

    Parameters
    ----------
    who
    ix_uni : optional
    ix_branch : optional
    which : default=model
    flags : default=-array_out

    Returns
    -------
    string_list
        if '-array_out' not in flags
    real_array
        if '-array_out' in flags

    Notes
    -----
    Command syntax:
      python spin_invariant {flags} {who} {ix_uni}@{ix_branch}|{which}

    Where:
      {flags} are optional switches:
          -array_out : If present, the output will be available in the tao_c_interface_com%c_real.
      {who} is one of: l0, n0, or m0
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {ix_branch} is a branch index. Defaults to s%global%default_branch.
      {which} is one of:
        model
        base
        design

    Example:
      python spin_invariant 1@0|model

    Note: This command is under development. If you want to use please contact David Sagan.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args: 
       who: l0
       ix_uni: 1
       ix_branch: 0
       which: model

    """
    cmd = f'python spin_invariant {flags} {who} {ix_uni}@{ix_branch}|{which}'
    if verbose: print(cmd)
    if '-array_out' not in flags:
        return __execute(tao, cmd, as_dict, raises, method_name='spin_invariant', cmd_type='string_list')
    if '-array_out' in flags:
        return __execute(tao, cmd, as_dict, raises, method_name='spin_invariant', cmd_type='real_array')

spin_polarization(tao, *, ix_uni='', ix_branch='', which='model', verbose=False, as_dict=True, raises=True)

Output spin polarization information

Parameters

ix_uni : optional ix_branch : optional which : default=model

Returns

string_list

Notes

Command syntax: python spin_polarization {ix_uni}@{ix_branch}|{which}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe. {ix_branch} is a branch index. Defaults to s%global%default_branch. {which} is one of: model base design

Example

python spin_polarization 1@0|model

Note: This command is under development. If you want to use please contact David Sagan.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1 ix_branch: 0 which: model

Source code in pytao/interface_commands.py 
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
def spin_polarization(tao, *, ix_uni='', ix_branch='', which='model', verbose=False, as_dict=True, raises=True):
    """

    Output spin polarization information

    Parameters
    ----------
    ix_uni : optional
    ix_branch : optional
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python spin_polarization {ix_uni}@{ix_branch}|{which}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {ix_branch} is a branch index. Defaults to s%global%default_branch.
      {which} is one of:
        model
        base
        design

    Example:
      python spin_polarization 1@0|model

    Note: This command is under development. If you want to use please contact David Sagan.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args: 
       ix_uni: 1
       ix_branch: 0
       which: model

    """
    cmd = f'python spin_polarization {ix_uni}@{ix_branch}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='spin_polarization', cmd_type='string_list')

spin_resonance(tao, *, ix_uni='', ix_branch='', which='model', ref_ele='0', verbose=False, as_dict=True, raises=True)

Output spin resonance information

Parameters

ix_uni : optional ix_branch : optional which : default=model ref_ele : default=0 Reference element to calculate at.

Returns

string_list

Notes

Command syntax: python spin_resonance {ix_uni}@{ix_branch}|{which} {ref_ele}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe. {ix_branch} is a lattice branch index. Defaults to s%global%default_branch. {which} is one of: "model", "base" or "design" {ref_ele} is an element name or index.

This will return a string_list with the following fields: spin_tune -- Spin tune dq_X_sum, dq_X_diff -- Tune sum Q_spin+Q_mode and tune difference Q_spin-Q_mode for modes X = a, b, and c. xi_res_X_sum, xi_res_X_diff -- The linear spin/orbit sum and difference resonance strengths for X = a, b, and c modes.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1 ix_branch: 0 which: model

Source code in pytao/interface_commands.py 
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
def spin_resonance(tao, *, ix_uni='', ix_branch='', which='model', ref_ele='0', verbose=False, as_dict=True, raises=True):
    """

    Output spin resonance information

    Parameters
    ----------
    ix_uni : optional
    ix_branch : optional
    which : default=model
    ref_ele : default=0
        Reference element to calculate at.

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python spin_resonance {ix_uni}@{ix_branch}|{which} {ref_ele}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.
      {which} is one of: "model", "base" or "design"
      {ref_ele} is an element name or index.
    This will return a string_list with the following fields:
      spin_tune                   -- Spin tune
      dq_X_sum, dq_X_diff         -- Tune sum Q_spin+Q_mode and tune difference Q_spin-Q_mode for modes X = a, b, and c.
      xi_res_X_sum, xi_res_X_diff -- The linear spin/orbit sum and difference resonance strengths for X = a, b, and c modes.  

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args: 
       ix_uni: 1
       ix_branch: 0
       which: model

    """
    cmd = f'python spin_resonance {ix_uni}@{ix_branch}|{which} {ref_ele}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='spin_resonance', cmd_type='string_list')

super_universe(tao, *, verbose=False, as_dict=True, raises=True)

Output super_Universe parameters.

Returns

string_list

Notes

Command syntax: python super_universe

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
def super_universe(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output super_Universe parameters.

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python super_universe

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args: 

    """
    cmd = f'python super_universe'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='super_universe', cmd_type='string_list')

tao_global(tao, *, verbose=False, as_dict=True, raises=True)

Output global parameters.

Returns

string_list

Notes

Command syntax: python global

Output syntax is parameter list form. See documentation at the beginning of this file.

The follow is intentionally left out:

optimizer_allow_user_abort quiet single_step prompt_color prompt_string

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
def tao_global(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output global parameters.

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python global

    Output syntax is parameter list form. See documentation at the beginning of this file.

    Note: The follow is intentionally left out:
      optimizer_allow_user_abort
      quiet
      single_step
      prompt_color
      prompt_string

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:

    """
    cmd = f'python global'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='tao_global', cmd_type='string_list')

taylor_map(tao, ele1_id, ele2_id, *, order='1', verbose=False, as_dict=True, raises=True)

Output Taylor map between two points.

Parameters

ele1_id ele2_id order : default=1

Returns

dict of dict of taylor terms: {2: { (3,0,0,0,0,0)}: 4.56, ... corresponding to: px_out = 4.56 * x_in^3

Notes

Command syntax: python taylor_map {ele1_id} {ele2_id} {order}

Where

{ele1_id} is the start element. {ele2_id} is the end element. {order} is the map order. Default is order set in the lattice file. {order} cannot be larger than what is set by the lattice file.

If {ele2_id} = {ele1_id}, the 1-turn transfer map is computed. Note: {ele2_id} should just be an element name or index without universe, branch, or model/base/design specification. Example: python taylor_map 2@1>>q01w|design q02w 2

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ele1_id: 1@0>>q01w|design ele2_id: q02w order: 1

Source code in pytao/interface_commands.py 
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
def taylor_map(tao, ele1_id, ele2_id, *, order='1', verbose=False, as_dict=True, raises=True):
    """

    Output Taylor map between two points.

    Parameters
    ----------
    ele1_id
    ele2_id
    order : default=1

    Returns
    -------
    dict of dict of taylor terms:
        {2: { (3,0,0,0,0,0)}: 4.56, ... 
            corresponding to: px_out = 4.56 * x_in^3

    Notes
    -----
    Command syntax:
      python taylor_map {ele1_id} {ele2_id} {order}

    Where:
      {ele1_id} is the start element.
      {ele2_id} is the end element.
      {order} is the map order. Default is order set in the lattice file. {order} cannot be larger than 
            what is set by the lattice file. 
    If {ele2_id} = {ele1_id}, the 1-turn transfer map is computed.
    Note: {ele2_id} should just be an element name or index without universe, branch, or model/base/design specification.
    Example:
      python taylor_map 2@1>>q01w|design q02w  2

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       ele1_id: 1@0>>q01w|design
       ele2_id: q02w
       order: 1

    """
    cmd = f'python taylor_map {ele1_id} {ele2_id} {order}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='taylor_map', cmd_type='string_list')

twiss_at_s(tao, *, ix_uni='', ele='', s_offset='', which='model', verbose=False, as_dict=True, raises=True)

Output twiss parameters at given s position.

Parameters

ix_uni : optional ele : optional s_offset : optional which : default=model

Returns

string_list

Notes

Command syntax: python twiss_at_s {ix_uni}@{ele}->{s_offset}|{which}

Where

{ix_uni} is a universe index. Defaults to s%global%default_universe. {ele} is an element name or index. Default at the Beginning element at start of branch 0. {s_offset} is the offset of the evaluation point from the downstream end of ele. Default is 0. If {s_offset} is present, the preceeding "->" sign must be present. EG: Something like "23|model" will {which} is one of: "model", "base" or "design".

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1 ele: 10 s_offset: 0.7 which: model

Source code in pytao/interface_commands.py 
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
def twiss_at_s(tao, *, ix_uni='', ele='', s_offset='', which='model', verbose=False, as_dict=True, raises=True):
    """

    Output twiss parameters at given s position.

    Parameters
    ----------
    ix_uni : optional
    ele : optional
    s_offset : optional
    which : default=model

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python twiss_at_s {ix_uni}@{ele}->{s_offset}|{which}

    Where:
      {ix_uni} is a universe index. Defaults to s%global%default_universe.
      {ele} is an element name or index. Default at the Beginning element at start of branch 0.
      {s_offset} is the offset of the evaluation point from the downstream end of ele. Default is 0.
         If {s_offset} is present, the preceeding "->" sign must be present. EG: Something like "23|model" will
      {which} is one of: "model", "base" or "design".

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args: 
       ix_uni: 1
       ele: 10
       s_offset: 0.7
       which: model 

    """
    cmd = f'python twiss_at_s {ix_uni}@{ele}->{s_offset}|{which}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='twiss_at_s', cmd_type='string_list')

universe(tao, ix_uni, *, verbose=False, as_dict=True, raises=True)

Output universe info.

Parameters

ix_uni

Returns

string_list

Notes

Command syntax: python universe {ix_uni}

Use "python global" to get the number of universes.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: ix_uni: 1

Source code in pytao/interface_commands.py 
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
def universe(tao, ix_uni, *, verbose=False, as_dict=True, raises=True):
    """

    Output universe info.

    Parameters
    ----------
    ix_uni

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python universe {ix_uni}

    Use "python global" to get the number of universes.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args: 
       ix_uni: 1

    """
    cmd = f'python universe {ix_uni}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='universe', cmd_type='string_list')

var(tao, var, *, slaves='', verbose=False, as_dict=True, raises=True)

Output parameters of a given variable.

Parameters

var slaves : optional

Returns

string_list

Notes

Command syntax: python var {var} slaves

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: var: quad[1] slaves:

2

init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: var: quad[1] slaves: slaves

Source code in pytao/interface_commands.py 
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
def var(tao, var, *, slaves='', verbose=False, as_dict=True, raises=True):
    """

    Output parameters of a given variable.

    Parameters
    ----------
    var
    slaves : optional

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python var {var} slaves

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args: 
       var: quad[1]
       slaves:

    Example: 2
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args: 
       var: quad[1]
       slaves: slaves

    """
    cmd = f'python var {var} slaves'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='var', cmd_type='string_list')

var_create(tao, var_name, ele_name, attribute, universes, weight, step, low_lim, high_lim, merit_type, good_user, key_bound, key_delta, *, verbose=False, as_dict=True, raises=True)

Create a single variable

Parameters

var_name ele_name attribute universes weight step low_lim high_lim merit_type good_user key_bound key_delta

Returns

string_list

Notes

Command syntax: python var_create {var_name}^^{ele_name}^^{attribute}^^{universes}^^ {weight}^^{step}^^{low_lim}^^{high_lim}^^{merit_type}^^ {good_user}^^{key_bound}^^{key_delta}

{var_name} is something like "kick[5]". Before using var_create, setup the appropriate v1_var array using the "python var_v1_create" command.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching args: var_name: quad[1] ele_name: Q1 attribute: L universes: 1 weight: 0.001 step: 0.001 low_lim: -10 high_lim: 10 merit_type: good_user: T key_bound: T key_delta: 0.01

Source code in pytao/interface_commands.py 
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
def var_create(tao, var_name, ele_name, attribute, universes, weight, step, low_lim, high_lim, merit_type, good_user, key_bound, key_delta, *, verbose=False, as_dict=True, raises=True):
    """

    Create a single variable

    Parameters
    ----------
    var_name
    ele_name
    attribute
    universes
    weight
    step
    low_lim
    high_lim
    merit_type
    good_user
    key_bound
    key_delta

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python var_create {var_name}^^{ele_name}^^{attribute}^^{universes}^^
                        {weight}^^{step}^^{low_lim}^^{high_lim}^^{merit_type}^^
                        {good_user}^^{key_bound}^^{key_delta}

    {var_name} is something like "kick[5]".
    Before using var_create, setup the appropriate v1_var array using 
    the "python var_v1_create" command.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/tao.init_optics_matching
     args:
       var_name: quad[1]
       ele_name: Q1
       attribute: L
       universes: 1
       weight: 0.001
       step: 0.001
       low_lim: -10
       high_lim: 10
       merit_type: 
       good_user: T
       key_bound: T
       key_delta: 0.01 

    """
    cmd = f'python var_create {var_name}^^{ele_name}^^{attribute}^^{universes}^^{weight}^^{step}^^{low_lim}^^{high_lim}^^{merit_type}^^{good_user}^^{key_bound}^^{key_delta}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='var_create', cmd_type='string_list')

var_general(tao, *, verbose=False, as_dict=True, raises=True)

Output list of all variable v1 arrays

Returns

string_list

Notes

Command syntax: python var_general

Output syntax

{v1_var name};{v1_var%v lower bound};{v1_var%v upper bound}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args:

Source code in pytao/interface_commands.py 
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
def var_general(tao, *, verbose=False, as_dict=True, raises=True):
    """

    Output list of all variable v1 arrays

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python var_general

    Output syntax:
      {v1_var name};{v1_var%v lower bound};{v1_var%v upper bound}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:

    """
    cmd = f'python var_general'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='var_general', cmd_type='string_list')

var_v1_array(tao, v1_var, *, verbose=False, as_dict=True, raises=True)

Output list of variables in a given variable v1 array

Parameters

v1_var

Returns

string_list

Notes

Command syntax: python var_v1_array {v1_var}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: v1_var: quad_k1

Source code in pytao/interface_commands.py 
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
def var_v1_array(tao, v1_var, *, verbose=False, as_dict=True, raises=True):
    """

    Output list of variables in a given variable v1 array

    Parameters
    ----------
    v1_var

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python var_v1_array {v1_var}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       v1_var: quad_k1 

    """
    cmd = f'python var_v1_array {v1_var}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='var_v1_array', cmd_type='string_list')

var_v1_create(tao, v1_name, n_var_min, n_var_max, *, verbose=False, as_dict=True, raises=True)

Create a v1 variable structure along with associated var array.

Parameters

v1_name n_var_min n_var_max

Returns

string_list

Notes

Command syntax: python var_v1_create {v1_name} {n_var_min} {n_var_max}

{n_var_min} and {n_var_max} are the lower and upper bounds of the var Example: python var_v1_create quad_k1 0 45 This example creates a v1 var structure called "quad_k1" with an associated variable array that has the range [0, 45].

Use the "set variable" command to set a created variable parameters. In particular, to slave a lattice parameter to a variable use the command: set {v1_name}|ele_name = {lat_param} where {lat_param} is of the form {ix_uni}@{ele_name_or_location}{param_name}] Examples: set quad_k1[2]|ele_name = 2@q01w[k1] set quad_k1[2]|ele_name = 2@0>>10[k1] Note: When setting multiple variable parameters, temporarily toggle s%global%lattice_calc_on to False ("set global lattice_calc_on = F") to prevent Tao trying to evaluate the partially created variable and generating unwanted error messages.

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: v1_name: quad_k1 n_var_min: 0 n_var_max: 45

Source code in pytao/interface_commands.py 
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
def var_v1_create(tao, v1_name, n_var_min, n_var_max, *, verbose=False, as_dict=True, raises=True):
    """

    Create a v1 variable structure along with associated var array.

    Parameters
    ----------
    v1_name
    n_var_min
    n_var_max

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python var_v1_create {v1_name} {n_var_min} {n_var_max}

    {n_var_min} and {n_var_max} are the lower and upper bounds of the var
    Example:
      python var_v1_create quad_k1 0 45
    This example creates a v1 var structure called "quad_k1" with an associated
    variable array that has the range [0, 45].

    Use the "set variable" command to set a created variable parameters.
    In particular, to slave a lattice parameter to a variable use the command:
      set {v1_name}|ele_name = {lat_param}
    where {lat_param} is of the form {ix_uni}@{ele_name_or_location}{param_name}]
    Examples:
      set quad_k1[2]|ele_name = 2@q01w[k1]
      set quad_k1[2]|ele_name = 2@0>>10[k1]
    Note: When setting multiple variable parameters, 
          temporarily toggle s%global%lattice_calc_on to False
      ("set global lattice_calc_on = F") to prevent Tao trying to evaluate the 
    partially created variable and generating unwanted error messages.

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       v1_name: quad_k1 
       n_var_min: 0 
       n_var_max: 45 

    """
    cmd = f'python var_v1_create {v1_name} {n_var_min} {n_var_max}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='var_v1_create', cmd_type='string_list')

var_v1_destroy(tao, v1_datum, *, verbose=False, as_dict=True, raises=True)

Destroy a v1 var structure along with associated var sub-array.

Parameters

v1_datum

Returns

string_list

Notes

Command syntax: python var_v1_destroy {v1_datum}

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: v1_datum: quad_k1

Source code in pytao/interface_commands.py 
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
def var_v1_destroy(tao, v1_datum, *, verbose=False, as_dict=True, raises=True):
    """

    Destroy a v1 var structure along with associated var sub-array.

    Parameters
    ----------
    v1_datum

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python var_v1_destroy {v1_datum}

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       v1_datum: quad_k1

    """
    cmd = f'python var_v1_destroy {v1_datum}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='var_v1_destroy', cmd_type='string_list')

var_v_array(tao, v1_var, *, verbose=False, as_dict=True, raises=True)

Output list of variables for a given data_v1.

Parameters

v1_var

Notes

Command syntax: python var_v_array {v1_var}

Example

python var_v_array quad_k1

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: v1_var: quad_k1

Source code in pytao/interface_commands.py 
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
def var_v_array(tao, v1_var, *, verbose=False, as_dict=True, raises=True):
    """

    Output list of variables for a given data_v1.

    Parameters
    ----------
    v1_var

    Notes
    -----
    Command syntax:
      python var_v_array {v1_var}

    Example:
      python var_v_array quad_k1

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       v1_var: quad_k1

    """
    cmd = f'python var_v_array {v1_var}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='var_v_array', cmd_type='string_list')

wave(tao, who, *, verbose=False, as_dict=True, raises=True)

Output Wave analysis info.

Parameters

who

Returns

string_list

Notes

Command syntax: python wave {who}

Where {who} is one of: params loc_header locations plot1, plot2, plot3

Examples

Example: 1 init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init args: who: params

Source code in pytao/interface_commands.py 
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
def wave(tao, who, *, verbose=False, as_dict=True, raises=True):
    """

    Output Wave analysis info.

    Parameters
    ----------
    who

    Returns
    -------
    string_list

    Notes
    -----
    Command syntax:
      python wave {who}

    Where {who} is one of:
      params
      loc_header
      locations
      plot1, plot2, plot3

    Examples
    --------
    Example: 1
     init: -init $ACC_ROOT_DIR/regression_tests/python_test/cesr/tao.init
     args:
       who: params

    """
    cmd = f'python wave {who}'
    if verbose: print(cmd)
    return __execute(tao, cmd, as_dict, raises, method_name='wave', cmd_type='string_list')

bunch_data(tao, ele_id, *, which='model', ix_bunch=1, verbose=False)

Returns bunch data in openPMD-beamphysics format/notation.

Notes

Note that Tao's 'write beam' will also write a proper h5 file in this format.

Expected usage

data = bunch_data(tao, 'end') from pmd_beamphysics import ParticleGroup P = ParicleGroup(data=data)

Returns

data : dict dict of arrays, with keys 'x', 'px', 'y', 'py', 't', 'pz', 'status', 'weight', 'z', 'species'

Examples

Example: 1 init: $ACC_ROOT_DIR/tao/examples/csr_beam_tracking/tao.init args: ele_id: end which: model ix_bunch: 1

Source code in pytao/tao_ctypes/extra_commands.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def bunch_data(tao, ele_id, *, which='model', ix_bunch=1,  verbose=False):
    """    
    Returns bunch data in openPMD-beamphysics format/notation.

    Notes
    -----
    Note that Tao's 'write beam' will also write a proper h5 file in this format.

    Expected usage:
        data = bunch_data(tao, 'end')
        from pmd_beamphysics import ParticleGroup
        P = ParicleGroup(data=data)


    Returns
    -------
    data : dict
         dict of arrays, with keys 'x', 'px', 'y', 'py', 't', 'pz', 'status', 'weight', 'z', 'species'


    Examples
    --------
    Example: 1
     init: $ACC_ROOT_DIR/tao/examples/csr_beam_tracking/tao.init
     args:
       ele_id: end
       which: model
       ix_bunch: 1  

    """

    # Get species
    stats = tao.bunch_params(ele_id, which=which, verbose=verbose)
    species = stats['species']

    dat = {}
    for coordinate in ['x', 'px', 'y', 'py',  't', 'pz', 'p0c', 'charge', 'state']:
        dat[coordinate] = tao.bunch1(ele_id, coordinate=coordinate, which=which, ix_bunch=ix_bunch, verbose=verbose)

    # Remove normalizations
    p0c = dat.pop('p0c')

    dat['status'] = dat.pop('state')
    dat['weight'] = dat.pop('charge')

    # px from Bmad is px/p0c 
    # pz from Bmad is delta = p/p0c -1. 
    # pz = sqrt( (delta+1)**2 -px**2 -py**2)*p0c
    dat['pz'] = np.sqrt((dat['pz'] + 1)**2 - dat['px']**2 - dat['py']**2) * p0c
    dat['px'] = dat['px']*p0c
    dat['py'] = dat['py']*p0c

    # z = 0 by definition
    dat['z'] = np.full(len(dat['x']), 0)

    dat['species'] = species.lower()

    return dat