From 59960ff87a515ac6e9947277a6e87e76ad0a48b6 Mon Sep 17 00:00:00 2001 From: David Sagan Date: Fri, 7 Feb 2025 11:38:25 -0500 Subject: [PATCH 1/2] `quiet` code and documentation reorg. --- sim_utils/io/output_mod.f90 | 7 +++--- tao/code/tao_abort_command_file.f90 | 1 + tao/code/tao_call_cmd.f90 | 1 + tao/code/tao_close_command_file.f90 | 1 + tao/code/tao_get_user_input_mod.f90 | 6 +---- tao/code/tao_parse_command_args.f90 | 10 ++++++++- tao/code/tao_pipe_cmd.f90 | 13 +++++++---- tao/code/tao_print_command_line_info.f90 | 3 ++- tao/code/tao_quiet_set.f90 | 24 +++++++++----------- tao/code/tao_struct.f90 | 4 ++-- tao/doc/command-list.tex | 28 +++++++++++------------- tao/doc/cover-page.tex | 2 +- tao/doc/initialization.tex | 17 +++++++------- tao/doc/pipe-interface-commands.json | 2 +- tao/doc/pipe-interface-commands.tex | 2 +- 15 files changed, 64 insertions(+), 57 deletions(-) diff --git a/sim_utils/io/output_mod.f90 b/sim_utils/io/output_mod.f90 index 6cd4f9fbeb..9d8c639b56 100644 --- a/sim_utils/io/output_mod.f90 +++ b/sim_utils/io/output_mod.f90 @@ -143,7 +143,8 @@ module output_mod ! file_unit -- integer, optional: Unit number for writing to a file. ! -1 => No writing (initial default setting). ! print_and_capture -- logical, optional: If present then this sets whether output is printed to the terminal and/or -! captured for program use. See the out_io_print_and_caputure_setup routine documentation for more details. +! captured for program use. Note: How output capture works is also set by the out_io_print_and_caputure_setup routine. +! See the out_io_print_and_caputure_setup routine documentation for more details. ! min_level -- integer, optional: Minimum message status level to apply to. ! Default is s_blank$ ! max_level -- integer, optional: Maximum message status level to apply to. @@ -151,7 +152,6 @@ module output_mod ! set -- out_io_output_direct_struct, optional: If present, use this structure to set where output goes. ! This structure can be used in place of specifying file_unit, etc. One way to use "set" is to first ! call this routine with the "get" argument to get the output direction state. -! ! ! Output: ! get -- out_io_output_direct_struct, optional: If present, capture the output direction state before any setting @@ -170,7 +170,6 @@ subroutine output_direct (file_unit, print_and_capture, min_level, max_level, se ! if (present(get)) get = out_io_direct - if (present(set)) out_io_direct = set do i = integer_option(s_blank$, min_level), integer_option(s_important$, max_level) @@ -731,7 +730,7 @@ end subroutine header_io ! The procedure for how a message is handled is as follows: ! First: When out_io is called, the message level is used to determine if anything is to be printed or captured at all. ! When a program is started, everything will pass this test for printing and/or capturing. -! This behavior can be modified by by calls to the output_direct routine. +! This behavior can be modified by calls to the output_direct routine. ! Second: If a message is to be printed and/or captured (passes the first step), then the internal print_on flag is used ! to determine if printing to the terminal and the internal capture_state flag is used to determine if capture is ! to be done. The initial setting of these flags is print_on = True and capture_state = 'OFF'. diff --git a/tao/code/tao_abort_command_file.f90 b/tao/code/tao_abort_command_file.f90 index 29368ca87b..1dc34fe072 100644 --- a/tao/code/tao_abort_command_file.f90 +++ b/tao/code/tao_abort_command_file.f90 @@ -24,5 +24,6 @@ subroutine tao_abort_command_file() enddo s%com%saved_cmd_line = '' +call tao_quiet_set('cmd-file-end') end subroutine diff --git a/tao/code/tao_call_cmd.f90 b/tao/code/tao_call_cmd.f90 index ab62af590f..eaed2e0032 100644 --- a/tao/code/tao_call_cmd.f90 +++ b/tao/code/tao_call_cmd.f90 @@ -98,6 +98,7 @@ subroutine tao_call_cmd (file_name, cmd_arg) s%com%cmd_file(nl)%ix_unit = iu s%com%cmd_file(nl)%full_name = full_name +s%com%cmd_file(nl)%quiet = s%com%cmd_file(nl0)%quiet ! Save command arguments. diff --git a/tao/code/tao_close_command_file.f90 b/tao/code/tao_close_command_file.f90 index 16cfde076a..ec037e40e1 100644 --- a/tao/code/tao_close_command_file.f90 +++ b/tao/code/tao_close_command_file.f90 @@ -25,5 +25,6 @@ subroutine tao_close_command_file() endif s%com%cmd_file_level = n - 1 +call tao_quiet_set('cmd-file-end') end subroutine diff --git a/tao/code/tao_get_user_input_mod.f90 b/tao/code/tao_get_user_input_mod.f90 index a6500d1577..6c75113ee4 100644 --- a/tao/code/tao_get_user_input_mod.f90 +++ b/tao/code/tao_get_user_input_mod.f90 @@ -134,14 +134,11 @@ subroutine tao_get_user_input (cmd_out, prompt_str, wait_flag, cmd_in) ! If a command file is open then read a line from the file. n_level = s%com%cmd_file_level -if (n_level == 0) call tao_quiet_set ('cmd-file-end') ! verbose if not running from a command file if (n_level /= 0 .and. .not. s%com%cmd_file(n_level)%paused) then - if (s%global%single_step) then call read_a_line ('Single_step: Press to continue...', name, & prompt_color = s%global%prompt_color, prompt_bold = boldit) - endif call output_direct (print_and_capture = (s%global%quiet /= 'all'), min_level = s_blank$, max_level = s_dwarn$) @@ -151,7 +148,7 @@ subroutine tao_get_user_input (cmd_out, prompt_str, wait_flag, cmd_in) do read (s%com%cmd_file(n_level)%ix_unit, '(a)', end = 8000, iostat = ios) cmd_out(ix+1:) if (ios /= 0) then - call tao_quiet_set('cmd-file-end') + call tao_quiet_set('off') call out_io (s_error$, r_name, 'CANNOT READ LINE FROM FILE: ' // s%com%cmd_file(n_level)%full_name) goto 8000 endif @@ -285,7 +282,6 @@ subroutine tao_get_user_input (cmd_out, prompt_str, wait_flag, cmd_in) endif endif -call tao_quiet_set('cmd-file-end') return !------------------------------------------------------------------------- diff --git a/tao/code/tao_parse_command_args.f90 b/tao/code/tao_parse_command_args.f90 index 5f9bca3695..73b5394463 100644 --- a/tao/code/tao_parse_command_args.f90 +++ b/tao/code/tao_parse_command_args.f90 @@ -183,7 +183,15 @@ subroutine tao_parse_command_args (error, cmd_line) endif case ('-quiet', '-silent_run') ! "-silent_run" is old syntax - s%init%quiet_arg = 'all' + if (i_arg < n_arg) then + call get_next_arg (arg0, s%init%quiet_arg, i_arg, n_arg) + if (s%init%quiet_arg(1:1) == '-') then + s%init%quiet_arg = 'all' + i_arg = i_arg - 1 + endif + else + s%init%quiet_arg = 'all' + endif case ('-reverse') s%init%reverse_arg = present_str diff --git a/tao/code/tao_pipe_cmd.f90 b/tao/code/tao_pipe_cmd.f90 index 997306d3c5..ae0403d3e0 100644 --- a/tao/code/tao_pipe_cmd.f90 +++ b/tao/code/tao_pipe_cmd.f90 @@ -261,12 +261,12 @@ subroutine tao_pipe_cmd (input_str) 'wall3d_radius', 'wave'], ix, matched_name = command) if (ix == 0) then - call out_io (s_error$, r_name, 'pipe what? "What" not recognized: ' // command) + call out_io (s_error$, r_name, 'pipe what? ' // quote(cmd) // ' is not recognized.') return endif if (ix < 0) then - call out_io (s_error$, r_name, 'pipe what? Ambiguous command: ' // command) + call out_io (s_error$, r_name, 'pipe what? ' // quote(cmd) // ' is an ambiguous command.') return endif @@ -4884,9 +4884,9 @@ subroutine tao_pipe_cmd (input_str) ! 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. +! ele.XXX ! Where XXX is a Bmad syntax element attribute. (EG: ele.beta_a, ele.k1, etc.) ! ! {elements} is a string to match element names to. ! Use "*" to match to all elements. @@ -8063,12 +8063,15 @@ subroutine tao_pipe_cmd (input_str) subroutine end_stuff(li, nl) - +type (out_io_output_direct_struct) out_dir_state character(n_char_show), allocatable :: li(:) integer nl, i ! +call output_direct (get = out_dir_state) +call output_direct(print_and_capture = .true.) + if (doprint) then call out_io (s_blank$, r_name, li(1:nl)) endif @@ -8080,6 +8083,8 @@ subroutine end_stuff(li, nl) close (iu_write) endif +call output_direct (get = out_dir_state) + end subroutine !---------------------------------------------------------------------- diff --git a/tao/code/tao_print_command_line_info.f90 b/tao/code/tao_print_command_line_info.f90 index 4a642f4cf6..9072be6e0e 100644 --- a/tao/code/tao_print_command_line_info.f90 +++ b/tao/code/tao_print_command_line_info.f90 @@ -42,7 +42,8 @@ subroutine tao_print_command_line_info ' -prompt_color # Set color of prompt string. Default is blue. ', & ' -reverse # Reverse lattice element order? ', & ' -rf_on # Use "--rf_on" to turn off RF (default is now RF on) ', & - ' -quiet # Suppress terminal output when running a command file? ', & + ' -quiet # Suppress terminal output when running a command file? ', & + ' # Levels: "all" (default), "warnings". ', & ' -slice_lattice # Discards elements from lattice that are not in the list', & ' -start_branch_at # Start lattice branch at element. ', & ' -startup_file # Commands to run after parsing Tao init file ', & diff --git a/tao/code/tao_quiet_set.f90 b/tao/code/tao_quiet_set.f90 index 25d1f5ad44..6f8a772794 100644 --- a/tao/code/tao_quiet_set.f90 +++ b/tao/code/tao_quiet_set.f90 @@ -1,7 +1,8 @@ !+ ! Subroutine tao_quiet_set (set) ! -! Routine to set on/off silent command file running. +! Routine to set silent running. +! Note: s_important$, s_error$ and s_fatal$ levels are never supressed. ! ! Input: ! set -- logical: True is silent running is wanted. @@ -12,26 +13,20 @@ subroutine tao_quiet_set (set) use tao_struct implicit none -type (out_io_output_direct_struct), save :: out_dir_save -integer ix +integer ix, n_level character(*) set character(12) name character(*), parameter :: r_name = 'tao_quiet_set' ! +n_level = s%com%cmd_file_level + if (set == '') then name = 'all' elseif (set == 'cmd-file-end') then - if (s%global%quiet == 'All') then - name = 'off' - else - name = s%global%quiet - endif - -elseif (set == 'ALL') then - name = set + name = s%com%cmd_file(n_level)%quiet else call match_word (set, [character(12):: 'off', 'all', 'warnings'], ix, .false., .true., name) @@ -43,15 +38,16 @@ subroutine tao_quiet_set (set) ! -if (s%global%quiet == 'off') call output_direct(get = out_dir_save) +s%com%cmd_file(n_level)%quiet = name s%global%quiet = name select case (name) case ('off') - call output_direct (set = out_dir_save) + call output_direct (-1, .true., s_blank$, s_dwarn$) case ('warnings') + call output_direct (-1, .true., s_blank$, s_dwarn$) call output_direct (-1, .false., s_warn$, s_dwarn$) ! Do not print -case ('all', 'ALL') +case ('all') call output_direct (-1, .false., s_blank$, s_dwarn$) ! Do not print end select diff --git a/tao/code/tao_struct.f90 b/tao/code/tao_struct.f90 index 71df08d905..9a1de326c4 100644 --- a/tao/code/tao_struct.f90 +++ b/tao/code/tao_struct.f90 @@ -61,7 +61,6 @@ module tao_struct type tao_cmd_history_struct ! Record the command history character(:), allocatable :: cmd ! The command integer :: ix = 0 ! Command index (1st command has ix = 1, etc.) - !! logical :: cmd_file = '' ! Did command come from a command file end type !----------------------------------------------------------------------- @@ -663,7 +662,7 @@ module tao_struct integer :: datum_err_messages_max = 10 ! Maximum number of error messages per call to lattice_calc. integer :: srdt_sxt_n_slices = 20 ! Number times to slice sextupoles for summation RDT calculation logical :: srdt_use_cache = .true. ! Create cache for SRDT calculations. Can use lots of memory if srdt_*_n_slices large. - character(12) :: quiet = 'off' ! "all", or "output". Print I/O when running a command file? + character(12) :: quiet = 'off' ! Print I/O when running a command file? character(16) :: random_engine = '' ! Non-beam random number engine character(16) :: random_gauss_converter = '' ! Non-beam character(16) :: track_type = 'single' ! or 'beam' @@ -718,6 +717,7 @@ module tao_struct character(200) :: dir = './' integer :: ix_unit character(40) :: cmd_arg(9) = '' ! Command file arguments. + character(12) :: quiet = 'off' logical :: paused = .false. ! Is the command file paused? integer :: n_line = 0 ! Current line number logical :: reset_at_end = .true. ! Reset lattice_calc_on and plot_on at end of file? diff --git a/tao/doc/command-list.tex b/tao/doc/command-list.tex index 00b2ffaf1c..28d9698ebe 100644 --- a/tao/doc/command-list.tex +++ b/tao/doc/command-list.tex @@ -173,12 +173,10 @@ \section{call}\index{commands!call} \begin{example} set global quiet = all ! Suppress everything except errors set global quiet = warnings ! Suppress just warnings. + set global quiet = off ! No suppression \end{example} -Note: the \vn{all} setting (but not the \vn{warnings} setting) is automatically switched to \vn{off} -at the end when a command file exits back to the terminal level. To prevent this reset, set to -\vn{ALL} instead. See the \vn{Tao_global_struct Structure} section (\sref{s:tao.global.struct}) for -more details. - +Note: if \vn{quiet} is set in a command file, the setting will persist to the end of the file and then +revert to what it was before the command file was run. Examples: \begin{example} @@ -345,7 +343,7 @@ \section{create}\index{commands!create} \end{example} The \vn{create} command constructs various tao objects that would have -otherwise been created in tao initialiation. +otherwise been created in tao initialization. % Use the command: % help create @@ -1740,14 +1738,14 @@ \subsection{set tune} The \vn{-listing} option, if present, will, in addition to the tune change, generate a list of quadrupoles varied along with variation coefficients. -It is sometimes desireable to veto from changing certain quadrupols (or overlays). The +It is sometimes desirable to veto from changing certain quadrupoles (or overlays). The \vn{} of the \vn{-mask} option gives a list of quadrupoles {\em not} to use. A tilde \vn{~} in front of an element name means that the element will not be vetoed. This can be used to specify what quadrupoles to use (not veto). For example: \begin{example} set tune -mask *,~qf_\%\%,~qd_\% 0.23 0.45 \end{example} -In this example, the mask string has three ``words'' speparated by commas. The first word is +In this example, the mask string has three ``words'' separated by commas. The first word is ``\vn{*}'' which will veto everything. The second word \vn{~qf_\%} reinstates all elements whose name starts with \vn{qf_} and has exactly two characters after the beginning \vn{qf_}. The third word reinstates all elements that match the wild card pattern \vn{qd_\%}. The upshot is that only @@ -3058,11 +3056,11 @@ \subsection{show spin} \item Col 1: Name of mode \item Col 2: Orbital tune. \item Col 3: Q_spin + Q_mode + N where N is an integer that minimizes this expression. -The sum resonance occures when this is zero. +The sum resonance occurs when this is zero. \item Col 4: Sum resonance strength. This number is only accurate if the value of column 3 is small compared to one. \item Col 5: Q_spin - Q_mode + N where N is an integer that minimizes this expression. -The difference resonance occures when this is zero. +The difference resonance occurs when this is zero. \item Col 6: Difference resonance strength. This number is only accurate if the value of column 5 is small compared to one. \end{Itemize} @@ -3082,11 +3080,11 @@ \subsection{show spin} monomial ``[1 1 0 0 0 0]'' corresponds to $J_a$, and if RF is on then ``[1 1 2 2 3 3]'' corresponds to $J_a*J_b^2*J_c^3$. -The \vn{-x_zero}, \vn{-y_zero}, and \vn{-z_zero} options are for testing if supressing certain terms +The \vn{-x_zero}, \vn{-y_zero}, and \vn{-z_zero} options are for testing if suppressing certain terms in the linear part of the spin transport map for a set of elements selected by the user will significantly affect the polarization. This is discussed in the section ``\vn{Linear dn/dpz Calculation}'' in the \bmad manual. In particular, \vn{-x_zero} will zero the $\bfq_1$ and $\bfq_2$ -terms in the $\arrowbfq$ vector (equivalent to zeroing $\bfG_x$ in the SLIM fromalism) for the spin +terms in the $\arrowbfq$ vector (equivalent to zeroing $\bfG_x$ in the SLIM formalism) for the spin transport map of the chosen lattice elements. Similarly, \vn{-y_zero} and \vn{-z_zero} will zero vertical and longitudinal components. Element list format (\sref{s:ele.list.format}), without any embedded blanks, is used for the \vn{} list of elements to apply to. @@ -3984,7 +3982,7 @@ \subsection{write bunch_comb} \label{s:write.bunch.comb} The \vn{write bunch_comb} command writes to a file bunch parameters (bunch sigma matrix, etc.) at -the ``comb'' points where these aggragrate bunch parameters are saved (\sref{s:beam.init}). Also see +the ``comb'' points where these aggregate bunch parameters are saved (\sref{s:beam.init}). Also see the \vn{show beam -comb} (\sref{s:show.beam} and \vn{pipe bunch_comb} (\sref{p:bunch.comb}) commands. Syntax: \begin{example} @@ -3993,7 +3991,7 @@ \subsection{write bunch_comb} \end{example} There are three file types described below. For all types the file will contain a table. The rows of -the table correspond to different comb points. The columns of the table correspond to varias bunch +the table correspond to different comb points. The columns of the table correspond to various bunch parameters calculated at the comb points. \begin{description} \item[-centroid] \Newline @@ -4118,7 +4116,7 @@ \subsection{write field} write field -ele Q1 -dr 0.01 0.02 0.05 -rmax 0.3 0.4 10.0 ! Same as above \end{example} The above examples both specify the same grid which will have an index range in $x$ of $[-30, 30]$, -ana range in $y$ of $[-20, 20]$, +and range in $y$ of $[-20, 20]$, %% write gif -------------------------------------------------------------- diff --git a/tao/doc/cover-page.tex b/tao/doc/cover-page.tex index 47f80030b0..58232263bb 100644 --- a/tao/doc/cover-page.tex +++ b/tao/doc/cover-page.tex @@ -2,7 +2,7 @@ \begin{flushright} \large -Revision: January 14, 2025 \\ +Revision: February 7, 2025 \\ \end{flushright} \vfill diff --git a/tao/doc/initialization.tex b/tao/doc/initialization.tex index 5d490f0f60..f143ec6f6d 100644 --- a/tao/doc/initialization.tex +++ b/tao/doc/initialization.tex @@ -147,6 +147,9 @@ \section{Tao Initialization Command Line Arguments} \item[-prompt_color] \Newline Sets the prompt string color to Blue. For different colors, use the \vn{set global prompt_color} command (\sref{s:set}). +% +\item[-quiet ] + % \item[-reverse] Reverses the order of the lattice elements. Equivalent to setting @@ -772,14 +775,12 @@ \subsection{Tao\_global\_struct Structure} For use with command files. May be set to one of: \begin{example} off ! Normal verbose output - all ! Suppress command echo and other output. - ALL ! Suppress command echo and other output. - warnings ! Suppress warnings. -\end{example} -If set to \vn{all}, output to the terminal during command file running will be suppressed (except -for warning and error messages) until the command file (or files) returns to the command line level -at which point \vn{global%quiet} is automatically reset to \vn{off}. That is, \vn{global%quiet} -must be set each time it is desired to run a command file(s) silently. + all ! Suppress output except errors. + warnings ! Suppress warnings only. +\end{example} +If set to \vn{all}, output to the terminal will be suppressed except +for error messages. If set in a command file, the setting will revert to what it was +at the end of the command file. % \item{\vn{global%random_engine}} \Newline \vn{global%random_engine} selects the algorithm used for generating the random diff --git a/tao/doc/pipe-interface-commands.json b/tao/doc/pipe-interface-commands.json index 4117834c74..8b7926d29e 100644 --- a/tao/doc/pipe-interface-commands.json +++ b/tao/doc/pipe-interface-commands.json @@ -1 +1 @@ -{"beam": {"description": "\nOutput beam parameters that are not in the beam_init structure.\n\nNotes\n-----\nCommand syntax:\n pipe beam {ix_uni}@{ix_branch}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.\n\nNote: To set beam_init parameters use the \"set beam\" command.\n\nParameters\n----------\nix_uni : optional\nix_branch : \"\"\n\nReturns\n-------\nstring_list \n\nExamples\n-------- \nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/csr_beam_tracking/tao.init\n args:\n ix_uni: 1\n ix_branch: 0\n", "command_str": "pipe beam {ix_uni}@{ix_branch}", "parameters": ["ix_uni", "ix_branch"]}, "beam_init": {"description": "\nOutput beam_init parameters.\n\nNotes\n-----\nCommand syntax:\n pipe beam_init {ix_uni}@{ix_branch}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.\n\nNote: To set beam_init parameters use the \"set beam_init\" command\n\nParameters\n----------\nix_uni : optional\nix_branch : \"\"\n\nReturns\n-------\nstring_list \n\nExamples\n-------- \nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/csr_beam_tracking/tao.init\n args:\n ix_uni: 1\n ix_branch: 0\n", "command_str": "pipe beam_init {ix_uni}@{ix_branch}", "parameters": ["ix_uni", "ix_branch"]}, "bmad_com": {"description": "\nOutput bmad_com structure components.\n\nNotes\n-----\nCommand syntax:\n pipe bmad_com\n\nReturns\n-------\nstring_list \n\nExamples\n-------- \nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe bmad_com", "parameters": []}, "branch1": {"description": "\nOutput lattice branch information for a particular lattice branch.\n\nNotes\n-----\nCommand syntax:\n pipe branch1 {ix_uni}@{ix_branch}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.\n\nParameters\n----------\nix_uni : \"\"\nix_branch : \"\"\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1\n ix_branch: 0\n", "command_str": "pipe branch1 {ix_uni}@{ix_branch}", "parameters": ["ix_uni", "ix_branch"]}, "bunch_comb": {"description": "\nOutputs bunch parameters at a comb point. \nAlso see the \"write bunch_comb\" and \"show bunch -comb\" commands.\n\nNotes\n-----\nCommand syntax:\n pipe bunch_comb {flags} {who} {ix_uni}@{ix_branch} {ix_bunch}\n\nWhere:\n {flags} are optional switches:\n -array_out : If present, the output will be available in the tao_c_interface_com%c_real.\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a branch index. Defaults to s%global%default_branch.\n {ix_bunch} is the bunch index. Defaults to 1.\n {who} is one of:\n x, px, y, py, z, pz, t, s, spin.x, spin.y, spin.z, p0c, beta -- centroid \n x.Q, y.Q, z.Q, a.Q, b.Q, c.Q where Q is one of: beta, alpha, gamma, phi, eta, etap,\n sigma, sigma_p, emit, norm_emit\n sigma.IJ where I, J in range [1,6]\n rel_min.I, rel_max.I where I in range [1,6]\n charge_live, n_particle_live, n_particle_lost_in_ele, ix_ele\n\n Note: If ix_uni or ix_branch is present, \"@\" must be present.\n\nExample:\n pipe bunch_comb py 2@1 1\n\nParameters\n----------\nwho\nix_uni : optional\nix_branch : optional\nix_bunch : default=1\nflags : default=-array_out\n\nReturns\n-------\nstring_list\n if '-array_out' not in flags\nreal_array\n if '-array_out' in flags\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/csr_beam_tracking/tao.init\n args:\n who: x.beta\n", "command_str": "pipe bunch_comb {flags} {who} {ix_uni}@{ix_branch} {ix_bunch}", "parameters": ["flags", "who", "ix_uni", "ix_branch", "ix_bunch"]}, "bunch_params": {"description": "\nOutputs bunch parameters at the exit end of a given lattice element.\n\nNotes\n-----\nCommand syntax:\n pipe bunch_params {ele_id}|{which}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe bunch_params end|model ! parameters at model lattice element named \"end\".\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/csr_beam_tracking/tao.init\n args:\n ele_id: end\n which: model\n", "command_str": "pipe bunch_params {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "bunch1": {"description": "\nOutputs Bunch parameters at the exit end of a given lattice element.\n\nNotes\n-----\nCommand syntax:\n pipe bunch1 {ele_id}|{which} {ix_bunch} {coordinate}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {ix_bunch} is the bunch index.\n {coordinate} is one of: x, px, y, py, z, pz, \"s\", \"t\", \"charge\", \"p0c\", \"state\", \"ix_ele\"\n\nFor example, if {coordinate} = \"px\", the phase space px coordinate of each particle\nof the bunch is displayed. The \"state\" of a particle is an integer. A value of 1 means\nalive and any other value means the particle has been lost.\n\nParameters\n----------\nele_id\ncoordinate\nwhich : default=model\nix_bunch : default=1\n\nReturns\n-------\nreal_array\n if coordinate in ['x', 'px', 'y', 'py', 'z', 'pz', 's', 't', 'charge', 'p0c']\ninteger_array\n if coordinate in ['state', 'ix_ele']\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/csr_beam_tracking/tao.init\n args:\n ele_id: end\n coordinate: x\n which: model\n ix_bunch: 1\n", "command_str": "pipe bunch1 {ele_id}|{which} {ix_bunch} {coordinate}", "parameters": ["ele_id", "which", "ix_bunch", "coordinate"]}, "building_wall_list": {"description": "\nOutput List of building wall sections or section points\n\nNotes\n-----\nCommand syntax:\n pipe building_wall_list {ix_section}\n\nWhere:\n {ix_section} is a building wall section index.\n\nIf {ix_section} is not present, a list of building wall sections is given.\nIf {ix_section} is present, a list of section points is given.\n\nParameters\n----------\nix_section : optional\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall\n args:\n ix_section:\n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall\n args:\n ix_section: 1\n", "command_str": "pipe building_wall_list {ix_section}", "parameters": ["ix_section"]}, "building_wall_graph": {"description": "\nOutput (x, y) points for drawing the building wall for a particular graph.\n\nNotes\n-----\nCommand syntax:\n pipe building_wall_graph {graph}\n\nWhere:\n {graph} is a plot region graph name.\n\nNote: The graph defines the coordinate system for the (x, y) points.\n\nParameters\n----------\ngraph\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall\n args:\n graph: floor_plan.g\n", "command_str": "pipe building_wall_graph {graph}", "parameters": ["graph"]}, "building_wall_point": {"description": "\nadd or delete a building wall point\n\nNotes\n-----\nCommand syntax:\n pipe building_wall_point {ix_section}^^{ix_point}^^{z}^^{x}^^{radius}^^{z_center}^^{x_center}\n\nWhere:\n {ix_section} -- Section index.\n {ix_point} -- Point index. Points of higher indexes will be moved up \n if adding a point and down if deleting.\n {z}, etc... -- See tao_building_wall_point_struct components.\n -- If {z} is set to \"delete\" then delete the point.\n\nParameters\n----------\nix_section\nix_point\nz\nx\nradius\nz_center\nx_center\n\nReturns\n-------\nNone \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall\n args:\n ix_section: 1\n ix_point: 1\n z: 0\n x: 0\n radius: 0\n z_center: 0\n x_center: 0\n", "command_str": "pipe building_wall_point {ix_section}^^{ix_point}^^{z}^^{x}^^{radius}^^{z_center}^^{x_center}", "parameters": ["ix_section", "ix_point", "z", "x", "radius", "z_center", "x_center"]}, "building_wall_section": {"description": "\nAdd or delete a building wall section\n\nNotes\n-----\nCommand syntax:\n pipe building_wall_section {ix_section}^^{sec_name}^^{sec_constraint}\n\nWhere:\n {ix_section} -- Section index. Sections with higher indexes will be\n moved up if adding a section and down if deleting.\n {sec_name} -- Section name.\n {sec_constraint} -- A section constraint name or \"delete\". Must be one of:\n delete -- Delete section. Anything else will add the section.\n none\n left_side\n right_side\n\nParameters\n----------\nix_section\nsec_name\nsec_constraint\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_section: 1\n sec_name: test\n sec_constraint: none\n", "command_str": "pipe building_wall_section {ix_section}^^{sec_name}^^{sec_constraint}", "parameters": ["ix_section", "sec_name", "sec_constraint"]}, "constraints": {"description": "\nOutput optimization data and variable parameters that contribute to the merit function.\n\nNotes\n-----\nCommand syntax:\n pipe constraints {who}\n\nWhere:\n {who} is one of: \"data\" or \"var\"\n\nData constraints output is:\n data name\n constraint type\n evaluation element name\n start element name\n end/reference element name\n measured value\n ref value (only relavent if global%opt_with_ref = T)\n model value\n base value (only relavent if global%opt_with_base = T)\n weight\n merit value\n location where merit is evaluated (if there is a range)\nVar constraints output is:\n var name\n Associated varible attribute\n meas value\n ref value (only relavent if global%opt_with_ref = T)\n model value\n base value (only relavent if global%opt_with_base = T)\n weight\n merit value\n dmerit/dvar\n\nParameters\n----------\nwho\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n who: data\n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who:var\n", "command_str": "pipe constraints {who}", "parameters": ["who"]}, "da_aperture": {"description": "\nOutput dynamic aperture data\n\nNotes\n-----\nCommand syntax:\n pipe da_aperture {ix_uni}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n\nParameters\n----------\nix_uni : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\n", "command_str": "pipe da_aperture {ix_uni}", "parameters": ["ix_uni"]}, "da_params": {"description": "\nOutput dynamic aperture input parameters\n\nNotes\n-----\nCommand syntax:\n pipe da_params {ix_uni}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n\nParameters\n----------\nix_uni : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\n", "command_str": "pipe da_params {ix_uni}", "parameters": ["ix_uni"]}, "data": {"description": "\nOutput Individual datum parameters.\n\nNotes\n-----\nCommand syntax:\n pipe data {ix_uni}@{d2_name}.{d1_name}[{dat_index}]\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {d2_name} is the name of the d2_data structure the datum is in.\n {d1_datum} is the name of the d1_data structure the datum is in.\n {dat_index} is the index of the datum.\n\nUse the \"pipe data-d1\" command to get detailed info on a specific d1 array.\n\nExample:\n pipe data 1@orbit.x[10]\n\nParameters\n----------\nd2_name\nd1_name\nix_uni : optional\ndat_index : default=1\n\nReturns\n-------\nstring_list\n\nExamples\n--------\n\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni:\n d2_name: twiss\n d1_name: end \n dat_index: 1 \n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni: 1\n d2_name: twiss\n d1_name: end\n dat_index: 1\n", "command_str": "pipe data {ix_uni}@{d2_name}.{d1_name}[{dat_index}]", "parameters": ["ix_uni", "d2_name", "d1_name", "dat_index"]}, "data_d_array": {"description": "\nOutput list of datums for a given d1_data structure.\n\nNotes\n-----\nCommand syntax:\n pipe data_d_array {ix_uni}@{d2_name}.{d1_name}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {d2_name} is the name of the containing d2_data structure.\n {d1_name} is the name of the d1_data structure containing the array of datums.\n\nExample:\n pipe data_d_array 1@orbit.x\n\nParameters\n----------\nd2_name\nd1_name\nix_uni : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni: 1 \n d2_name: twiss\n d1_name: end\n", "command_str": "pipe data_d_array {ix_uni}@{d2_name}.{d1_name}", "parameters": ["ix_uni", "d2_name", "d1_name"]}, "data_d1_array": {"description": "\nOutput list of d1 arrays for a given data_d2.\n\nNotes\n-----\nCommand syntax:\n pipe data_d1_array {d2_datum}\n\n{d2_datum} should be of the form\n {ix_uni}@{d2_datum_name}\n\nParameters\n----------\nd2_datum\nix_uni : optional\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni: 1 \n d2_datum: twiss\n", "command_str": "pipe data_d1_array {d2_datum}", "parameters": ["d2_datum"]}, "data_d2": {"description": "\nOutput information on a d2_datum.\n\nNotes\n-----\nCommand syntax:\n pipe data_d2 {ix_uni}@{d2_name}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {d2_name} is the name of the d2_data structure.\n\nParameters\n----------\nd2_name\nix_uni : optional\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni: 1\n d2_name: twiss\n", "command_str": "pipe data_d2 {ix_uni}@{d2_name}", "parameters": ["ix_uni", "d2_name"]}, "data_d2_array": {"description": "\nOutput data d2 info for a given universe.\n\nNotes\n-----\nCommand syntax:\n pipe data_d2_array {ix_uni}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n\nExample:\n pipe data_d2_array 1\n\nParameters\n----------\nix_uni\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni : 1 \n", "command_str": "pipe data_d2_array {ix_uni}", "parameters": ["ix_uni"]}, "data_d2_create": {"description": "\nCreate a d2 data structure along with associated d1 and data arrays.\n\nNotes\n-----\nCommand syntax:\n pipe data_d2_create {ix_uni}@{d2_name}^^{n_d1_data}^^{d_data_arrays_name_min_max}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {d2_name} is the name of the d2_data structure to create.\n {n_d1_data} is the number of associated d1 data structures.\n {d_data_arrays_name_min_max} has the form\n {name1}^^{lower_bound1}^^{upper_bound1}^^....^^{nameN}^^{lower_boundN}^^{upper_boundN}\n where {name} is the data array name and {lower_bound} and {upper_bound} are the bounds of the array.\n\nExample:\n pipe data_d2_create 2@orbit^^2^^x^^0^^45^^y^^1^^47\nThis example creates a d2 data structure called \"orbit\" with \ntwo d1 structures called \"x\" and \"y\".\n\nThe \"x\" d1 structure has an associated data array with indexes in the range [0, 45].\nThe \"y\" d1 structure has an associated data arrray with indexes in the range [1, 47].\n\nUse the \"set data\" command to set created datum parameters.\n\nNote: When setting multiple data parameters, \n temporarily toggle s%global%lattice_calc_on to False\n (\"set global lattice_calc_on = F\") to prevent Tao trying to \n evaluate the partially created datum and generating unwanted error messages.\n\nParameters\n----------\nd2_name\nn_d1_data\nd_data_arrays_name_min_max\nix_uni : optional\n \nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni: 1\n d2_name: orbit\n n_d1_data: 2 \n d_data_arrays_name_min_max: x^^0^^45^^y^^1^^47\n", "command_str": "pipe data_d2_create {ix_uni}@{d2_name}^^{n_d1_data}^^{d_data_arrays_name_min_max}", "parameters": ["ix_uni", "d2_name", "n_d1_data", "d_data_arrays_name_min_max"]}, "data_d2_destroy": {"description": "\nDestroy a d2 data structure along with associated d1 and data arrays.\n\nNotes\n-----\nCommand syntax:\n pipe data_d2_destroy {ix_uni}@{d2_name}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {d2_name} is the name of the d2_data structure to destroy.\n\nExample:\n pipe data_d2_destroy 2@orbit\nThis destroys the orbit d2_data structure in universe 2.\n\nParameters\n----------\nd2_name\nix_uni : optional\n \nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n d2_name: orbit\n", "command_str": "pipe data_d2_destroy {ix_uni}@{d2_name}", "parameters": ["ix_uni", "d2_name"]}, "data_parameter": {"description": "\nOutput an array of values for a particular datum parameter for a given array of datums, \n\nNotes\n-----\nCommand syntax:\n pipe data_parameter {data_array} {parameter}\n\n{parameter} may be any tao_data_struct parameter.\nExample:\n pipe data_parameter orbit.x model_value\n\nParameters\n----------\ndata_array\nparameter\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n data_array: twiss.end \n parameter: model_value\n", "command_str": "pipe data_parameter {data_array} {parameter}", "parameters": ["data_array", "parameter"]}, "data_set_design_value": {"description": "\nSet the design (and base & model) values for all datums.\n\nNotes\n-----\nCommand syntax:\n pipe data_set_design_value\n\nExample:\n pipe data_set_design_value\n\nNote: Use the \"data_d2_create\" and \"datum_create\" first to create datums.\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n", "command_str": "pipe data_set_design_value", "parameters": []}, "datum_create": {"description": "\nCreate a datum.\n\nNotes\n-----\nCommand syntax:\n pipe datum_create {datum_name}^^{data_type}^^{ele_ref_name}^^{ele_start_name}^^\n {ele_name}^^{merit_type}^^{meas}^^{good_meas}^^{ref}^^\n {good_ref}^^{weight}^^{good_user}^^{data_source}^^\n {eval_point}^^{s_offset}^^{ix_bunch}^^{invalid_value}^^\n {spin_axis%n0(1)}^^{spin_axis%n0(2)}^^{spin_axis%n0(3)}^^\n {spin_axis%l(1)}^^{spin_axis%l(2)}^^{spin_axis%l(3)}\n\nNote: The 3 values for spin_axis%n0, as a group, are optional. \n Also the 3 values for spin_axis%l are, as a group, optional.\nNote: Use the \"data_d2_create\" first to create a d2 structure with associated d1 arrays.\nNote: After creating all your datums, use the \"data_set_design_value\" routine to \n set the design (and model) values.\n\nParameters\n----------\ndatum_name ! EG: orb.x[3]\ndata_type ! EG: orbit.x\nele_ref_name : optional\nele_start_name : optional\nele_name : optional\nmerit_type : optional\nmeas : default=0\ngood_meas : default=F\nref : default=0\ngood_ref : default=F\nweight : default=0\ngood_user : default=T\ndata_source : default=lat\neval_point : default=END\ns_offset : default=0\nix_bunch : default=0\ninvalid_value : default=0\nspin_axis%n0(1) : optional\nspin_axis%n0(2) : optional\nspin_axis%n0(3) : optional\nspin_axis%l(1) : optional\nspin_axis%l(2) : optional\nspin_axis%l(3) : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n datum_name: twiss.end[6]\n data_type: beta.y\n ele_ref_name:\n ele_start_name:\n ele_name: P1\n merit_type: target\n meas: 0\n good_meas: T\n ref: 0\n good_ref: T\n weight: 0.3\n good_user: T\n data_source: lat\n eval_point: END\n s_offset: 0\n ix_bunch: 1\n invalid_value: 0\n", "command_str": "pipe 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)}", "parameters": ["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)"]}, "datum_has_ele": {"description": "\nOutput whether a datum type has an associated lattice element\n\nNotes\n-----\nCommand syntax:\n pipe datum_has_ele {datum_type}\n\nParameters\n----------\ndatum_type\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n datum_type: twiss.end \n", "command_str": "pipe datum_has_ele {datum_type}", "parameters": ["datum_type"]}, "derivative": {"description": "\nOutput optimization derivatives\n\nNotes\n-----\nCommand syntax:\n pipe derivative\n\nNote: To save time, this command will not recalculate derivatives. \nUse the \"derivative\" command beforehand to recalcuate if needed.\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n", "command_str": "pipe derivative", "parameters": []}, "ele:ac_kicker": {"description": "\nOutput element ac_kicker parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:ac_kicker {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:ac_kicker 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:ac_kicker {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:cartesian_map": {"description": "\nOutput element cartesian_map parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:cartesian_map {ele_id}|{which} {index} {who}\n\nWhere:\n {ele_id} is an element name or index\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is the index number in the ele%cartesian_map(:) array\n {who} is one of: \"base\", or \"terms\"\n\nExample:\n pipe ele:cartesian_map 3@1>>7|model 2 base\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nindex \nwho\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_em_field\n args:\n ele_id: 1@0>>1\n which: model\n index: 1\n who: base\n", "command_str": "pipe ele:cartesian_map {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "ele:chamber_wall": {"description": "\nOutput element beam chamber wall parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:chamber_wall {ele_id}|{which} {index} {who}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is index of the wall.\n {who} is one of:\n \"x\" ! Return min/max in horizontal plane\n \"y\" ! Return min/max in vertical plane\n\nParameters\n----------\nele_id\nindex\nwho\nwhich : default=model\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall3d\n args:\n ele_id: 1@0>>1\n which: model\n index: 1\n who: x\n", "command_str": "pipe ele:chamber_wall {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "ele:control_var": {"description": "\nOutput list of element control variables.\nUsed for group, overlay and ramper type elements.\n\nNotes\n-----\nCommand syntax:\n pipe ele:control_var {ele_id}|{which}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:control_var 3@1>>7|model\nThis gives control info on element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>873\n which: model\n", "command_str": "pipe ele:control_var {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:cylindrical_map": {"description": "\nOutput element cylindrical_map\n\nNotes\n-----\nCommand syntax:\n pipe ele:cylindrical_map {ele_id}|{which} {index} {who}\n\nWhere \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is the index number in the ele%cylindrical_map(:) array\n {who} is one of: \"base\", or \"terms\"\n\nExample:\n pipe ele:cylindrical_map 3@1>>7|model 2 base\nThis gives map #2 of element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nindex\nwho\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_em_field\n args:\n ele_id: 1@0>>5\n which: model\n index: 1\n who: base\n", "command_str": "pipe ele:cylindrical_map {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "ele:elec_multipoles": {"description": "\nOutput element electric multipoles\n\nNotes\n-----\nCommand syntax:\n pipe ele:elec_multipoles {ele_id}|{which}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:elec_multipoles 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:elec_multipoles {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:floor": {"description": "\nOutput element floor coordinates. The output gives four lines. \"Reference\" is\nwithout element misalignments and \"Actual\" is with misalignments. The lines with \"-W\"\ngive the W matrix. The exception is that if ele is a multipass_lord, there will be 4*N\nlines where N is the number of slaves.\n\nNotes\n-----\nCommand syntax:\n pipe ele:floor {ele_id}|{which} {where}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {where} is an optional argument which, if present, is one of\n beginning ! Upstream end\n center ! Middle of element. Surface of element for photonic reflecting elements (crystal, mirror).\n end ! Downstream end (default)\n\nExample:\n pipe ele:floor 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\nwhere : default=end\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n where: \n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n where: center\n", "command_str": "pipe ele:floor {ele_id}|{which} {where}", "parameters": ["ele_id", "which", "where"]}, "ele:gen_attribs": {"description": "\nOutput element general attributes\n\nNotes\n-----\nCommand syntax:\n pipe ele:gen_attribs {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:gen_attribs 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:gen_attribs {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:gen_grad_map": {"description": "\nOutput element gen_grad_map \n\nNotes\n-----\nCommand syntax:\n pipe ele:gen_grad_map {ele_id}|{which} {index} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is the index number in the ele%gen_grad_map(:) array\n {who} is one of: \"base\", or \"derivs\".\n\nExample:\n pipe ele:gen_grad_map 3@1>>7|model 2 base\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nindex\nwho\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_em_field\n args:\n ele_id: 1@0>>9\n which: model\n index: 1\n who: derivs\n", "command_str": "pipe ele:gen_grad_map {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "ele:grid_field": {"description": "\nOutput element grid_field\n\nNotes\n-----\nCommand syntax:\n pipe ele:grid_field {ele_id}|{which} {index} {who}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is the index number in the ele%grid_field(:) array.\n {who} is one of: \"base\", or \"points\"\n\nExample:\n pipe ele:grid_field 3@1>>7|model 2 base\nThis gives grid #2 of element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nindex \nwho \nwhich : default=model\n \nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_grid\n args:\n ele_id: 1@0>>1\n which: model\n index: 1\n who: base \n", "command_str": "pipe ele:grid_field {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "ele:head": {"description": "\nOutput \"head\" Element attributes\n\nNotes\n-----\nCommand syntax:\n pipe ele:head {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:head 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id \nwhich : default=model\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:head {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:lord_slave": {"description": "\nOutput the lord/slave tree of an element.\n\nNotes\n-----\nCommand syntax:\n pipe ele:lord_slave {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:lord_slave 3@1>>7|model\nThis gives lord and slave info on element number 7 in branch 1 of universe 3.\nNote: The lord/slave info is independent of the setting of {which}.\n\nThe output is a number of lines, each line giving information on an element (element index, etc.).\nSome lines begin with the word \"Element\". \nAfter each \"Element\" line, there are a number of lines (possibly zero) that begin with the word \"Slave or \"Lord\".\nThese \"Slave\" and \"Lord\" lines are the slaves and lords of the \"Element\" element.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:lord_slave {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:mat6": {"description": "\nOutput element mat6\n\nNotes\n-----\nCommand syntax:\n pipe ele:mat6 {ele_id}|{which} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {who} is one of: \"mat6\", \"vec0\", or \"err\"\n\nExample:\n pipe ele:mat6 3@1>>7|model mat6\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\nwho : default=mat6\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n who: mat6\n", "command_str": "pipe ele:mat6 {ele_id}|{which} {who}", "parameters": ["ele_id", "which", "who"]}, "ele:methods": {"description": "\nOutput element methods\n\nNotes\n-----\nCommand syntax:\n pipe ele:methods {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:methods 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:methods {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:multipoles": {"description": "\nOutput element multipoles\n\nNotes\n-----\nCommand syntax:\n pipe ele:multipoles {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:multipoles 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:multipoles {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:orbit": {"description": "\nOutput element orbit\n\nNotes\n-----\nCommand syntax:\n pipe ele:orbit {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:orbit 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:orbit {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:param": {"description": "\nOutput lattice element parameter\n\nNotes\n-----\nCommand syntax:\n pipe ele:param {ele_id}|{which} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {who} values are the same as {who} values for \"pipe lat_list\".\n Note: Here {who} must be a single parameter and not a list.\n\nExample:\n pipe ele:param 3@1>>7|model e_tot\nThis gives E_tot of element number 7 in branch 1 of universe 3.\n\nNote: On output the {variable} component will always be \"F\" (since this \ncommand cannot tell if a parameter is allowed to vary).\n\nAlso see: \"pipe lat_list\".\n\nParameters\n----------\nele_id\nwho \nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_photon\n args:\n ele_id: 1@0>>1\n which: model\n who: orbit.vec.1\n", "command_str": "pipe ele:param {ele_id}|{which} {who}", "parameters": ["ele_id", "which", "who"]}, "ele:photon": {"description": "\nOutput element photon parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:photon {ele_id}|{which} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {who} is one of: \"base\", \"material\", or \"curvature\"\n\nExample:\n pipe ele:photon 3@1>>7|model base\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwho \nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_photon\n args:\n ele_id: 1@0>>1\n which: model\n who: base\n", "command_str": "pipe ele:photon {ele_id}|{which} {who}", "parameters": ["ele_id", "which", "who"]}, "ele:spin_taylor": {"description": "\nOutput element spin_taylor parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:spin_taylor {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:spin_taylor 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_spin\n args:\n ele_id: 1@0>>2\n which: model\n", "command_str": "pipe ele:spin_taylor {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:taylor": {"description": "\nOutput element taylor map \n\nNotes\n-----\nCommand syntax:\n pipe ele:taylor {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:taylor 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_taylor\n args:\n ele_id: 1@0>>34\n which: model\n", "command_str": "pipe ele:taylor {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:twiss": {"description": "\nOutput element Twiss parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:twiss {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:twiss 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:twiss {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:wake": {"description": "\nOutput element wake.\n\nNotes\n-----\nCommand syntax:\n pipe ele:wake {ele_id}|{which} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {Who} is one of:\n \"sr_long\" \"sr_long_table\"\n \"sr_trans\" \"sr_trans_table\"\n \"lr_mode_table\" \"base\"\n\nExample:\n pipe ele:wake 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwho\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wake\n args:\n ele_id: 1@0>>1\n which: model\n who: sr_long\n", "command_str": "pipe ele:wake {ele_id}|{which} {who}", "parameters": ["ele_id", "which", "who"]}, "ele:wall3d": {"description": "\nOutput element wall3d parameters.\n\nNotes\n-----\nCommand syntax:\n pipe ele:wall3d {ele_id}|{which} {index} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is the index number in the ele%wall3d(:) array (size obtained from \"ele:head\").\n {who} is one of: \"base\", or \"table\".\nExample:\n pipe ele:wall3d 3@1>>7|model 2 base\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nindex \nwho \nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall3d\n args:\n ele_id: 1@0>>1\n which: model\n index: 1\n who: table\n", "command_str": "pipe ele:wall3d {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "evaluate": {"description": "\nOutput the value of an expression. The result may be a vector.\n\nNotes\n-----\nCommand syntax:\n pipe evaluate {flags} {expression}\n\nWhere:\n Optional {flags} are:\n -array_out : If present, the output will be available in the tao_c_interface_com%c_real.\n {expression} is expression to be evaluated.\n\nExample:\n pipe evaluate 3+data::cbar.11[1:10]|model\n\nParameters\n----------\nexpression :\nflags : default=-array_out\n If -array_out, the output will be available in the tao_c_interface_com%c_real.\n\nReturns\n-------\nstring_list\n if '-array_out' not in flags\nreal_array\n if '-array_out' in flags\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n expression: data::cbar.11[1:10]|model\n", "command_str": "pipe evaluate {flags} {expression}", "parameters": ["flags", "expression"]}, "em_field": {"description": "\nOutput EM field at a given point generated by a given element.\n\nNotes\n-----\nCommand syntax:\n pipe em_field {ele_id}|{which} {x} {y} {z} {t_or_z}\n\nWhere:\n {which} is one of: \"model\", \"base\" or \"design\"\n {x}, {y} -- Transverse coords.\n {z} -- Longitudinal coord with respect to entrance end of element.\n {t_or_z} -- time or phase space z depending if lattice is setup for absolute time tracking.\n\nParameters\n----------\nele_id\nx\ny\nz\nt_or_z\nwhich : default=model\n \nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>22\n which: model\n x: 0\n y: 0\n z: 0\n t_or_z: 0\n", "command_str": "pipe em_field {ele_id}|{which} {x} {y} {z} {t_or_z}", "parameters": ["ele_id", "which", "x", "y", "z", "t_or_z"]}, "enum": {"description": "\nOutput list of possible values for enumerated numbers.\n\nNotes\n-----\nCommand syntax:\n pipe enum {enum_name}\n\nExample:\n pipe enum tracking_method\n\nParameters\n----------\nenum_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n enum_name: tracking_method\n", "command_str": "pipe enum {enum_name}", "parameters": ["enum_name"]}, "floor_plan": {"description": "\nOutput (x,y) points and other information that can be used for drawing a floor_plan.\n\nNotes\n-----\nCommand syntax:\n pipe floor_plan {graph}\n\nParameters\n----------\ngraph\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n graph: r13.g\n", "command_str": "pipe floor_plan {graph}", "parameters": ["graph"]}, "floor_orbit": {"description": "\nOutput (x, y) coordinates for drawing the particle orbit on a floor plan.\n\nNotes\n-----\nCommand syntax:\n pipe floor_orbit {graph}\n\nParameters\n----------\ngraph\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_floor_orbit\n args:\n graph: r33.g \n", "command_str": "pipe floor_orbit {graph}", "parameters": ["graph"]}, "global": {"description": "\nOutput global parameters.\n\nNotes\n-----\nCommand syntax:\n pipe global\n\nOutput syntax is parameter list form. See documentation at the beginning of this file.\n\nNote: The follow is intentionally left out:\n optimizer_allow_user_abort\n quiet\n single_step\n prompt_color\n prompt_string\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe global", "parameters": []}, "global:optimization": {"description": "\nOutput optimization parameters.\nAlso see global:opti_de.\n\nNotes\n-----\nCommand syntax:\n pipe global:optimization\n\nOutput syntax is parameter list form. See documentation at the beginning of this file.\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe global:optimization", "parameters": []}, "global:opti_de": {"description": "\nOutput DE optimization parameters.\n\nNotes\n-----\nCommand syntax:\n pipe global:opti_de\n\nOutput syntax is parameter list form. See documentation at the beginning of this file.\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe global:opti_de", "parameters": []}, "help": {"description": "\nOutput list of \"help xxx\" topics\n\nNotes\n-----\nCommand syntax:\n pipe help\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe help", "parameters": []}, "inum": {"description": "\nOutput list of possible values for an INUM parameter.\nFor example, possible index numbers for the branches of a lattice.\n\nNotes\n-----\nCommand syntax:\n pipe inum {who}\n\nParameters\n----------\nwho\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who: ix_universe\n", "command_str": "pipe inum {who}", "parameters": ["who"]}, "lat_calc_done": {"description": "\nOutput if a lattice recalculation has been proformed since the last \n time \"pipe lat_calc_done\" was called.\n\nNotes\n-----\nCommand syntax:\n pipe lat_calc_done\n\nParameters\n----------\nbranch_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n branch_name: 1@0\n", "command_str": "pipe lat_calc_done", "parameters": []}, "lat_ele_list": {"description": "\nOutput lattice element list.\n\nNotes\n-----\nCommand syntax:\n pipe lat_ele_list {branch_name}\n\n{branch_name} should have the form:\n {ix_uni}@{ix_branch}\n\nParameters\n----------\nbranch_name : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n branch_name: 1@0\n", "command_str": "pipe lat_ele_list {branch_name}", "parameters": ["branch_name"]}, "lat_branch_list": {"description": "\nOutput lattice branch list\n\nNotes\n-----\nCommand syntax:\n pipe lat_branch_list {ix_uni}\n\nOutput syntax:\n branch_index;branch_name;n_ele_track;n_ele_max\n\nParameters\n----------\nix_uni : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1\n", "command_str": "pipe lat_branch_list {ix_uni}", "parameters": ["ix_uni"]}, "lat_list": {"description": "\nOutput list of parameters at ends of lattice elements\n\nNotes\n-----\nCommand syntax:\n pipe lat_list {flags} {ix_uni}@{ix_branch}>>{elements}|{which} {who}\n\nWhere:\n Optional {flags} are:\n -no_slaves : If present, multipass_slave and super_slave elements will not be matched to.\n -track_only : If present, lord elements will not be matched to.\n -index_order : If present, order elements by element index instead of the standard s-position.\n -array_out : If present, the output will be available in the tao_c_interface_com%c_real or\n tao_c_interface_com%c_integer arrays. See the code below for when %c_real vs %c_integer is used.\n Note: Only a single {who} item permitted when -array_out is present.\n\n {which} is one of: \"model\", \"base\" or \"design\"\n\n {who} is a comma deliminated list of:\n orbit.floor.x, orbit.floor.y, orbit.floor.z ! Floor coords at particle orbit.\n orbit.spin.1, orbit.spin.2, orbit.spin.3,\n orbit.vec.1, orbit.vec.2, orbit.vec.3, orbit.vec.4, orbit.vec.5, orbit.vec.6,\n orbit.t, orbit.beta,\n orbit.state, ! Note: state is an integer. alive$ = 1, anything else is lost.\n orbit.energy, orbit.pc,\n ele.name, ele.key, ele.ix_ele, ele.ix_branch\n ele.a.beta, ele.a.alpha, ele.a.eta, ele.a.etap, ele.a.gamma, ele.a.phi,\n ele.b.beta, ele.b.alpha, ele.b.eta, ele.b.etap, ele.b.gamma, ele.b.phi,\n ele.x.eta, ele.x.etap,\n ele.y.eta, ele.y.etap,\n ele.ref_time, ele.ref_time_start\n ele.s, ele.l\n ele.e_tot, ele.p0c\n ele.mat6 ! Output: mat6(1,:), mat6(2,:), ... mat6(6,:)\n ele.vec0 ! Output: vec0(1), ... vec0(6)\n ele.{attribute} Where {attribute} is a Bmad syntax element attribute. (EG: ele.beta_a, ele.k1, etc.)\n ele.c_mat ! Output: c_mat11, c_mat12, c_mat21, c_mat22.\n ele.gamma_c ! Parameter associated with coupling c-matrix.\n\n {elements} is a string to match element names to.\n Use \"*\" to match to all elements.\n\nExamples:\n pipe lat_list -track 3@0>>Q*|base ele.s,orbit.vec.2\n pipe lat_list 3@0>>Q*|base real:ele.s \n\nAlso see: \"pipe ele:param\"\n\nParameters\n----------\nelements \nwho \nix_uni : optional\nix_branch : optional\nwhich : default=model\nflags : optional, default=-array_out -track_only\n\nReturns\n-------\nstring_list\n if ('-array_out' not in flags) or (who in ['ele.name', 'ele.key'])\ninteger_array\n if '-array_out' in flags and who in ['orbit.state', 'ele.ix_ele']\nreal_array\n if ('-array_out' in flags) or ('real:' in who) \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1 \n ix_branch: 0 \n elements: Q* \n which: model\n who: orbit.floor.x\n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1 \n ix_branch: 0 \n elements: Q* \n which: design\n who: ele.ix_ele\n\n\n", "command_str": "pipe lat_list {flags} {ix_uni}@{ix_branch}>>{elements}|{which} {who}", "parameters": ["flags", "ix_uni", "ix_branch", "elements", "which", "who"]}, "lat_param_units": {"description": "\nOutput units of a parameter associated with a lattice or lattice element.\n\nNotes\n-----\nCommand syntax:\n pipe lat_param_units {param_name}\n\nParameters\n----------\nparam_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n param_name: L \n", "command_str": "pipe lat_param_units {param_name}", "parameters": ["param_name"]}, "matrix": {"description": "\nOutput matrix value from the exit end of one element to the exit end of the other.\n\nNotes\n-----\nCommand syntax:\n pipe matrix {ele1_id} {ele2_id}\n\nWhere:\n {ele1_id} is the start element.\n {ele2_id} is the end element.\nIf {ele2_id} = {ele1_id}, the 1-turn transfer map is computed.\nNote: {ele2_id} should just be an element name or index without universe, branch, or model/base/design specification.\n\nExample:\n pipe matrix 2@1>>q01w|design q02w\n\nParameters\n----------\nele1_id\nele2_id\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele1_id: 1@0>>q01w|design\n ele2_id: q02w\n", "command_str": "pipe matrix {ele1_id} {ele2_id}", "parameters": ["ele1_id", "ele2_id"]}, "merit": {"description": "\nOutput merit value.\n\nNotes\n-----\nCommand syntax:\n pipe merit\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe merit", "parameters": []}, "orbit_at_s": {"description": "\nOutput twiss at given s position.\n\nNotes\n-----\nCommand syntax:\n pipe orbit_at_s {ix_uni}@{ele}->{s_offset}|{which}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ele} is an element name or index. Default at the Beginning element at start of branch 0.\n {s_offset} is the offset of the evaluation point from the downstream end of ele. Default is 0.\n If {s_offset} is present, the preceeding \"->\" sign must be present. EG: Something like \"23|model\" will\n {which} is one of: \"model\", \"base\" or \"design\".\n\nExample:\n pipe orbit_at_s Q10->0.4|model ! Orbit at 0.4 meters from Q10 element exit end in model lattice.\n\nParameters\n----------\nix_uni : optional\nele : optional\ns_offset : optional\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1\n ele: 10\n s_offset: 0.7\n which: model\n", "command_str": "pipe orbit_at_s {ix_uni}@{ele}->{s_offset}|{which}", "parameters": ["ix_uni", "ele", "s_offset", "which"]}, "place_buffer": {"description": "\nOutput the place command buffer and reset the buffer.\nThe contents of the buffer are the place commands that the user has issued.\nSee the Tao manual for more details.\n\nNotes\n-----\nCommand syntax:\n pipe place_buffer\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe place_buffer", "parameters": []}, "plot_curve": {"description": "\nOutput curve information for a plot.\n\nNotes\n-----\nCommand syntax:\n pipe plot_curve {curve_name}\n\nParameters\n----------\ncurve_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n curve_name: r13.g.a\n", "command_str": "pipe plot_curve {curve_name}", "parameters": ["curve_name"]}, "plot_graph": {"description": "\nOutput graph info.\n\nNotes\n-----\nCommand syntax:\n pipe plot_graph {graph_name}\n\n{graph_name} is in the form:\n {p_name}.{g_name}\nwhere\n {p_name} is the plot region name if from a region or the plot name if a template plot.\n This name is obtained from the pipe plot_list command.\n {g_name} is the graph name obtained from the pipe plot1 command.\n\nParameters\n----------\ngraph_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n graph_name: beta.g\n", "command_str": "pipe plot_graph {graph_name}", "parameters": ["graph_name"]}, "plot_histogram": {"description": "\nOutput plot histogram info.\n\nNotes\n-----\nCommand syntax:\n pipe plot_histogram {curve_name}\n\nParameters\n----------\ncurve_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n curve_name: r33.g.x\n", "command_str": "pipe plot_histogram {curve_name}", "parameters": ["curve_name"]}, "plot_lat_layout": {"description": "\nOutput plot Lat_layout info\n\nNotes\n-----\nCommand syntax:\n pipe plot_lat_layout {ix_uni}@{ix_branch}\n\nNote: The returned list of element positions is not ordered in increasing\n longitudinal position.\n\nParameters\n----------\nix_uni: 1\nix_branch: 0\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1\n ix_branch: 0 \n", "command_str": "pipe plot_lat_layout {ix_uni}@{ix_branch}", "parameters": ["ix_uni", "ix_branch"]}, "plot_list": {"description": "\nOutput list of plot templates or plot regions.\n\nNotes\n-----\nCommand syntax:\n pipe plot_list {r_or_g}\n\nwhere \"{r/g}\" is:\n \"r\" ! list regions of the form ix;region_name;plot_name;visible;x1;x2;y1;y2\n \"t\" ! list template plots of the form ix;name\n\nParameters\n----------\nr_or_g\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n r_or_g: r\n", "command_str": "pipe plot_list {r_or_g}", "parameters": ["r_or_g"]}, "plot_template_manage": {"description": "\nTemplate plot creation or destruction.\n\nNotes\n-----\nCommand syntax:\n pipe plot_template_manage {template_location}^^{template_name}^^\n {n_graph}^^{graph_names}\n\nWhere:\n {template_location} is the location to place or delete a template plot. Use \"@Tnnn\" syntax for the location.\n {template_name} is the name of the template plot. If deleting a plot this name is immaterial.\n {n_graph} is the number of associated graphs. If set to -1 then any existing template plot is deleted.\n {graph_names} are the names of the graphs. graph_names should be in the form:\n graph1_name^^graph2_name^^...^^graphN_name\n for N=n_graph names\n\nParameters\n----------\ntemplate_location\ntemplate_name\nn_graph : default=-1\ngraph_names : default=\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n template_location: @T1\n template_name: beta\n n_graph: 2\n graph_names: g1^^g2\n", "command_str": "pipe plot_template_manage {template_location}^^{template_name}^^{n_graph}^^{graph_names}", "parameters": ["template_location", "template_name", "n_graph", "graph_names"]}, "plot_curve_manage": {"description": "\nTemplate plot curve creation/destruction\n\nNotes\n-----\nCommand syntax:\n pipe plot_curve_manage {graph_name}^^{curve_index}^^{curve_name}\n\nIf {curve_index} corresponds to an existing curve then this curve is deleted.\nIn this case the {curve_name} is ignored and does not have to be present.\nIf {curve_index} does not not correspond to an existing curve, {curve_index}\nmust be one greater than the number of curves.\n\nParameters\n----------\ngraph_name\ncurve_index\ncurve_name\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n graph_name: beta.g\n curve_index: 1\n curve_name: r13.g.a\n", "command_str": "pipe plot_curve_manage {graph_name}^^{curve_index}^^{curve_name}", "parameters": ["graph_name", "curve_index", "curve_name"]}, "plot_graph_manage": {"description": "\nTemplate plot graph creation/destruction\n\nNotes\n-----\nCommand syntax:\n pipe plot_graph_manage {plot_name}^^{graph_index}^^{graph_name}\n\nIf {graph_index} corresponds to an existing graph then this graph is deleted.\nIn this case the {graph_name} is ignored and does not have to be present.\nIf {graph_index} does not not correspond to an existing graph, {graph_index}\nmust be one greater than the number of graphs.\n\nParameters\n----------\nplot_name\ngraph_index\ngraph_name\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n plot_name: beta\n graph_index: 1\n graph_name: beta.g\n", "command_str": "pipe plot_graph_manage {plot_name}^^{graph_index}^^{graph_name}", "parameters": ["plot_name", "graph_index", "graph_name"]}, "plot_line": {"description": "\nOutput points used to construct the \"line\" associated with a plot curve.\n\nNotes\n-----\nCommand syntax:\n pipe plot_line {region_name}.{graph_name}.{curve_name} {x_or_y}\n\nOptional {x-or-y} may be set to \"x\" or \"y\" to get the smooth line points x or y \ncomponent put into the real array buffer.\nNote: The plot must come from a region, and not a template, since no template plots \n have associated line data.\nExamples:\n pipe plot_line r13.g.a ! String array output.\n pipe plot_line r13.g.a x ! x-component of line points loaded into the real array buffer.\n pipe plot_line r13.g.a y ! y-component of line points loaded into the real array buffer.\n\nParameters\n----------\nregion_name\ngraph_name\ncurve_name\nx_or_y : optional\n\nReturns\n-------\nstring_list\n if x_or_y == ''\nreal_array\n if x_or_y != ''\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_plot_line -external_plotting\n args:\n region_name: beta\n graph_name: g\n curve_name: a\n x_or_y:\n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_plot_line -external_plotting\n args:\n region_name: beta\n graph_name: g\n curve_name: a\n x_or_y: y\n", "command_str": "pipe plot_line {region_name}.{graph_name}.{curve_name} {x_or_y}", "parameters": ["region_name", "graph_name", "curve_name", "x_or_y"]}, "plot_symbol": {"description": "\nOutput locations to draw symbols for a plot curve.\n\nNotes\n-----\nCommand syntax:\n pipe plot_symbol {region_name}.{graph_name}.{curve_name} {x_or_y}\n\nOptional {x_or_y} may be set to \"x\" or \"y\" to get the symbol x or y \npositions put into the real array buffer.\nNote: The plot must come from a region, and not a template, \n since no template plots have associated symbol data.\nExamples:\n pipe plot_symbol r13.g.a ! String array output.\n pipe plot_symbol r13.g.a x ! x-component of the symbol positions \n loaded into the real array buffer.\n pipe plot_symbol r13.g.a y ! y-component of the symbol positions \n loaded into the real array buffer.\n\nParameters\n----------\nregion_name\ngraph_name\ncurve_name\nx_or_y\n\nReturns\n-------\nstring_list\n if x_or_y == ''\nreal_array\n if x_or_y != ''\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_plot_line -external_plotting\n args:\n region_name: r13\n graph_name: g\n curve_name: a\n x_or_y: \n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_plot_line -external_plotting\n args:\n region_name: r13\n graph_name: g\n curve_name: a\n x_or_y: y\n", "command_str": "pipe plot_symbol {region_name}.{graph_name}.{curve_name} {x_or_y}", "parameters": ["region_name", "graph_name", "curve_name", "x_or_y"]}, "plot_transfer": {"description": "\nOutput transfer plot parameters from the \"from plot\" to the \"to plot\" (or plots).\n\nNotes\n-----\nCommand syntax:\n pipe plot_transfer {from_plot} {to_plot}\n\nTo avoid confusion, use \"@Tnnn\" and \"@Rnnn\" syntax for {from_plot}.\nIf {to_plot} is not present and {from_plot} is a template plot, the \"to plots\" \n are the equivalent region plots with the same name. And vice versa \n if {from_plot} is a region plot.\n\nParameters\n----------\nfrom_plot\nto_plot\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n from_plot: r13\n to_plot: r23 \n", "command_str": "pipe plot_transfer {from_plot} {to_plot}", "parameters": ["from_plot", "to_plot"]}, "plot1": {"description": "\nOutput info on a given plot.\n\nNotes\n-----\nCommand syntax:\n pipe plot1 {name}\n\n{name} should be the region name if the plot is associated with a region.\nOutput syntax is parameter list form. See documentation at the beginning of this file.\n\nParameters\n----------\nname\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n name: beta\n", "command_str": "pipe plot1 {name}", "parameters": ["name"]}, "ptc_com": {"description": "\nOutput Ptc_com structure components.\n\nNotes\n-----\nCommand syntax:\n pipe ptc_com\n\nReturns\n-------\nstring_list \n\nExamples\n-------- \nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init \n args:\n", "command_str": "pipe ptc_com", "parameters": []}, "ring_general": {"description": "\nOutput lattice branch with closed geometry info (emittances, etc.)\n\nNotes\n-----\nCommand syntax:\n pipe ring_general {ix_uni}@{ix_branch}|{which}\n\nwhere {which} is one of:\n model\n base\n design\nExample:\n pipe ring_general 1@0|model\n\nParameters\n----------\nix_uni : optional\nix_branch : optional\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1\n ix_branch: 0\n which: model\n\n", "command_str": "pipe ring_general {ix_uni}@{ix_branch}|{which}", "parameters": ["ix_uni", "ix_branch", "which"]}, "shape_list": {"description": "\nOutput lat_layout or floor_plan shapes list\n\nNotes\n-----\nCommand syntax:\n pipe shape_list {who}\n\n{who} is one of:\n lat_layout\n floor_plan\n\nParameters\n----------\nwho\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who: floor_plan \n", "command_str": "pipe shape_list {who}", "parameters": ["who"]}, "shape_manage": {"description": "\nElement shape creation or destruction\n\nNotes\n-----\nCommand syntax:\n pipe shape_manage {who} {index} {add_or_delete}\n\n{who} is one of:\n lat_layout\n floor_plan\n{add_or_delete} is one of:\n add -- Add a shape at {index}. \n Shapes with higher index get moved up one to make room.\n delete -- Delete shape at {index}. \n Shapes with higher index get moved down one to fill the gap.\n\nExample:\n pipe shape_manage floor_plan 2 add\nNote: After adding a shape use \"pipe shape_set\" to set shape parameters.\nThis is important since an added shape is in a ill-defined state.\n\nParameters\n----------\nwho\nindex\nadd_or_delete\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who: floor_plan\n index: 1\n add_or_delete: add\n", "command_str": "pipe shape_manage {who} {index} {add_or_delete}", "parameters": ["who", "index", "add_or_delete"]}, "shape_pattern_list": {"description": "\nOutput list of shape patterns or shape pattern points\n\nNotes\n-----\nCommand syntax:\n pipe shape_pattern_list {ix_pattern}\n\nIf optional {ix_pattern} index is omitted then list all the patterns.\nIf {ix_pattern} is present, list points of given pattern.\n\nParameters\n----------\nix_pattern : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_shape\n args:\n ix_pattern: \n", "command_str": "pipe shape_pattern_list {ix_pattern}", "parameters": ["ix_pattern"]}, "shape_pattern_manage": {"description": "\nAdd or remove shape pattern\n\nNotes\n-----\nCommand syntax:\n pipe shape_pattern_manage {ix_pattern}^^{pat_name}^^{pat_line_width}\n\nWhere:\n {ix_pattern} -- Pattern index. Patterns with higher indexes will be moved up \n if adding a pattern and down if deleting.\n {pat_name} -- Pattern name.\n {pat_line_width} -- Line width. Integer. If set to \"delete\" then section \n will be deleted.\n\nParameters\n----------\nix_pattern\npat_name\npat_line_width\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_shape\n args:\n ix_pattern : 1\n pat_name : new_pat\n pat_line_width : 1\n", "command_str": "pipe shape_pattern_manage {ix_pattern}^^{pat_name}^^{pat_line_width}", "parameters": ["ix_pattern", "pat_name", "pat_line_width"]}, "shape_pattern_point_manage": {"description": "\nAdd or remove shape pattern point\n\nNotes\n-----\nCommand syntax:\n pipe shape_pattern_point_manage {ix_pattern}^^{ix_point}^^{s}^^{x}\n\nWhere:\n {ix_pattern} -- Pattern index.\n {ix_point} -- Point index. Points of higher indexes will be moved up\n if adding a point and down if deleting.\n {s}, {x} -- Point location. If {s} is \"delete\" then delete the point.\n\nParameters\n----------\nix_pattern\nix_point\ns\nx\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_shape\n args:\n ix_pattern: 1\n ix_point: 1\n s: 0\n x: 0\n", "command_str": "pipe shape_pattern_point_manage {ix_pattern}^^{ix_point}^^{s}^^{x}", "parameters": ["ix_pattern", "ix_point", "s", "x"]}, "shape_set": {"description": "\nSet lat_layout or floor_plan shape parameters.\n\nNotes\n-----\nCommand syntax:\n pipe shape_set {who}^^{shape_index}^^{ele_name}^^{shape}^^{color}^^\n {shape_size}^^{type_label}^^{shape_draw}^^\n {multi_shape}^^{line_width}\n\n{who} is one of:\n lat_layout\n floor_plan\n\nParameters\n----------\nwho\nshape_index\nele_name\nshape\ncolor\nshape_size\ntype_label\nshape_draw\nmulti_shape\nline_width\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who: floor_plan\n shape_index: 1\n ele_name: Q1\n shape: circle\n color:\n shape_size:\n type_label:\n shape_draw:\n multi_shape:\n line_width:\n", "command_str": "pipe shape_set {who}^^{shape_index}^^{ele_name}^^{shape}^^{color}^^{shape_size}^^{type_label}^^{shape_draw}^^{multi_shape}^^{line_width}", "parameters": ["who", "shape_index", "ele_name", "shape", "color", "shape_size", "type_label", "shape_draw", "multi_shape", "line_width"]}, "show": {"description": "\nOutput the output from a show command.\n\nNotes\n-----\nCommand syntax:\n pipe show {line}\n\n{line} is the string to pass through to the show command.\nExample:\n pipe show lattice -pipe\n\nParameters\n----------\nline\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n line: -pipe\n", "command_str": "pipe show {line}", "parameters": ["line"]}, "space_charge_com": {"description": "\nOutput space_charge_com structure parameters.\n\nNotes\n-----\nCommand syntax:\n pipe space_charge_com\n\nOutput syntax is parameter list form. See documentation at the beginning of this file.\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe space_charge_com", "parameters": []}, "species_to_int": {"description": "\nConvert species name to corresponding integer\n\nNotes\n-----\nCommand syntax:\n pipe species_to_int {species_str}\n\nExample:\n pipe species_to_int CO2++\n\nParameters\n----------\nspecies_str\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n species_str: electron\n", "command_str": "pipe species_to_int {species_str}", "parameters": ["species_str"]}, "species_to_str": {"description": "\nConvert species integer id to corresponding\n\nNotes\n-----\nCommand syntax:\n pipe species_to_str {species_int}\n\nExample:\n pipe species_to_str -1 ! Returns 'Electron'\n\nParameters\n----------\nspecies_int\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n species_int: -1\n", "command_str": "pipe species_to_str {species_int}", "parameters": ["species_int"]}, "spin_invariant": {"description": "\nOutput closed orbit spin axes n0, l0, or m0 at the ends of all lattice elements in a branch.\nn0, l0, and m0 are solutions of the T-BMT equation.\nn0 is periodic while l0 and m0 are not. At the beginning of the branch, the orientation of the \nl0 or m0 axes in the plane perpendicular to the n0 axis is chosen a bit arbitrarily.\nSee the Bmad manual for more details.\n\nNotes\n-----\nCommand syntax:\n pipe spin_invariant {flags} {who} {ix_uni}@{ix_branch}|{which}\n\nWhere:\n {flags} are optional switches:\n -array_out : If present, the output will be available in the tao_c_interface_com%c_real.\n {who} is one of: l0, n0, or m0\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a branch index. Defaults to s%global%default_branch.\n {which} is one of:\n model\n base\n design\n\nExample:\n pipe spin_invariant 1@0|model\n\nNote: This command is under development. If you want to use please contact David Sagan.\n\nParameters\n----------\nwho\nix_uni : optional\nix_branch : optional\nwhich : default=model\nflags : default=-array_out\n\nReturns\n-------\nstring_list\n if '-array_out' not in flags\nreal_array\n if '-array_out' in flags\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n who: l0\n ix_uni: 1\n ix_branch: 0\n which: model\n", "command_str": "pipe spin_invariant {flags} {who} {ix_uni}@{ix_branch}|{which}", "parameters": ["flags", "who", "ix_uni", "ix_branch", "which"]}, "spin_polarization": {"description": "\nOutput spin polarization information\n\nNotes\n-----\nCommand syntax:\n pipe spin_polarization {ix_uni}@{ix_branch}|{which}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a branch index. Defaults to s%global%default_branch.\n {which} is one of:\n model\n base\n design\n\nExample:\n pipe spin_polarization 1@0|model\n\nNote: This command is under development. If you want to use please contact David Sagan.\n\nParameters\n----------\nix_uni : optional\nix_branch : optional\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n ix_uni: 1\n ix_branch: 0\n which: model\n", "command_str": "pipe spin_polarization {ix_uni}@{ix_branch}|{which}", "parameters": ["ix_uni", "ix_branch", "which"]}, "spin_resonance": {"description": "\nOutput spin resonance information\n\nNotes \n-----\nCommand syntax:\n pipe spin_resonance {ix_uni}@{ix_branch}|{which} {ref_ele}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.\n {which} is one of: \"model\", \"base\" or \"design\"\n {ref_ele} is an element name or index.\nThis will return a string_list with the following fields:\n spin_tune -- Spin tune\n 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.\n xi_res_X_sum, xi_res_X_diff -- The linear spin/orbit sum and difference resonance strengths for X = a, b, and c modes. \n\nParameters\n----------\nix_uni : optional\nix_branch : optional\nwhich : default=model\nref_ele : default=0\n Reference element to calculate at.\n\nReturns\n-------\nstring_list \n\nExamples\n--------\n\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n ix_uni: 1\n ix_branch: 0\n which: model\n", "command_str": "pipe spin_resonance {ix_uni}@{ix_branch}|{which} {ref_ele}", "parameters": ["ix_uni", "ix_branch", "which", "ref_ele"]}, "super_universe": {"description": "\nOutput super_Universe parameters.\n\nNotes\n-----\nCommand syntax:\n pipe super_universe\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n", "command_str": "pipe super_universe", "parameters": []}, "taylor_map": {"description": "\nOutput Taylor map between two points.\n\nNotes\n-----\nCommand syntax:\n pipe taylor_map {ele1_id} {ele2_id} {order}\n\nWhere:\n {ele1_id} is the start element.\n {ele2_id} is the end element.\n {order} is the map order. Default is order set in the lattice file. {order} cannot be larger than \n what is set by the lattice file. \nIf {ele2_id} = {ele1_id}, the 1-turn transfer map is computed.\nNote: {ele2_id} should just be an element name or index without universe, branch, or model/base/design specification.\nExample:\n pipe taylor_map 2@1>>q01w|design q02w 2\n\nParameters\n----------\nele1_id \nele2_id \norder : default=1\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele1_id: 1@0>>q01w|design\n ele2_id: q02w\n order: 1\n", "command_str": "pipe taylor_map {ele1_id} {ele2_id} {order}", "parameters": ["ele1_id", "ele2_id", "order"]}, "twiss_at_s": {"description": "\nOutput twiss parameters at given s position.\n\nNotes\n-----\nCommand syntax:\n pipe twiss_at_s {ix_uni}@{ele}->{s_offset}|{which}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ele} is an element name or index. Default at the Beginning element at start of branch 0.\n {s_offset} is the offset of the evaluation point from the downstream end of ele. Default is 0.\n If {s_offset} is present, the preceeding \"->\" sign must be present. EG: Something like \"23|model\" will\n {which} is one of: \"model\", \"base\" or \"design\".\n\nParameters\n----------\nix_uni : optional\nele : optional\ns_offset : optional\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n ix_uni: 1\n ele: 10\n s_offset: 0.7\n which: model \n", "command_str": "pipe twiss_at_s {ix_uni}@{ele}->{s_offset}|{which}", "parameters": ["ix_uni", "ele", "s_offset", "which"]}, "universe": {"description": "\nOutput universe info.\n\nNotes\n-----\nCommand syntax:\n pipe universe {ix_uni}\n\nUse \"pipe global\" to get the number of universes.\n\nParameters\n----------\nix_uni\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n ix_uni: 1\n", "command_str": "pipe universe {ix_uni}", "parameters": ["ix_uni"]}, "var": {"description": "\nOutput parameters of a given variable.\n\nNotes\n-----\nCommand syntax:\n pipe var {var} {slaves}\n\nNote: use \"pipe var_general\" to get a list of variables.\n\nParameters\n----------\nvar\nslaves : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args: \n var: quad[1]\n slaves:\n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args: \n var: quad[1]\n slaves: slaves\n", "command_str": "pipe var {var} {slaves}", "parameters": ["var", "slaves"]}, "var_create": {"description": "\nCreate a single variable\n\nNotes\n-----\nCommand syntax:\n pipe var_create {var_name}^^{ele_name}^^{attribute}^^{universes}^^\n {weight}^^{step}^^{low_lim}^^{high_lim}^^{merit_type}^^\n {good_user}^^{key_bound}^^{key_delta}\n\n{var_name} is something like \"kick[5]\".\nBefore using var_create, setup the appropriate v1_var array using \nthe \"pipe var_v1_create\" command.\n\nParameters\n----------\nvar_name\nele_name\nattribute\nuniverses\nweight\nstep\nlow_lim\nhigh_lim\nmerit_type\ngood_user\nkey_bound\nkey_delta\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n var_name: quad[1]\n ele_name: Q1\n attribute: L\n universes: 1\n weight: 0.001\n step: 0.001\n low_lim: -10\n high_lim: 10\n merit_type: \n good_user: T\n key_bound: T\n key_delta: 0.01 \n", "command_str": "pipe var_create {var_name}^^{ele_name}^^{attribute}^^{universes}^^{weight}^^{step}^^{low_lim}^^{high_lim}^^{merit_type}^^{good_user}^^{key_bound}^^{key_delta}", "parameters": ["var_name", "ele_name", "attribute", "universes", "weight", "step", "low_lim", "high_lim", "merit_type", "good_user", "key_bound", "key_delta"]}, "var_general": {"description": "\nOutput list of all variable v1 arrays\n\nNotes\n-----\nCommand syntax:\n pipe var_general\n\nOutput syntax:\n {v1_var name};{v1_var%v lower bound};{v1_var%v upper bound}\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe var_general", "parameters": []}, "var_v_array": {"description": "\nOutput list of variables for a given data_v1.\n\nNotes\n-----\nCommand syntax:\n pipe var_v_array {v1_var}\n\nExample:\n pipe var_v_array quad_k1\n\nParameters\n----------\nv1_var\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n v1_var: quad_k1\n", "command_str": "pipe var_v_array {v1_var}", "parameters": ["v1_var"]}, "var_v1_array": {"description": "\nOutput list of variables in a given variable v1 array\n\nNotes\n-----\nCommand syntax:\n pipe var_v1_array {v1_var}\n\nParameters\n----------\nv1_var\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n v1_var: quad_k1 \n", "command_str": "pipe var_v1_array {v1_var}", "parameters": ["v1_var"]}, "var_v1_create": {"description": "\nCreate a v1 variable structure along with associated var array.\n\nNotes\n-----\nCommand syntax:\n pipe var_v1_create {v1_name} {n_var_min} {n_var_max}\n\n{n_var_min} and {n_var_max} are the lower and upper bounds of the var\nExample:\n pipe var_v1_create quad_k1 0 45\nThis example creates a v1 var structure called \"quad_k1\" with an associated\nvariable array that has the range [0, 45].\n\nUse the \"set variable\" command to set a created variable parameters.\nIn particular, to slave a lattice parameter to a variable use the command:\n set {v1_name}|ele_name = {lat_param}\nwhere {lat_param} is of the form {ix_uni}@{ele_name_or_location}{param_name}]\nExamples:\n set quad_k1[2]|ele_name = 2@q01w[k1]\n set quad_k1[2]|ele_name = 2@0>>10[k1]\nNote: When setting multiple variable parameters, \n temporarily toggle s%global%lattice_calc_on to False\n (\"set global lattice_calc_on = F\") to prevent Tao trying to evaluate the \npartially created variable and generating unwanted error messages.\n\nParameters\n----------\nv1_name\nn_var_min\nn_var_max\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n v1_name: quad_k1 \n n_var_min: 0 \n n_var_max: 45 \n", "command_str": "pipe var_v1_create {v1_name} {n_var_min} {n_var_max}", "parameters": ["v1_name", "n_var_min", "n_var_max"]}, "var_v1_destroy": {"description": "\nDestroy a v1 var structure along with associated var sub-array.\n\nNotes\n-----\nCommand syntax:\n pipe var_v1_destroy {v1_datum}\n\nParameters\n----------\nv1_datum\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n v1_datum: quad_k1\n", "command_str": "pipe var_v1_destroy {v1_datum}", "parameters": ["v1_datum"]}, "wall3d_radius": {"description": "\nOutput vaccum chamber wall radius for given s-position and angle in (x,y) plane.\nThe radius is with respect to the local wall origin which may not be the (x,y) = (0,0) origin.\n\nNotes\n-----\nCommand syntax:\n pipe wall3d_radius {ix_uni}@{ix_branch} {s_position} {angle}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a lattice branch index. \n {s_position} is the s-position to evaluate at.\n {angle} is the angle to evaluate at.\n\nParameters\n----------\nix_uni : \"\"\nix_branch : \"\"\ns_position\nangle\n\nReturns\n-------\nstring_list\n\nExamples\n--------\n", "command_str": "pipe wall3d_radius {ix_uni}@{ix_branch} {s_position} {angle}", "parameters": ["ix_uni", "ix_branch", "s_position", "angle"]}, "wave": {"description": "\nOutput Wave analysis info.\n\nNotes\n-----\nCommand syntax:\n pipe wave {who}\n\nWhere {who} is one of:\n params\n loc_header\n locations\n plot1, plot2, plot3\n\nParameters\n----------\nwho\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who: params\n", "command_str": "pipe wave {who}", "parameters": ["who"]}} \ No newline at end of file +{"beam": {"description": "\nOutput beam parameters that are not in the beam_init structure.\n\nNotes\n-----\nCommand syntax:\n pipe beam {ix_uni}@{ix_branch}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.\n\nNote: To set beam_init parameters use the \"set beam\" command.\n\nParameters\n----------\nix_uni : optional\nix_branch : \"\"\n\nReturns\n-------\nstring_list \n\nExamples\n-------- \nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/csr_beam_tracking/tao.init\n args:\n ix_uni: 1\n ix_branch: 0\n", "command_str": "pipe beam {ix_uni}@{ix_branch}", "parameters": ["ix_uni", "ix_branch"]}, "beam_init": {"description": "\nOutput beam_init parameters.\n\nNotes\n-----\nCommand syntax:\n pipe beam_init {ix_uni}@{ix_branch}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.\n\nNote: To set beam_init parameters use the \"set beam_init\" command\n\nParameters\n----------\nix_uni : optional\nix_branch : \"\"\n\nReturns\n-------\nstring_list \n\nExamples\n-------- \nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/csr_beam_tracking/tao.init\n args:\n ix_uni: 1\n ix_branch: 0\n", "command_str": "pipe beam_init {ix_uni}@{ix_branch}", "parameters": ["ix_uni", "ix_branch"]}, "bmad_com": {"description": "\nOutput bmad_com structure components.\n\nNotes\n-----\nCommand syntax:\n pipe bmad_com\n\nReturns\n-------\nstring_list \n\nExamples\n-------- \nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe bmad_com", "parameters": []}, "branch1": {"description": "\nOutput lattice branch information for a particular lattice branch.\n\nNotes\n-----\nCommand syntax:\n pipe branch1 {ix_uni}@{ix_branch}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.\n\nParameters\n----------\nix_uni : \"\"\nix_branch : \"\"\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1\n ix_branch: 0\n", "command_str": "pipe branch1 {ix_uni}@{ix_branch}", "parameters": ["ix_uni", "ix_branch"]}, "bunch_comb": {"description": "\nOutputs bunch parameters at a comb point. \nAlso see the \"write bunch_comb\" and \"show bunch -comb\" commands.\n\nNotes\n-----\nCommand syntax:\n pipe bunch_comb {flags} {who} {ix_uni}@{ix_branch} {ix_bunch}\n\nWhere:\n {flags} are optional switches:\n -array_out : If present, the output will be available in the tao_c_interface_com%c_real.\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a branch index. Defaults to s%global%default_branch.\n {ix_bunch} is the bunch index. Defaults to 1.\n {who} is one of:\n x, px, y, py, z, pz, t, s, spin.x, spin.y, spin.z, p0c, beta -- centroid \n x.Q, y.Q, z.Q, a.Q, b.Q, c.Q where Q is one of: beta, alpha, gamma, phi, eta, etap,\n sigma, sigma_p, emit, norm_emit\n sigma.IJ where I, J in range [1,6]\n rel_min.I, rel_max.I where I in range [1,6]\n charge_live, n_particle_live, n_particle_lost_in_ele, ix_ele\n\n Note: If ix_uni or ix_branch is present, \"@\" must be present.\n\nExample:\n pipe bunch_comb py 2@1 1\n\nParameters\n----------\nwho\nix_uni : optional\nix_branch : optional\nix_bunch : default=1\nflags : default=-array_out\n\nReturns\n-------\nstring_list\n if '-array_out' not in flags\nreal_array\n if '-array_out' in flags\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/csr_beam_tracking/tao.init\n args:\n who: x.beta\n", "command_str": "pipe bunch_comb {flags} {who} {ix_uni}@{ix_branch} {ix_bunch}", "parameters": ["flags", "who", "ix_uni", "ix_branch", "ix_bunch"]}, "bunch_params": {"description": "\nOutputs bunch parameters at the exit end of a given lattice element.\n\nNotes\n-----\nCommand syntax:\n pipe bunch_params {ele_id}|{which}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe bunch_params end|model ! parameters at model lattice element named \"end\".\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/csr_beam_tracking/tao.init\n args:\n ele_id: end\n which: model\n", "command_str": "pipe bunch_params {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "bunch1": {"description": "\nOutputs Bunch parameters at the exit end of a given lattice element.\n\nNotes\n-----\nCommand syntax:\n pipe bunch1 {ele_id}|{which} {ix_bunch} {coordinate}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {ix_bunch} is the bunch index.\n {coordinate} is one of: x, px, y, py, z, pz, \"s\", \"t\", \"charge\", \"p0c\", \"state\", \"ix_ele\"\n\nFor example, if {coordinate} = \"px\", the phase space px coordinate of each particle\nof the bunch is displayed. The \"state\" of a particle is an integer. A value of 1 means\nalive and any other value means the particle has been lost.\n\nParameters\n----------\nele_id\ncoordinate\nwhich : default=model\nix_bunch : default=1\n\nReturns\n-------\nreal_array\n if coordinate in ['x', 'px', 'y', 'py', 'z', 'pz', 's', 't', 'charge', 'p0c']\ninteger_array\n if coordinate in ['state', 'ix_ele']\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/csr_beam_tracking/tao.init\n args:\n ele_id: end\n coordinate: x\n which: model\n ix_bunch: 1\n", "command_str": "pipe bunch1 {ele_id}|{which} {ix_bunch} {coordinate}", "parameters": ["ele_id", "which", "ix_bunch", "coordinate"]}, "building_wall_list": {"description": "\nOutput List of building wall sections or section points\n\nNotes\n-----\nCommand syntax:\n pipe building_wall_list {ix_section}\n\nWhere:\n {ix_section} is a building wall section index.\n\nIf {ix_section} is not present, a list of building wall sections is given.\nIf {ix_section} is present, a list of section points is given.\n\nParameters\n----------\nix_section : optional\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall\n args:\n ix_section:\n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall\n args:\n ix_section: 1\n", "command_str": "pipe building_wall_list {ix_section}", "parameters": ["ix_section"]}, "building_wall_graph": {"description": "\nOutput (x, y) points for drawing the building wall for a particular graph.\n\nNotes\n-----\nCommand syntax:\n pipe building_wall_graph {graph}\n\nWhere:\n {graph} is a plot region graph name.\n\nNote: The graph defines the coordinate system for the (x, y) points.\n\nParameters\n----------\ngraph\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall\n args:\n graph: floor_plan.g\n", "command_str": "pipe building_wall_graph {graph}", "parameters": ["graph"]}, "building_wall_point": {"description": "\nadd or delete a building wall point\n\nNotes\n-----\nCommand syntax:\n pipe building_wall_point {ix_section}^^{ix_point}^^{z}^^{x}^^{radius}^^{z_center}^^{x_center}\n\nWhere:\n {ix_section} -- Section index.\n {ix_point} -- Point index. Points of higher indexes will be moved up \n if adding a point and down if deleting.\n {z}, etc... -- See tao_building_wall_point_struct components.\n -- If {z} is set to \"delete\" then delete the point.\n\nParameters\n----------\nix_section\nix_point\nz\nx\nradius\nz_center\nx_center\n\nReturns\n-------\nNone \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall\n args:\n ix_section: 1\n ix_point: 1\n z: 0\n x: 0\n radius: 0\n z_center: 0\n x_center: 0\n", "command_str": "pipe building_wall_point {ix_section}^^{ix_point}^^{z}^^{x}^^{radius}^^{z_center}^^{x_center}", "parameters": ["ix_section", "ix_point", "z", "x", "radius", "z_center", "x_center"]}, "building_wall_section": {"description": "\nAdd or delete a building wall section\n\nNotes\n-----\nCommand syntax:\n pipe building_wall_section {ix_section}^^{sec_name}^^{sec_constraint}\n\nWhere:\n {ix_section} -- Section index. Sections with higher indexes will be\n moved up if adding a section and down if deleting.\n {sec_name} -- Section name.\n {sec_constraint} -- A section constraint name or \"delete\". Must be one of:\n delete -- Delete section. Anything else will add the section.\n none\n left_side\n right_side\n\nParameters\n----------\nix_section\nsec_name\nsec_constraint\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_section: 1\n sec_name: test\n sec_constraint: none\n", "command_str": "pipe building_wall_section {ix_section}^^{sec_name}^^{sec_constraint}", "parameters": ["ix_section", "sec_name", "sec_constraint"]}, "constraints": {"description": "\nOutput optimization data and variable parameters that contribute to the merit function.\n\nNotes\n-----\nCommand syntax:\n pipe constraints {who}\n\nWhere:\n {who} is one of: \"data\" or \"var\"\n\nData constraints output is:\n data name\n constraint type\n evaluation element name\n start element name\n end/reference element name\n measured value\n ref value (only relavent if global%opt_with_ref = T)\n model value\n base value (only relavent if global%opt_with_base = T)\n weight\n merit value\n location where merit is evaluated (if there is a range)\nVar constraints output is:\n var name\n Associated varible attribute\n meas value\n ref value (only relavent if global%opt_with_ref = T)\n model value\n base value (only relavent if global%opt_with_base = T)\n weight\n merit value\n dmerit/dvar\n\nParameters\n----------\nwho\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n who: data\n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who:var\n", "command_str": "pipe constraints {who}", "parameters": ["who"]}, "da_aperture": {"description": "\nOutput dynamic aperture data\n\nNotes\n-----\nCommand syntax:\n pipe da_aperture {ix_uni}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n\nParameters\n----------\nix_uni : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\n", "command_str": "pipe da_aperture {ix_uni}", "parameters": ["ix_uni"]}, "da_params": {"description": "\nOutput dynamic aperture input parameters\n\nNotes\n-----\nCommand syntax:\n pipe da_params {ix_uni}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n\nParameters\n----------\nix_uni : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\n", "command_str": "pipe da_params {ix_uni}", "parameters": ["ix_uni"]}, "data": {"description": "\nOutput Individual datum parameters.\n\nNotes\n-----\nCommand syntax:\n pipe data {ix_uni}@{d2_name}.{d1_name}[{dat_index}]\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {d2_name} is the name of the d2_data structure the datum is in.\n {d1_datum} is the name of the d1_data structure the datum is in.\n {dat_index} is the index of the datum.\n\nUse the \"pipe data-d1\" command to get detailed info on a specific d1 array.\n\nExample:\n pipe data 1@orbit.x[10]\n\nParameters\n----------\nd2_name\nd1_name\nix_uni : optional\ndat_index : default=1\n\nReturns\n-------\nstring_list\n\nExamples\n--------\n\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni:\n d2_name: twiss\n d1_name: end \n dat_index: 1 \n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni: 1\n d2_name: twiss\n d1_name: end\n dat_index: 1\n", "command_str": "pipe data {ix_uni}@{d2_name}.{d1_name}[{dat_index}]", "parameters": ["ix_uni", "d2_name", "d1_name", "dat_index"]}, "data_d_array": {"description": "\nOutput list of datums for a given d1_data structure.\n\nNotes\n-----\nCommand syntax:\n pipe data_d_array {ix_uni}@{d2_name}.{d1_name}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {d2_name} is the name of the containing d2_data structure.\n {d1_name} is the name of the d1_data structure containing the array of datums.\n\nExample:\n pipe data_d_array 1@orbit.x\n\nParameters\n----------\nd2_name\nd1_name\nix_uni : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni: 1 \n d2_name: twiss\n d1_name: end\n", "command_str": "pipe data_d_array {ix_uni}@{d2_name}.{d1_name}", "parameters": ["ix_uni", "d2_name", "d1_name"]}, "data_d1_array": {"description": "\nOutput list of d1 arrays for a given data_d2.\n\nNotes\n-----\nCommand syntax:\n pipe data_d1_array {d2_datum}\n\n{d2_datum} should be of the form\n {ix_uni}@{d2_datum_name}\n\nParameters\n----------\nd2_datum\nix_uni : optional\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni: 1 \n d2_datum: twiss\n", "command_str": "pipe data_d1_array {d2_datum}", "parameters": ["d2_datum"]}, "data_d2": {"description": "\nOutput information on a d2_datum.\n\nNotes\n-----\nCommand syntax:\n pipe data_d2 {ix_uni}@{d2_name}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {d2_name} is the name of the d2_data structure.\n\nParameters\n----------\nd2_name\nix_uni : optional\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni: 1\n d2_name: twiss\n", "command_str": "pipe data_d2 {ix_uni}@{d2_name}", "parameters": ["ix_uni", "d2_name"]}, "data_d2_array": {"description": "\nOutput data d2 info for a given universe.\n\nNotes\n-----\nCommand syntax:\n pipe data_d2_array {ix_uni}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n\nExample:\n pipe data_d2_array 1\n\nParameters\n----------\nix_uni\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni : 1 \n", "command_str": "pipe data_d2_array {ix_uni}", "parameters": ["ix_uni"]}, "data_d2_create": {"description": "\nCreate a d2 data structure along with associated d1 and data arrays.\n\nNotes\n-----\nCommand syntax:\n pipe data_d2_create {ix_uni}@{d2_name}^^{n_d1_data}^^{d_data_arrays_name_min_max}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {d2_name} is the name of the d2_data structure to create.\n {n_d1_data} is the number of associated d1 data structures.\n {d_data_arrays_name_min_max} has the form\n {name1}^^{lower_bound1}^^{upper_bound1}^^....^^{nameN}^^{lower_boundN}^^{upper_boundN}\n where {name} is the data array name and {lower_bound} and {upper_bound} are the bounds of the array.\n\nExample:\n pipe data_d2_create 2@orbit^^2^^x^^0^^45^^y^^1^^47\nThis example creates a d2 data structure called \"orbit\" with \ntwo d1 structures called \"x\" and \"y\".\n\nThe \"x\" d1 structure has an associated data array with indexes in the range [0, 45].\nThe \"y\" d1 structure has an associated data arrray with indexes in the range [1, 47].\n\nUse the \"set data\" command to set created datum parameters.\n\nNote: When setting multiple data parameters, \n temporarily toggle s%global%lattice_calc_on to False\n (\"set global lattice_calc_on = F\") to prevent Tao trying to \n evaluate the partially created datum and generating unwanted error messages.\n\nParameters\n----------\nd2_name\nn_d1_data\nd_data_arrays_name_min_max\nix_uni : optional\n \nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n ix_uni: 1\n d2_name: orbit\n n_d1_data: 2 \n d_data_arrays_name_min_max: x^^0^^45^^y^^1^^47\n", "command_str": "pipe data_d2_create {ix_uni}@{d2_name}^^{n_d1_data}^^{d_data_arrays_name_min_max}", "parameters": ["ix_uni", "d2_name", "n_d1_data", "d_data_arrays_name_min_max"]}, "data_d2_destroy": {"description": "\nDestroy a d2 data structure along with associated d1 and data arrays.\n\nNotes\n-----\nCommand syntax:\n pipe data_d2_destroy {ix_uni}@{d2_name}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {d2_name} is the name of the d2_data structure to destroy.\n\nExample:\n pipe data_d2_destroy 2@orbit\nThis destroys the orbit d2_data structure in universe 2.\n\nParameters\n----------\nd2_name\nix_uni : optional\n \nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n d2_name: orbit\n", "command_str": "pipe data_d2_destroy {ix_uni}@{d2_name}", "parameters": ["ix_uni", "d2_name"]}, "data_parameter": {"description": "\nOutput an array of values for a particular datum parameter for a given array of datums, \n\nNotes\n-----\nCommand syntax:\n pipe data_parameter {data_array} {parameter}\n\n{parameter} may be any tao_data_struct parameter.\nExample:\n pipe data_parameter orbit.x model_value\n\nParameters\n----------\ndata_array\nparameter\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n data_array: twiss.end \n parameter: model_value\n", "command_str": "pipe data_parameter {data_array} {parameter}", "parameters": ["data_array", "parameter"]}, "data_set_design_value": {"description": "\nSet the design (and base & model) values for all datums.\n\nNotes\n-----\nCommand syntax:\n pipe data_set_design_value\n\nExample:\n pipe data_set_design_value\n\nNote: Use the \"data_d2_create\" and \"datum_create\" first to create datums.\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n", "command_str": "pipe data_set_design_value", "parameters": []}, "datum_create": {"description": "\nCreate a datum.\n\nNotes\n-----\nCommand syntax:\n pipe datum_create {datum_name}^^{data_type}^^{ele_ref_name}^^{ele_start_name}^^\n {ele_name}^^{merit_type}^^{meas}^^{good_meas}^^{ref}^^\n {good_ref}^^{weight}^^{good_user}^^{data_source}^^\n {eval_point}^^{s_offset}^^{ix_bunch}^^{invalid_value}^^\n {spin_axis%n0(1)}^^{spin_axis%n0(2)}^^{spin_axis%n0(3)}^^\n {spin_axis%l(1)}^^{spin_axis%l(2)}^^{spin_axis%l(3)}\n\nNote: The 3 values for spin_axis%n0, as a group, are optional. \n Also the 3 values for spin_axis%l are, as a group, optional.\nNote: Use the \"data_d2_create\" first to create a d2 structure with associated d1 arrays.\nNote: After creating all your datums, use the \"data_set_design_value\" routine to \n set the design (and model) values.\n\nParameters\n----------\ndatum_name ! EG: orb.x[3]\ndata_type ! EG: orbit.x\nele_ref_name : optional\nele_start_name : optional\nele_name : optional\nmerit_type : optional\nmeas : default=0\ngood_meas : default=F\nref : default=0\ngood_ref : default=F\nweight : default=0\ngood_user : default=T\ndata_source : default=lat\neval_point : default=END\ns_offset : default=0\nix_bunch : default=0\ninvalid_value : default=0\nspin_axis%n0(1) : optional\nspin_axis%n0(2) : optional\nspin_axis%n0(3) : optional\nspin_axis%l(1) : optional\nspin_axis%l(2) : optional\nspin_axis%l(3) : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n datum_name: twiss.end[6]\n data_type: beta.y\n ele_ref_name:\n ele_start_name:\n ele_name: P1\n merit_type: target\n meas: 0\n good_meas: T\n ref: 0\n good_ref: T\n weight: 0.3\n good_user: T\n data_source: lat\n eval_point: END\n s_offset: 0\n ix_bunch: 1\n invalid_value: 0\n", "command_str": "pipe 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)}", "parameters": ["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)"]}, "datum_has_ele": {"description": "\nOutput whether a datum type has an associated lattice element\n\nNotes\n-----\nCommand syntax:\n pipe datum_has_ele {datum_type}\n\nParameters\n----------\ndatum_type\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n datum_type: twiss.end \n", "command_str": "pipe datum_has_ele {datum_type}", "parameters": ["datum_type"]}, "derivative": {"description": "\nOutput optimization derivatives\n\nNotes\n-----\nCommand syntax:\n pipe derivative\n\nNote: To save time, this command will not recalculate derivatives. \nUse the \"derivative\" command beforehand to recalcuate if needed.\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n", "command_str": "pipe derivative", "parameters": []}, "ele:ac_kicker": {"description": "\nOutput element ac_kicker parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:ac_kicker {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:ac_kicker 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:ac_kicker {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:cartesian_map": {"description": "\nOutput element cartesian_map parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:cartesian_map {ele_id}|{which} {index} {who}\n\nWhere:\n {ele_id} is an element name or index\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is the index number in the ele%cartesian_map(:) array\n {who} is one of: \"base\", or \"terms\"\n\nExample:\n pipe ele:cartesian_map 3@1>>7|model 2 base\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nindex \nwho\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_em_field\n args:\n ele_id: 1@0>>1\n which: model\n index: 1\n who: base\n", "command_str": "pipe ele:cartesian_map {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "ele:chamber_wall": {"description": "\nOutput element beam chamber wall parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:chamber_wall {ele_id}|{which} {index} {who}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is index of the wall.\n {who} is one of:\n \"x\" ! Return min/max in horizontal plane\n \"y\" ! Return min/max in vertical plane\n\nParameters\n----------\nele_id\nindex\nwho\nwhich : default=model\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall3d\n args:\n ele_id: 1@0>>1\n which: model\n index: 1\n who: x\n", "command_str": "pipe ele:chamber_wall {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "ele:control_var": {"description": "\nOutput list of element control variables.\nUsed for group, overlay and ramper type elements.\n\nNotes\n-----\nCommand syntax:\n pipe ele:control_var {ele_id}|{which}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:control_var 3@1>>7|model\nThis gives control info on element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>873\n which: model\n", "command_str": "pipe ele:control_var {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:cylindrical_map": {"description": "\nOutput element cylindrical_map\n\nNotes\n-----\nCommand syntax:\n pipe ele:cylindrical_map {ele_id}|{which} {index} {who}\n\nWhere \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is the index number in the ele%cylindrical_map(:) array\n {who} is one of: \"base\", or \"terms\"\n\nExample:\n pipe ele:cylindrical_map 3@1>>7|model 2 base\nThis gives map #2 of element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nindex\nwho\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_em_field\n args:\n ele_id: 1@0>>5\n which: model\n index: 1\n who: base\n", "command_str": "pipe ele:cylindrical_map {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "ele:elec_multipoles": {"description": "\nOutput element electric multipoles\n\nNotes\n-----\nCommand syntax:\n pipe ele:elec_multipoles {ele_id}|{which}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:elec_multipoles 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:elec_multipoles {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:floor": {"description": "\nOutput element floor coordinates. The output gives four lines. \"Reference\" is\nwithout element misalignments and \"Actual\" is with misalignments. The lines with \"-W\"\ngive the W matrix. The exception is that if ele is a multipass_lord, there will be 4*N\nlines where N is the number of slaves.\n\nNotes\n-----\nCommand syntax:\n pipe ele:floor {ele_id}|{which} {where}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {where} is an optional argument which, if present, is one of\n beginning ! Upstream end\n center ! Middle of element. Surface of element for photonic reflecting elements (crystal, mirror).\n end ! Downstream end (default)\n\nExample:\n pipe ele:floor 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\nwhere : default=end\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n where: \n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n where: center\n", "command_str": "pipe ele:floor {ele_id}|{which} {where}", "parameters": ["ele_id", "which", "where"]}, "ele:gen_attribs": {"description": "\nOutput element general attributes\n\nNotes\n-----\nCommand syntax:\n pipe ele:gen_attribs {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:gen_attribs 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:gen_attribs {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:gen_grad_map": {"description": "\nOutput element gen_grad_map \n\nNotes\n-----\nCommand syntax:\n pipe ele:gen_grad_map {ele_id}|{which} {index} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is the index number in the ele%gen_grad_map(:) array\n {who} is one of: \"base\", or \"derivs\".\n\nExample:\n pipe ele:gen_grad_map 3@1>>7|model 2 base\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nindex\nwho\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_em_field\n args:\n ele_id: 1@0>>9\n which: model\n index: 1\n who: derivs\n", "command_str": "pipe ele:gen_grad_map {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "ele:grid_field": {"description": "\nOutput element grid_field\n\nNotes\n-----\nCommand syntax:\n pipe ele:grid_field {ele_id}|{which} {index} {who}\n\nWhere:\n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is the index number in the ele%grid_field(:) array.\n {who} is one of: \"base\", or \"points\"\n\nExample:\n pipe ele:grid_field 3@1>>7|model 2 base\nThis gives grid #2 of element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nindex \nwho \nwhich : default=model\n \nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_grid\n args:\n ele_id: 1@0>>1\n which: model\n index: 1\n who: base \n", "command_str": "pipe ele:grid_field {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "ele:head": {"description": "\nOutput \"head\" Element attributes\n\nNotes\n-----\nCommand syntax:\n pipe ele:head {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:head 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id \nwhich : default=model\n\nReturns\n-------\nstring_list \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:head {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:lord_slave": {"description": "\nOutput the lord/slave tree of an element.\n\nNotes\n-----\nCommand syntax:\n pipe ele:lord_slave {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:lord_slave 3@1>>7|model\nThis gives lord and slave info on element number 7 in branch 1 of universe 3.\nNote: The lord/slave info is independent of the setting of {which}.\n\nThe output is a number of lines, each line giving information on an element (element index, etc.).\nSome lines begin with the word \"Element\". \nAfter each \"Element\" line, there are a number of lines (possibly zero) that begin with the word \"Slave or \"Lord\".\nThese \"Slave\" and \"Lord\" lines are the slaves and lords of the \"Element\" element.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:lord_slave {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:mat6": {"description": "\nOutput element mat6\n\nNotes\n-----\nCommand syntax:\n pipe ele:mat6 {ele_id}|{which} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {who} is one of: \"mat6\", \"vec0\", or \"err\"\n\nExample:\n pipe ele:mat6 3@1>>7|model mat6\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\nwho : default=mat6\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n who: mat6\n", "command_str": "pipe ele:mat6 {ele_id}|{which} {who}", "parameters": ["ele_id", "which", "who"]}, "ele:methods": {"description": "\nOutput element methods\n\nNotes\n-----\nCommand syntax:\n pipe ele:methods {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:methods 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:methods {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:multipoles": {"description": "\nOutput element multipoles\n\nNotes\n-----\nCommand syntax:\n pipe ele:multipoles {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:multipoles 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:multipoles {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:orbit": {"description": "\nOutput element orbit\n\nNotes\n-----\nCommand syntax:\n pipe ele:orbit {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:orbit 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:orbit {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:param": {"description": "\nOutput lattice element parameter\n\nNotes\n-----\nCommand syntax:\n pipe ele:param {ele_id}|{which} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {who} values are the same as {who} values for \"pipe lat_list\".\n Note: Here {who} must be a single parameter and not a list.\n\nExample:\n pipe ele:param 3@1>>7|model e_tot\nThis gives E_tot of element number 7 in branch 1 of universe 3.\n\nNote: On output the {variable} component will always be \"F\" (since this \ncommand cannot tell if a parameter is allowed to vary).\n\nAlso see: \"pipe lat_list\".\n\nParameters\n----------\nele_id\nwho \nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_photon\n args:\n ele_id: 1@0>>1\n which: model\n who: orbit.vec.1\n", "command_str": "pipe ele:param {ele_id}|{which} {who}", "parameters": ["ele_id", "which", "who"]}, "ele:photon": {"description": "\nOutput element photon parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:photon {ele_id}|{which} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {who} is one of: \"base\", \"material\", or \"curvature\"\n\nExample:\n pipe ele:photon 3@1>>7|model base\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwho \nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_photon\n args:\n ele_id: 1@0>>1\n which: model\n who: base\n", "command_str": "pipe ele:photon {ele_id}|{which} {who}", "parameters": ["ele_id", "which", "who"]}, "ele:spin_taylor": {"description": "\nOutput element spin_taylor parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:spin_taylor {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:spin_taylor 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_spin\n args:\n ele_id: 1@0>>2\n which: model\n", "command_str": "pipe ele:spin_taylor {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:taylor": {"description": "\nOutput element taylor map \n\nNotes\n-----\nCommand syntax:\n pipe ele:taylor {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:taylor 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_taylor\n args:\n ele_id: 1@0>>34\n which: model\n", "command_str": "pipe ele:taylor {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:twiss": {"description": "\nOutput element Twiss parameters\n\nNotes\n-----\nCommand syntax:\n pipe ele:twiss {ele_id}|{which}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n\nExample:\n pipe ele:twiss 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>1\n which: model\n", "command_str": "pipe ele:twiss {ele_id}|{which}", "parameters": ["ele_id", "which"]}, "ele:wake": {"description": "\nOutput element wake.\n\nNotes\n-----\nCommand syntax:\n pipe ele:wake {ele_id}|{which} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {Who} is one of:\n \"sr_long\" \"sr_long_table\"\n \"sr_trans\" \"sr_trans_table\"\n \"lr_mode_table\" \"base\"\n\nExample:\n pipe ele:wake 3@1>>7|model\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nwho\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wake\n args:\n ele_id: 1@0>>1\n which: model\n who: sr_long\n", "command_str": "pipe ele:wake {ele_id}|{which} {who}", "parameters": ["ele_id", "which", "who"]}, "ele:wall3d": {"description": "\nOutput element wall3d parameters.\n\nNotes\n-----\nCommand syntax:\n pipe ele:wall3d {ele_id}|{which} {index} {who}\n\nWhere: \n {ele_id} is an element name or index.\n {which} is one of: \"model\", \"base\" or \"design\"\n {index} is the index number in the ele%wall3d(:) array (size obtained from \"ele:head\").\n {who} is one of: \"base\", or \"table\".\nExample:\n pipe ele:wall3d 3@1>>7|model 2 base\nThis gives element number 7 in branch 1 of universe 3.\n\nParameters\n----------\nele_id\nindex \nwho \nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_wall3d\n args:\n ele_id: 1@0>>1\n which: model\n index: 1\n who: table\n", "command_str": "pipe ele:wall3d {ele_id}|{which} {index} {who}", "parameters": ["ele_id", "which", "index", "who"]}, "evaluate": {"description": "\nOutput the value of an expression. The result may be a vector.\n\nNotes\n-----\nCommand syntax:\n pipe evaluate {flags} {expression}\n\nWhere:\n Optional {flags} are:\n -array_out : If present, the output will be available in the tao_c_interface_com%c_real.\n {expression} is expression to be evaluated.\n\nExample:\n pipe evaluate 3+data::cbar.11[1:10]|model\n\nParameters\n----------\nexpression :\nflags : default=-array_out\n If -array_out, the output will be available in the tao_c_interface_com%c_real.\n\nReturns\n-------\nstring_list\n if '-array_out' not in flags\nreal_array\n if '-array_out' in flags\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n expression: data::cbar.11[1:10]|model\n", "command_str": "pipe evaluate {flags} {expression}", "parameters": ["flags", "expression"]}, "em_field": {"description": "\nOutput EM field at a given point generated by a given element.\n\nNotes\n-----\nCommand syntax:\n pipe em_field {ele_id}|{which} {x} {y} {z} {t_or_z}\n\nWhere:\n {which} is one of: \"model\", \"base\" or \"design\"\n {x}, {y} -- Transverse coords.\n {z} -- Longitudinal coord with respect to entrance end of element.\n {t_or_z} -- time or phase space z depending if lattice is setup for absolute time tracking.\n\nParameters\n----------\nele_id\nx\ny\nz\nt_or_z\nwhich : default=model\n \nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele_id: 1@0>>22\n which: model\n x: 0\n y: 0\n z: 0\n t_or_z: 0\n", "command_str": "pipe em_field {ele_id}|{which} {x} {y} {z} {t_or_z}", "parameters": ["ele_id", "which", "x", "y", "z", "t_or_z"]}, "enum": {"description": "\nOutput list of possible values for enumerated numbers.\n\nNotes\n-----\nCommand syntax:\n pipe enum {enum_name}\n\nExample:\n pipe enum tracking_method\n\nParameters\n----------\nenum_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n enum_name: tracking_method\n", "command_str": "pipe enum {enum_name}", "parameters": ["enum_name"]}, "floor_plan": {"description": "\nOutput (x,y) points and other information that can be used for drawing a floor_plan.\n\nNotes\n-----\nCommand syntax:\n pipe floor_plan {graph}\n\nParameters\n----------\ngraph\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n graph: r13.g\n", "command_str": "pipe floor_plan {graph}", "parameters": ["graph"]}, "floor_orbit": {"description": "\nOutput (x, y) coordinates for drawing the particle orbit on a floor plan.\n\nNotes\n-----\nCommand syntax:\n pipe floor_orbit {graph}\n\nParameters\n----------\ngraph\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_floor_orbit\n args:\n graph: r33.g \n", "command_str": "pipe floor_orbit {graph}", "parameters": ["graph"]}, "global": {"description": "\nOutput global parameters.\n\nNotes\n-----\nCommand syntax:\n pipe global\n\nOutput syntax is parameter list form. See documentation at the beginning of this file.\n\nNote: The follow is intentionally left out:\n optimizer_allow_user_abort\n quiet\n single_step\n prompt_color\n prompt_string\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe global", "parameters": []}, "global:optimization": {"description": "\nOutput optimization parameters.\nAlso see global:opti_de.\n\nNotes\n-----\nCommand syntax:\n pipe global:optimization\n\nOutput syntax is parameter list form. See documentation at the beginning of this file.\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe global:optimization", "parameters": []}, "global:opti_de": {"description": "\nOutput DE optimization parameters.\n\nNotes\n-----\nCommand syntax:\n pipe global:opti_de\n\nOutput syntax is parameter list form. See documentation at the beginning of this file.\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe global:opti_de", "parameters": []}, "help": {"description": "\nOutput list of \"help xxx\" topics\n\nNotes\n-----\nCommand syntax:\n pipe help\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe help", "parameters": []}, "inum": {"description": "\nOutput list of possible values for an INUM parameter.\nFor example, possible index numbers for the branches of a lattice.\n\nNotes\n-----\nCommand syntax:\n pipe inum {who}\n\nParameters\n----------\nwho\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who: ix_universe\n", "command_str": "pipe inum {who}", "parameters": ["who"]}, "lat_calc_done": {"description": "\nOutput if a lattice recalculation has been proformed since the last \n time \"pipe lat_calc_done\" was called.\n\nNotes\n-----\nCommand syntax:\n pipe lat_calc_done\n\nParameters\n----------\nbranch_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n branch_name: 1@0\n", "command_str": "pipe lat_calc_done", "parameters": []}, "lat_ele_list": {"description": "\nOutput lattice element list.\n\nNotes\n-----\nCommand syntax:\n pipe lat_ele_list {branch_name}\n\n{branch_name} should have the form:\n {ix_uni}@{ix_branch}\n\nParameters\n----------\nbranch_name : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n branch_name: 1@0\n", "command_str": "pipe lat_ele_list {branch_name}", "parameters": ["branch_name"]}, "lat_branch_list": {"description": "\nOutput lattice branch list\n\nNotes\n-----\nCommand syntax:\n pipe lat_branch_list {ix_uni}\n\nOutput syntax:\n branch_index;branch_name;n_ele_track;n_ele_max\n\nParameters\n----------\nix_uni : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1\n", "command_str": "pipe lat_branch_list {ix_uni}", "parameters": ["ix_uni"]}, "lat_list": {"description": "\nOutput list of parameters at ends of lattice elements\n\nNotes\n-----\nCommand syntax:\n pipe lat_list {flags} {ix_uni}@{ix_branch}>>{elements}|{which} {who}\n\nWhere:\n Optional {flags} are:\n -no_slaves : If present, multipass_slave and super_slave elements will not be matched to.\n -track_only : If present, lord elements will not be matched to.\n -index_order : If present, order elements by element index instead of the standard s-position.\n -array_out : If present, the output will be available in the tao_c_interface_com%c_real or\n tao_c_interface_com%c_integer arrays. See the code below for when %c_real vs %c_integer is used.\n Note: Only a single {who} item permitted when -array_out is present.\n\n {which} is one of: \"model\", \"base\" or \"design\"\n\n {who} is a comma deliminated list of:\n orbit.floor.x, orbit.floor.y, orbit.floor.z ! Floor coords at particle orbit.\n orbit.spin.1, orbit.spin.2, orbit.spin.3,\n orbit.vec.1, orbit.vec.2, orbit.vec.3, orbit.vec.4, orbit.vec.5, orbit.vec.6,\n orbit.t, orbit.beta,\n orbit.state, ! Note: state is an integer. alive$ = 1, anything else is lost.\n orbit.energy, orbit.pc,\n ele.name, ele.key, ele.ix_ele, ele.ix_branch\n ele.a.beta, ele.a.alpha, ele.a.eta, ele.a.etap, ele.a.gamma, ele.a.phi,\n ele.b.beta, ele.b.alpha, ele.b.eta, ele.b.etap, ele.b.gamma, ele.b.phi,\n ele.x.eta, ele.x.etap,\n ele.y.eta, ele.y.etap,\n ele.ref_time, ele.ref_time_start\n ele.s, ele.l\n ele.e_tot, ele.p0c\n ele.mat6 ! Output: mat6(1,:), mat6(2,:), ... mat6(6,:)\n ele.vec0 ! Output: vec0(1), ... vec0(6)\n ele.c_mat ! Output: c_mat11, c_mat12, c_mat21, c_mat22.\n ele.gamma_c ! Parameter associated with coupling c-matrix.\n ele.XXX ! Where XXX is a Bmad syntax element attribute. (EG: ele.beta_a, ele.k1, etc.)\n\n {elements} is a string to match element names to.\n Use \"*\" to match to all elements.\n\nExamples:\n pipe lat_list -track 3@0>>Q*|base ele.s,orbit.vec.2\n pipe lat_list 3@0>>Q*|base real:ele.s \n\nAlso see: \"pipe ele:param\"\n\nParameters\n----------\nelements \nwho \nix_uni : optional\nix_branch : optional\nwhich : default=model\nflags : optional, default=-array_out -track_only\n\nReturns\n-------\nstring_list\n if ('-array_out' not in flags) or (who in ['ele.name', 'ele.key'])\ninteger_array\n if '-array_out' in flags and who in ['orbit.state', 'ele.ix_ele']\nreal_array\n if ('-array_out' in flags) or ('real:' in who) \n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1 \n ix_branch: 0 \n elements: Q* \n which: model\n who: orbit.floor.x\n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1 \n ix_branch: 0 \n elements: Q* \n which: design\n who: ele.ix_ele\n\n\n", "command_str": "pipe lat_list {flags} {ix_uni}@{ix_branch}>>{elements}|{which} {who}", "parameters": ["flags", "ix_uni", "ix_branch", "elements", "which", "who"]}, "lat_param_units": {"description": "\nOutput units of a parameter associated with a lattice or lattice element.\n\nNotes\n-----\nCommand syntax:\n pipe lat_param_units {param_name}\n\nParameters\n----------\nparam_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n param_name: L \n", "command_str": "pipe lat_param_units {param_name}", "parameters": ["param_name"]}, "matrix": {"description": "\nOutput matrix value from the exit end of one element to the exit end of the other.\n\nNotes\n-----\nCommand syntax:\n pipe matrix {ele1_id} {ele2_id}\n\nWhere:\n {ele1_id} is the start element.\n {ele2_id} is the end element.\nIf {ele2_id} = {ele1_id}, the 1-turn transfer map is computed.\nNote: {ele2_id} should just be an element name or index without universe, branch, or model/base/design specification.\n\nExample:\n pipe matrix 2@1>>q01w|design q02w\n\nParameters\n----------\nele1_id\nele2_id\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele1_id: 1@0>>q01w|design\n ele2_id: q02w\n", "command_str": "pipe matrix {ele1_id} {ele2_id}", "parameters": ["ele1_id", "ele2_id"]}, "merit": {"description": "\nOutput merit value.\n\nNotes\n-----\nCommand syntax:\n pipe merit\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe merit", "parameters": []}, "orbit_at_s": {"description": "\nOutput twiss at given s position.\n\nNotes\n-----\nCommand syntax:\n pipe orbit_at_s {ix_uni}@{ele}->{s_offset}|{which}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ele} is an element name or index. Default at the Beginning element at start of branch 0.\n {s_offset} is the offset of the evaluation point from the downstream end of ele. Default is 0.\n If {s_offset} is present, the preceeding \"->\" sign must be present. EG: Something like \"23|model\" will\n {which} is one of: \"model\", \"base\" or \"design\".\n\nExample:\n pipe orbit_at_s Q10->0.4|model ! Orbit at 0.4 meters from Q10 element exit end in model lattice.\n\nParameters\n----------\nix_uni : optional\nele : optional\ns_offset : optional\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1\n ele: 10\n s_offset: 0.7\n which: model\n", "command_str": "pipe orbit_at_s {ix_uni}@{ele}->{s_offset}|{which}", "parameters": ["ix_uni", "ele", "s_offset", "which"]}, "place_buffer": {"description": "\nOutput the place command buffer and reset the buffer.\nThe contents of the buffer are the place commands that the user has issued.\nSee the Tao manual for more details.\n\nNotes\n-----\nCommand syntax:\n pipe place_buffer\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe place_buffer", "parameters": []}, "plot_curve": {"description": "\nOutput curve information for a plot.\n\nNotes\n-----\nCommand syntax:\n pipe plot_curve {curve_name}\n\nParameters\n----------\ncurve_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n curve_name: r13.g.a\n", "command_str": "pipe plot_curve {curve_name}", "parameters": ["curve_name"]}, "plot_graph": {"description": "\nOutput graph info.\n\nNotes\n-----\nCommand syntax:\n pipe plot_graph {graph_name}\n\n{graph_name} is in the form:\n {p_name}.{g_name}\nwhere\n {p_name} is the plot region name if from a region or the plot name if a template plot.\n This name is obtained from the pipe plot_list command.\n {g_name} is the graph name obtained from the pipe plot1 command.\n\nParameters\n----------\ngraph_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n graph_name: beta.g\n", "command_str": "pipe plot_graph {graph_name}", "parameters": ["graph_name"]}, "plot_histogram": {"description": "\nOutput plot histogram info.\n\nNotes\n-----\nCommand syntax:\n pipe plot_histogram {curve_name}\n\nParameters\n----------\ncurve_name\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n curve_name: r33.g.x\n", "command_str": "pipe plot_histogram {curve_name}", "parameters": ["curve_name"]}, "plot_lat_layout": {"description": "\nOutput plot Lat_layout info\n\nNotes\n-----\nCommand syntax:\n pipe plot_lat_layout {ix_uni}@{ix_branch}\n\nNote: The returned list of element positions is not ordered in increasing\n longitudinal position.\n\nParameters\n----------\nix_uni: 1\nix_branch: 0\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1\n ix_branch: 0 \n", "command_str": "pipe plot_lat_layout {ix_uni}@{ix_branch}", "parameters": ["ix_uni", "ix_branch"]}, "plot_list": {"description": "\nOutput list of plot templates or plot regions.\n\nNotes\n-----\nCommand syntax:\n pipe plot_list {r_or_g}\n\nwhere \"{r/g}\" is:\n \"r\" ! list regions of the form ix;region_name;plot_name;visible;x1;x2;y1;y2\n \"t\" ! list template plots of the form ix;name\n\nParameters\n----------\nr_or_g\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n r_or_g: r\n", "command_str": "pipe plot_list {r_or_g}", "parameters": ["r_or_g"]}, "plot_template_manage": {"description": "\nTemplate plot creation or destruction.\n\nNotes\n-----\nCommand syntax:\n pipe plot_template_manage {template_location}^^{template_name}^^\n {n_graph}^^{graph_names}\n\nWhere:\n {template_location} is the location to place or delete a template plot. Use \"@Tnnn\" syntax for the location.\n {template_name} is the name of the template plot. If deleting a plot this name is immaterial.\n {n_graph} is the number of associated graphs. If set to -1 then any existing template plot is deleted.\n {graph_names} are the names of the graphs. graph_names should be in the form:\n graph1_name^^graph2_name^^...^^graphN_name\n for N=n_graph names\n\nParameters\n----------\ntemplate_location\ntemplate_name\nn_graph : default=-1\ngraph_names : default=\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n template_location: @T1\n template_name: beta\n n_graph: 2\n graph_names: g1^^g2\n", "command_str": "pipe plot_template_manage {template_location}^^{template_name}^^{n_graph}^^{graph_names}", "parameters": ["template_location", "template_name", "n_graph", "graph_names"]}, "plot_curve_manage": {"description": "\nTemplate plot curve creation/destruction\n\nNotes\n-----\nCommand syntax:\n pipe plot_curve_manage {graph_name}^^{curve_index}^^{curve_name}\n\nIf {curve_index} corresponds to an existing curve then this curve is deleted.\nIn this case the {curve_name} is ignored and does not have to be present.\nIf {curve_index} does not not correspond to an existing curve, {curve_index}\nmust be one greater than the number of curves.\n\nParameters\n----------\ngraph_name\ncurve_index\ncurve_name\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n graph_name: beta.g\n curve_index: 1\n curve_name: r13.g.a\n", "command_str": "pipe plot_curve_manage {graph_name}^^{curve_index}^^{curve_name}", "parameters": ["graph_name", "curve_index", "curve_name"]}, "plot_graph_manage": {"description": "\nTemplate plot graph creation/destruction\n\nNotes\n-----\nCommand syntax:\n pipe plot_graph_manage {plot_name}^^{graph_index}^^{graph_name}\n\nIf {graph_index} corresponds to an existing graph then this graph is deleted.\nIn this case the {graph_name} is ignored and does not have to be present.\nIf {graph_index} does not not correspond to an existing graph, {graph_index}\nmust be one greater than the number of graphs.\n\nParameters\n----------\nplot_name\ngraph_index\ngraph_name\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n plot_name: beta\n graph_index: 1\n graph_name: beta.g\n", "command_str": "pipe plot_graph_manage {plot_name}^^{graph_index}^^{graph_name}", "parameters": ["plot_name", "graph_index", "graph_name"]}, "plot_line": {"description": "\nOutput points used to construct the \"line\" associated with a plot curve.\n\nNotes\n-----\nCommand syntax:\n pipe plot_line {region_name}.{graph_name}.{curve_name} {x_or_y}\n\nOptional {x-or-y} may be set to \"x\" or \"y\" to get the smooth line points x or y \ncomponent put into the real array buffer.\nNote: The plot must come from a region, and not a template, since no template plots \n have associated line data.\nExamples:\n pipe plot_line r13.g.a ! String array output.\n pipe plot_line r13.g.a x ! x-component of line points loaded into the real array buffer.\n pipe plot_line r13.g.a y ! y-component of line points loaded into the real array buffer.\n\nParameters\n----------\nregion_name\ngraph_name\ncurve_name\nx_or_y : optional\n\nReturns\n-------\nstring_list\n if x_or_y == ''\nreal_array\n if x_or_y != ''\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_plot_line -external_plotting\n args:\n region_name: beta\n graph_name: g\n curve_name: a\n x_or_y:\n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_plot_line -external_plotting\n args:\n region_name: beta\n graph_name: g\n curve_name: a\n x_or_y: y\n", "command_str": "pipe plot_line {region_name}.{graph_name}.{curve_name} {x_or_y}", "parameters": ["region_name", "graph_name", "curve_name", "x_or_y"]}, "plot_symbol": {"description": "\nOutput locations to draw symbols for a plot curve.\n\nNotes\n-----\nCommand syntax:\n pipe plot_symbol {region_name}.{graph_name}.{curve_name} {x_or_y}\n\nOptional {x_or_y} may be set to \"x\" or \"y\" to get the symbol x or y \npositions put into the real array buffer.\nNote: The plot must come from a region, and not a template, \n since no template plots have associated symbol data.\nExamples:\n pipe plot_symbol r13.g.a ! String array output.\n pipe plot_symbol r13.g.a x ! x-component of the symbol positions \n loaded into the real array buffer.\n pipe plot_symbol r13.g.a y ! y-component of the symbol positions \n loaded into the real array buffer.\n\nParameters\n----------\nregion_name\ngraph_name\ncurve_name\nx_or_y\n\nReturns\n-------\nstring_list\n if x_or_y == ''\nreal_array\n if x_or_y != ''\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_plot_line -external_plotting\n args:\n region_name: r13\n graph_name: g\n curve_name: a\n x_or_y: \n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_plot_line -external_plotting\n args:\n region_name: r13\n graph_name: g\n curve_name: a\n x_or_y: y\n", "command_str": "pipe plot_symbol {region_name}.{graph_name}.{curve_name} {x_or_y}", "parameters": ["region_name", "graph_name", "curve_name", "x_or_y"]}, "plot_transfer": {"description": "\nOutput transfer plot parameters from the \"from plot\" to the \"to plot\" (or plots).\n\nNotes\n-----\nCommand syntax:\n pipe plot_transfer {from_plot} {to_plot}\n\nTo avoid confusion, use \"@Tnnn\" and \"@Rnnn\" syntax for {from_plot}.\nIf {to_plot} is not present and {from_plot} is a template plot, the \"to plots\" \n are the equivalent region plots with the same name. And vice versa \n if {from_plot} is a region plot.\n\nParameters\n----------\nfrom_plot\nto_plot\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n from_plot: r13\n to_plot: r23 \n", "command_str": "pipe plot_transfer {from_plot} {to_plot}", "parameters": ["from_plot", "to_plot"]}, "plot1": {"description": "\nOutput info on a given plot.\n\nNotes\n-----\nCommand syntax:\n pipe plot1 {name}\n\n{name} should be the region name if the plot is associated with a region.\nOutput syntax is parameter list form. See documentation at the beginning of this file.\n\nParameters\n----------\nname\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n name: beta\n", "command_str": "pipe plot1 {name}", "parameters": ["name"]}, "ptc_com": {"description": "\nOutput Ptc_com structure components.\n\nNotes\n-----\nCommand syntax:\n pipe ptc_com\n\nReturns\n-------\nstring_list \n\nExamples\n-------- \nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init \n args:\n", "command_str": "pipe ptc_com", "parameters": []}, "ring_general": {"description": "\nOutput lattice branch with closed geometry info (emittances, etc.)\n\nNotes\n-----\nCommand syntax:\n pipe ring_general {ix_uni}@{ix_branch}|{which}\n\nwhere {which} is one of:\n model\n base\n design\nExample:\n pipe ring_general 1@0|model\n\nParameters\n----------\nix_uni : optional\nix_branch : optional\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ix_uni: 1\n ix_branch: 0\n which: model\n\n", "command_str": "pipe ring_general {ix_uni}@{ix_branch}|{which}", "parameters": ["ix_uni", "ix_branch", "which"]}, "shape_list": {"description": "\nOutput lat_layout or floor_plan shapes list\n\nNotes\n-----\nCommand syntax:\n pipe shape_list {who}\n\n{who} is one of:\n lat_layout\n floor_plan\n\nParameters\n----------\nwho\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who: floor_plan \n", "command_str": "pipe shape_list {who}", "parameters": ["who"]}, "shape_manage": {"description": "\nElement shape creation or destruction\n\nNotes\n-----\nCommand syntax:\n pipe shape_manage {who} {index} {add_or_delete}\n\n{who} is one of:\n lat_layout\n floor_plan\n{add_or_delete} is one of:\n add -- Add a shape at {index}. \n Shapes with higher index get moved up one to make room.\n delete -- Delete shape at {index}. \n Shapes with higher index get moved down one to fill the gap.\n\nExample:\n pipe shape_manage floor_plan 2 add\nNote: After adding a shape use \"pipe shape_set\" to set shape parameters.\nThis is important since an added shape is in a ill-defined state.\n\nParameters\n----------\nwho\nindex\nadd_or_delete\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who: floor_plan\n index: 1\n add_or_delete: add\n", "command_str": "pipe shape_manage {who} {index} {add_or_delete}", "parameters": ["who", "index", "add_or_delete"]}, "shape_pattern_list": {"description": "\nOutput list of shape patterns or shape pattern points\n\nNotes\n-----\nCommand syntax:\n pipe shape_pattern_list {ix_pattern}\n\nIf optional {ix_pattern} index is omitted then list all the patterns.\nIf {ix_pattern} is present, list points of given pattern.\n\nParameters\n----------\nix_pattern : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_shape\n args:\n ix_pattern: \n", "command_str": "pipe shape_pattern_list {ix_pattern}", "parameters": ["ix_pattern"]}, "shape_pattern_manage": {"description": "\nAdd or remove shape pattern\n\nNotes\n-----\nCommand syntax:\n pipe shape_pattern_manage {ix_pattern}^^{pat_name}^^{pat_line_width}\n\nWhere:\n {ix_pattern} -- Pattern index. Patterns with higher indexes will be moved up \n if adding a pattern and down if deleting.\n {pat_name} -- Pattern name.\n {pat_line_width} -- Line width. Integer. If set to \"delete\" then section \n will be deleted.\n\nParameters\n----------\nix_pattern\npat_name\npat_line_width\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_shape\n args:\n ix_pattern : 1\n pat_name : new_pat\n pat_line_width : 1\n", "command_str": "pipe shape_pattern_manage {ix_pattern}^^{pat_name}^^{pat_line_width}", "parameters": ["ix_pattern", "pat_name", "pat_line_width"]}, "shape_pattern_point_manage": {"description": "\nAdd or remove shape pattern point\n\nNotes\n-----\nCommand syntax:\n pipe shape_pattern_point_manage {ix_pattern}^^{ix_point}^^{s}^^{x}\n\nWhere:\n {ix_pattern} -- Pattern index.\n {ix_point} -- Point index. Points of higher indexes will be moved up\n if adding a point and down if deleting.\n {s}, {x} -- Point location. If {s} is \"delete\" then delete the point.\n\nParameters\n----------\nix_pattern\nix_point\ns\nx\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_shape\n args:\n ix_pattern: 1\n ix_point: 1\n s: 0\n x: 0\n", "command_str": "pipe shape_pattern_point_manage {ix_pattern}^^{ix_point}^^{s}^^{x}", "parameters": ["ix_pattern", "ix_point", "s", "x"]}, "shape_set": {"description": "\nSet lat_layout or floor_plan shape parameters.\n\nNotes\n-----\nCommand syntax:\n pipe shape_set {who}^^{shape_index}^^{ele_name}^^{shape}^^{color}^^\n {shape_size}^^{type_label}^^{shape_draw}^^\n {multi_shape}^^{line_width}\n\n{who} is one of:\n lat_layout\n floor_plan\n\nParameters\n----------\nwho\nshape_index\nele_name\nshape\ncolor\nshape_size\ntype_label\nshape_draw\nmulti_shape\nline_width\n\nReturns\n-------\nNone\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who: floor_plan\n shape_index: 1\n ele_name: Q1\n shape: circle\n color:\n shape_size:\n type_label:\n shape_draw:\n multi_shape:\n line_width:\n", "command_str": "pipe shape_set {who}^^{shape_index}^^{ele_name}^^{shape}^^{color}^^{shape_size}^^{type_label}^^{shape_draw}^^{multi_shape}^^{line_width}", "parameters": ["who", "shape_index", "ele_name", "shape", "color", "shape_size", "type_label", "shape_draw", "multi_shape", "line_width"]}, "show": {"description": "\nOutput the output from a show command.\n\nNotes\n-----\nCommand syntax:\n pipe show {line}\n\n{line} is the string to pass through to the show command.\nExample:\n pipe show lattice -pipe\n\nParameters\n----------\nline\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n line: -pipe\n", "command_str": "pipe show {line}", "parameters": ["line"]}, "space_charge_com": {"description": "\nOutput space_charge_com structure parameters.\n\nNotes\n-----\nCommand syntax:\n pipe space_charge_com\n\nOutput syntax is parameter list form. See documentation at the beginning of this file.\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe space_charge_com", "parameters": []}, "species_to_int": {"description": "\nConvert species name to corresponding integer\n\nNotes\n-----\nCommand syntax:\n pipe species_to_int {species_str}\n\nExample:\n pipe species_to_int CO2++\n\nParameters\n----------\nspecies_str\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n species_str: electron\n", "command_str": "pipe species_to_int {species_str}", "parameters": ["species_str"]}, "species_to_str": {"description": "\nConvert species integer id to corresponding\n\nNotes\n-----\nCommand syntax:\n pipe species_to_str {species_int}\n\nExample:\n pipe species_to_str -1 ! Returns 'Electron'\n\nParameters\n----------\nspecies_int\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n species_int: -1\n", "command_str": "pipe species_to_str {species_int}", "parameters": ["species_int"]}, "spin_invariant": {"description": "\nOutput closed orbit spin axes n0, l0, or m0 at the ends of all lattice elements in a branch.\nn0, l0, and m0 are solutions of the T-BMT equation.\nn0 is periodic while l0 and m0 are not. At the beginning of the branch, the orientation of the \nl0 or m0 axes in the plane perpendicular to the n0 axis is chosen a bit arbitrarily.\nSee the Bmad manual for more details.\n\nNotes\n-----\nCommand syntax:\n pipe spin_invariant {flags} {who} {ix_uni}@{ix_branch}|{which}\n\nWhere:\n {flags} are optional switches:\n -array_out : If present, the output will be available in the tao_c_interface_com%c_real.\n {who} is one of: l0, n0, or m0\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a branch index. Defaults to s%global%default_branch.\n {which} is one of:\n model\n base\n design\n\nExample:\n pipe spin_invariant 1@0|model\n\nNote: This command is under development. If you want to use please contact David Sagan.\n\nParameters\n----------\nwho\nix_uni : optional\nix_branch : optional\nwhich : default=model\nflags : default=-array_out\n\nReturns\n-------\nstring_list\n if '-array_out' not in flags\nreal_array\n if '-array_out' in flags\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n who: l0\n ix_uni: 1\n ix_branch: 0\n which: model\n", "command_str": "pipe spin_invariant {flags} {who} {ix_uni}@{ix_branch}|{which}", "parameters": ["flags", "who", "ix_uni", "ix_branch", "which"]}, "spin_polarization": {"description": "\nOutput spin polarization information\n\nNotes\n-----\nCommand syntax:\n pipe spin_polarization {ix_uni}@{ix_branch}|{which}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a branch index. Defaults to s%global%default_branch.\n {which} is one of:\n model\n base\n design\n\nExample:\n pipe spin_polarization 1@0|model\n\nNote: This command is under development. If you want to use please contact David Sagan.\n\nParameters\n----------\nix_uni : optional\nix_branch : optional\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n ix_uni: 1\n ix_branch: 0\n which: model\n", "command_str": "pipe spin_polarization {ix_uni}@{ix_branch}|{which}", "parameters": ["ix_uni", "ix_branch", "which"]}, "spin_resonance": {"description": "\nOutput spin resonance information\n\nNotes \n-----\nCommand syntax:\n pipe spin_resonance {ix_uni}@{ix_branch}|{which} {ref_ele}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a lattice branch index. Defaults to s%global%default_branch.\n {which} is one of: \"model\", \"base\" or \"design\"\n {ref_ele} is an element name or index.\nThis will return a string_list with the following fields:\n spin_tune -- Spin tune\n 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.\n xi_res_X_sum, xi_res_X_diff -- The linear spin/orbit sum and difference resonance strengths for X = a, b, and c modes. \n\nParameters\n----------\nix_uni : optional\nix_branch : optional\nwhich : default=model\nref_ele : default=0\n Reference element to calculate at.\n\nReturns\n-------\nstring_list \n\nExamples\n--------\n\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n ix_uni: 1\n ix_branch: 0\n which: model\n", "command_str": "pipe spin_resonance {ix_uni}@{ix_branch}|{which} {ref_ele}", "parameters": ["ix_uni", "ix_branch", "which", "ref_ele"]}, "super_universe": {"description": "\nOutput super_Universe parameters.\n\nNotes\n-----\nCommand syntax:\n pipe super_universe\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n", "command_str": "pipe super_universe", "parameters": []}, "taylor_map": {"description": "\nOutput Taylor map between two points.\n\nNotes\n-----\nCommand syntax:\n pipe taylor_map {ele1_id} {ele2_id} {order}\n\nWhere:\n {ele1_id} is the start element.\n {ele2_id} is the end element.\n {order} is the map order. Default is order set in the lattice file. {order} cannot be larger than \n what is set by the lattice file. \nIf {ele2_id} = {ele1_id}, the 1-turn transfer map is computed.\nNote: {ele2_id} should just be an element name or index without universe, branch, or model/base/design specification.\nExample:\n pipe taylor_map 2@1>>q01w|design q02w 2\n\nParameters\n----------\nele1_id \nele2_id \norder : default=1\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n ele1_id: 1@0>>q01w|design\n ele2_id: q02w\n order: 1\n", "command_str": "pipe taylor_map {ele1_id} {ele2_id} {order}", "parameters": ["ele1_id", "ele2_id", "order"]}, "twiss_at_s": {"description": "\nOutput twiss parameters at given s position.\n\nNotes\n-----\nCommand syntax:\n pipe twiss_at_s {ix_uni}@{ele}->{s_offset}|{which}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ele} is an element name or index. Default at the Beginning element at start of branch 0.\n {s_offset} is the offset of the evaluation point from the downstream end of ele. Default is 0.\n If {s_offset} is present, the preceeding \"->\" sign must be present. EG: Something like \"23|model\" will\n {which} is one of: \"model\", \"base\" or \"design\".\n\nParameters\n----------\nix_uni : optional\nele : optional\ns_offset : optional\nwhich : default=model\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n ix_uni: 1\n ele: 10\n s_offset: 0.7\n which: model \n", "command_str": "pipe twiss_at_s {ix_uni}@{ele}->{s_offset}|{which}", "parameters": ["ix_uni", "ele", "s_offset", "which"]}, "universe": {"description": "\nOutput universe info.\n\nNotes\n-----\nCommand syntax:\n pipe universe {ix_uni}\n\nUse \"pipe global\" to get the number of universes.\n\nParameters\n----------\nix_uni\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args: \n ix_uni: 1\n", "command_str": "pipe universe {ix_uni}", "parameters": ["ix_uni"]}, "var": {"description": "\nOutput parameters of a given variable.\n\nNotes\n-----\nCommand syntax:\n pipe var {var} {slaves}\n\nNote: use \"pipe var_general\" to get a list of variables.\n\nParameters\n----------\nvar\nslaves : optional\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args: \n var: quad[1]\n slaves:\n\nExample: 2\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args: \n var: quad[1]\n slaves: slaves\n", "command_str": "pipe var {var} {slaves}", "parameters": ["var", "slaves"]}, "var_create": {"description": "\nCreate a single variable\n\nNotes\n-----\nCommand syntax:\n pipe var_create {var_name}^^{ele_name}^^{attribute}^^{universes}^^\n {weight}^^{step}^^{low_lim}^^{high_lim}^^{merit_type}^^\n {good_user}^^{key_bound}^^{key_delta}\n\n{var_name} is something like \"kick[5]\".\nBefore using var_create, setup the appropriate v1_var array using \nthe \"pipe var_v1_create\" command.\n\nParameters\n----------\nvar_name\nele_name\nattribute\nuniverses\nweight\nstep\nlow_lim\nhigh_lim\nmerit_type\ngood_user\nkey_bound\nkey_delta\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/tao.init_optics_matching\n args:\n var_name: quad[1]\n ele_name: Q1\n attribute: L\n universes: 1\n weight: 0.001\n step: 0.001\n low_lim: -10\n high_lim: 10\n merit_type: \n good_user: T\n key_bound: T\n key_delta: 0.01 \n", "command_str": "pipe var_create {var_name}^^{ele_name}^^{attribute}^^{universes}^^{weight}^^{step}^^{low_lim}^^{high_lim}^^{merit_type}^^{good_user}^^{key_bound}^^{key_delta}", "parameters": ["var_name", "ele_name", "attribute", "universes", "weight", "step", "low_lim", "high_lim", "merit_type", "good_user", "key_bound", "key_delta"]}, "var_general": {"description": "\nOutput list of all variable v1 arrays\n\nNotes\n-----\nCommand syntax:\n pipe var_general\n\nOutput syntax:\n {v1_var name};{v1_var%v lower bound};{v1_var%v upper bound}\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n", "command_str": "pipe var_general", "parameters": []}, "var_v_array": {"description": "\nOutput list of variables for a given data_v1.\n\nNotes\n-----\nCommand syntax:\n pipe var_v_array {v1_var}\n\nExample:\n pipe var_v_array quad_k1\n\nParameters\n----------\nv1_var\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n v1_var: quad_k1\n", "command_str": "pipe var_v_array {v1_var}", "parameters": ["v1_var"]}, "var_v1_array": {"description": "\nOutput list of variables in a given variable v1 array\n\nNotes\n-----\nCommand syntax:\n pipe var_v1_array {v1_var}\n\nParameters\n----------\nv1_var\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n v1_var: quad_k1 \n", "command_str": "pipe var_v1_array {v1_var}", "parameters": ["v1_var"]}, "var_v1_create": {"description": "\nCreate a v1 variable structure along with associated var array.\n\nNotes\n-----\nCommand syntax:\n pipe var_v1_create {v1_name} {n_var_min} {n_var_max}\n\n{n_var_min} and {n_var_max} are the lower and upper bounds of the var\nExample:\n pipe var_v1_create quad_k1 0 45\nThis example creates a v1 var structure called \"quad_k1\" with an associated\nvariable array that has the range [0, 45].\n\nUse the \"set variable\" command to set a created variable parameters.\nIn particular, to slave a lattice parameter to a variable use the command:\n set {v1_name}|ele_name = {lat_param}\nwhere {lat_param} is of the form {ix_uni}@{ele_name_or_location}{param_name}]\nExamples:\n set quad_k1[2]|ele_name = 2@q01w[k1]\n set quad_k1[2]|ele_name = 2@0>>10[k1]\nNote: When setting multiple variable parameters, \n temporarily toggle s%global%lattice_calc_on to False\n (\"set global lattice_calc_on = F\") to prevent Tao trying to evaluate the \npartially created variable and generating unwanted error messages.\n\nParameters\n----------\nv1_name\nn_var_min\nn_var_max\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n v1_name: quad_k1 \n n_var_min: 0 \n n_var_max: 45 \n", "command_str": "pipe var_v1_create {v1_name} {n_var_min} {n_var_max}", "parameters": ["v1_name", "n_var_min", "n_var_max"]}, "var_v1_destroy": {"description": "\nDestroy a v1 var structure along with associated var sub-array.\n\nNotes\n-----\nCommand syntax:\n pipe var_v1_destroy {v1_datum}\n\nParameters\n----------\nv1_datum\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n v1_datum: quad_k1\n", "command_str": "pipe var_v1_destroy {v1_datum}", "parameters": ["v1_datum"]}, "wall3d_radius": {"description": "\nOutput vaccum chamber wall radius for given s-position and angle in (x,y) plane.\nThe radius is with respect to the local wall origin which may not be the (x,y) = (0,0) origin.\n\nNotes\n-----\nCommand syntax:\n pipe wall3d_radius {ix_uni}@{ix_branch} {s_position} {angle}\n\nWhere:\n {ix_uni} is a universe index. Defaults to s%global%default_universe.\n {ix_branch} is a lattice branch index. \n {s_position} is the s-position to evaluate at.\n {angle} is the angle to evaluate at.\n\nParameters\n----------\nix_uni : \"\"\nix_branch : \"\"\ns_position\nangle\n\nReturns\n-------\nstring_list\n\nExamples\n--------\n", "command_str": "pipe wall3d_radius {ix_uni}@{ix_branch} {s_position} {angle}", "parameters": ["ix_uni", "ix_branch", "s_position", "angle"]}, "wave": {"description": "\nOutput Wave analysis info.\n\nNotes\n-----\nCommand syntax:\n pipe wave {who}\n\nWhere {who} is one of:\n params\n loc_header\n locations\n plot1, plot2, plot3\n\nParameters\n----------\nwho\n\nReturns\n-------\nstring_list\n\nExamples\n--------\nExample: 1\n init: -init $ACC_ROOT_DIR/regression_tests/pipe_test/cesr/tao.init\n args:\n who: params\n", "command_str": "pipe wave {who}", "parameters": ["who"]}} \ No newline at end of file diff --git a/tao/doc/pipe-interface-commands.tex b/tao/doc/pipe-interface-commands.tex index a34570fc3c..82ea065b81 100644 --- a/tao/doc/pipe-interface-commands.tex +++ b/tao/doc/pipe-interface-commands.tex @@ -1319,9 +1319,9 @@ \subsection{pipe lat_list} 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. + ele.XXX ! Where XXX is a Bmad syntax element attribute. (EG: ele.beta_a, ele.k1, etc.) {elements} is a string to match element names to. Use "*" to match to all elements. From 91d09be250cc04c413f214aaa49b4793181d410e Mon Sep 17 00:00:00 2001 From: David Sagan Date: Fri, 7 Feb 2025 11:38:34 -0500 Subject: [PATCH 2/2] Tao version update. --- tao/version/tao_version_mod.f90 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tao/version/tao_version_mod.f90 b/tao/version/tao_version_mod.f90 index d2e907cc0a..d0502d7b99 100644 --- a/tao/version/tao_version_mod.f90 +++ b/tao/version/tao_version_mod.f90 @@ -6,5 +6,5 @@ !- module tao_version_mod -character(*), parameter :: tao_version_date = "2025/02/04 17:43:02" +character(*), parameter :: tao_version_date = "2025/02/07 11:38:25" end module