apace 0.1.0 documentation

apace is yet another particle accelerator code designed for the optimization of beam optics. It is available as Python package and aims to provide a convenient and straightforward API to make use of Python’s numerous scientific libraries.

• Installation guide
  • Install from PyPI
  • Build from Source
• Quickstart
• User Guide
  • Element Classes
  • Lattice class
    • Creating a Double Dipole Achromat
    • Parent lattices
    • Direct children
    • Adding and Removing Objects
    • Load and Save Lattice Files
  • The Twiss class
  • The Tracking class
  • Lattice File Format
  • Implementation Details
    • Signals and Events
    • Lazy Evaluation
• Tutorials
• Command line tool
  • Installing the CLI
  • Getting Help
  • The twiss subcommand
• API Reference
  • Classes
  • Functions
  • Exceptions
  • Detailed Overview
  • Submodules
    • apace.plot
      • Module Contents
        • Classes
        • Functions
        • Attributes
          • FONT_SIZE
          • Color
            • RED
            • YELLOW
            • GREEN
            • BLUE
            • ORANGE
            • PURPLE
            • CYAN
            • WHITE
            • BLACK
            • LIGHT_GRAY
          • ELEMENT_COLOR
          • OPTICAL_FUNCTIONS
          • draw_elements
          • draw_sub_lattices
          • plot_twiss
          • _twiss_plot_section
          • TwissPlot
            • update
          • find_optimal_grid
          • floor_plan
    • Base
      • name
      • info
      • parent_lattices
      • length
      • __repr__
      • __str__
    • Element
      • attribute_changed
      • length
      • _on_attribute_changed
      • __repr__
      • __str__
    • Drift
      • attribute_changed
      • length
      • _on_attribute_changed
      • __repr__
      • __str__
    • Dipole
      • angle
      • e1
      • e2
      • radius
      • k0
      • length
      • _on_attribute_changed
      • __repr__
      • __str__
    • Quadrupole
      • k1
      • length
      • _on_attribute_changed
      • __repr__
      • __str__
    • Sextupole
      • k2
      • length
      • _on_attribute_changed
      • __repr__
      • __str__
    • Octupole
      • k3
      • length
      • _on_attribute_changed
      • __repr__
      • __str__
    • Lattice
      • length_changed
      • element_changed
      • n_elements
      • length
      • children
      • sequence
      • indices
      • objects
      • elements
      • sub_lattices
      • _init_properties
      • __getitem__
      • __del__
      • update_length
      • _on_length_changed
      • _on_element_changed
      • print_tree
      • as_file
      • as_dict
      • __repr__
      • __str__
    • MatrixMethod
      • energy
      • gamma
      • velocity
      • n_steps
      • element_indices
      • step_size
      • s
      • matrices
      • k0
      • k1
      • start_index
      • start_position
      • matrices_acc
      • _on_element_changed
      • update_n_steps
      • _on_n_steps_changed
      • update_element_indices
      • _on_element_indices_changed
      • update_step_size
      • _on_step_size_changed
      • update_s
      • _on_s_changed
      • update_matrices
      • update_matrices_acc
      • _on_matrices_accumulated_changed
    • Twiss
      • start_idx_changed
      • one_turn_matrix_changed
      • twiss_array_changed
      • psi_changed
      • tune_fractional_changed
      • start_idx
      • accumulated_array
      • one_turn_matrix
      • term_x
      • term_y
      • stable_x
      • stable_y
      • stable
      • initial_twiss
      • twiss_array
      • beta_x
      • beta_y
      • alpha_x
      • alpha_y
      • gamma_x
      • gamma_y
      • eta_x
      • eta_x_dds
      • psi_x
      • psi_y
      • tune_x
      • tune_y
      • tune_x_fractional
      • tune_y_fractional
      • chromaticity_x
      • chromaticity_y
      • curly_h
      • i1
      • i2
      • i3
      • i4
      • i5
      • alpha_c
      • gamma
      • emittance_x
      • energy
      • velocity
      • n_steps
      • element_indices
      • step_size
      • s
      • matrices
      • k0
      • k1
      • start_index
      • start_position
      • matrices_acc
      • update_one_turn_matrix
      • _on_one_turn_matrix_changed
      • update_twiss_array
      • _on_twiss_array_changed
      • update_betatron_phase
      • _on_psi_changed
      • update_fractional_tune
      • _on_tune_fractional_changed
      • update_chromaticity
      • _on_chromaticity_changed
      • _on_curly_h_changed
      • _on_i1_changed
      • _on_i2_changed
      • _on_i3_changed
      • _on_i4_changed
      • _on_i5_changed
      • _on_alpha_c_changed
      • _on_emittance_changed
      • _on_element_changed
      • update_n_steps
      • _on_n_steps_changed
      • update_element_indices
      • _on_element_indices_changed
      • update_step_size
      • _on_step_size_changed
      • update_s
      • _on_s_changed
      • update_matrices
      • update_matrices_acc
      • _on_matrices_accumulated_changed
    • TrackingMatrix
      • watch_points
      • initial_distribution
      • particle_trajectories
      • orbit_position
      • x
      • x_dds
      • y
      • y_dds
      • lon
      • delta
      • energy
      • gamma
      • velocity
      • n_steps
      • element_indices
      • step_size
      • s
      • matrices
      • k0
      • k1
      • start_index
      • start_position
      • matrices_acc
      • update_particle_trajectories
      • _on_particle_trajectories_changed
      • _on_element_changed
      • update_n_steps
      • _on_n_steps_changed
      • update_element_indices
      • _on_element_indices_changed
      • update_step_size
      • _on_step_size_changed
      • update_s
      • _on_s_changed
      • update_matrices
      • update_matrices_acc
      • _on_matrices_accumulated_changed
    • Signal
      • callbacks
      • __repr__
      • __call__
      • __str__
      • connect
    • distribution
    • AmbiguousNameError
      • __cause__
      • __context__
      • __suppress_context__
      • __traceback__
      • args
      • __delattr__
      • __dir__
      • __eq__
      • __format__
      • __ge__
      • __getattribute__
      • __gt__
      • __hash__
      • __le__
      • __lt__
      • __ne__
      • __reduce__
      • __reduce_ex__
      • __repr__
      • __setattr__
      • __setstate__
      • __sizeof__
      • __str__
      • __subclasshook__
      • with_traceback
    • UnstableLatticeError
      • __cause__
      • __context__
      • __suppress_context__
      • __traceback__
      • args
      • __delattr__
      • __dir__
      • __eq__
      • __format__
      • __ge__
      • __getattribute__
      • __gt__
      • __hash__
      • __le__
      • __lt__
      • __ne__
      • __reduce__
      • __reduce_ex__
      • __repr__
      • __setattr__
      • __setstate__
      • __sizeof__
      • __str__
      • __subclasshook__
      • with_traceback

• Index