.. This file content is autogenerated from ``xtrack.environment.Environment.__doc_groups__``. Members - short description -------------------------- .. raw:: html .. _line-api-editing-inspection-variables-and-configuration-summary: .. list-table:: :ref:`Editing, Inspection, Variables and Configuration ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`eval(...) ` - Get the value of an expression * - :ref:`extend_knl_ksl(...) ` - Extend the order of the knl and ksl attributes of the elements. * - :ref:`extend_knl_rel_ksl_rel(...) ` - Extend the order of the rel_knl and rel_ksl attributes of the elements. * - :ref:`get(...) ` - Get an element or the value of a variable. * - :ref:`get_expr(...) ` - Get expression associated to a variable * - :ref:`import_line(...) ` - Import a line into this environment. * - :ref:`info(...) ` - Get information about an element or a variable. * - :ref:`new(...) ` - Create a new element or line. * - :ref:`new_expr(...) ` - Create a new expression * - :ref:`new_line(...) ` - Create a new line. * - :ref:`place(...) ` - Create a place object. * - :ref:`remove(...) ` - Remove an element, particle, line, or variable by name. * - :ref:`replace_replica(...) ` - Replace a replica element with a clone of its parent element. Expressions on element attributes are preserved. * - :ref:`set(...) ` - Set the values or expressions of variables or element properties. A single call can set one or multiple variables or elements. * - :ref:`element_dict ` - Dictionary-like container of elements in the environment. * - :ref:`element_refs ` - Dictionary-like container of xdeps element references. * - :ref:`elements ` - Container of environment elements; item access returns ``View`` objects. * - :ref:`functions ` - xdeps function container used in expressions. * - :ref:`line_names ` - List of names of all lines currently in the environment. * - :ref:`lines ` - Container of named lines registered in this environment. * - :ref:`metadata ` - User metadata associated with the environment. * - :ref:`ref ` - xdeps reference container for variables, elements and particles. * - :ref:`ref_manager ` - xdeps dependency manager for variables, element references, and expressions. * - :ref:`vars ` - Variables container associated with the environment. * - :ref:`xcoll ` - Xcoll-specific helpers associated with this environment. * - :ref:`xfields ` - Xfields-specific helpers associated with this environment. .. _line-api-reference-particle-and-particle-generation-summary: .. list-table:: :ref:`Reference Particle and Particle Generation ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`new_particle(...) ` - Associate a particle type to a name. The particle is stored in Environment.particles, its properties can be controlled with deferred expressions and it can be used as reference particle for lines. * - :ref:`set_particle_ref(...) ` - Set the environment reference particle and optionally propagate it to lines. * - :ref:`particle_ref ` - Reference particle accessor, or ``None`` if not configured. * - :ref:`particles ` - Container of named particles; item access returns ``View`` objects. .. _line-api-analysis-and-matching-summary: .. list-table:: :ref:`Analysis and Matching ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`match(...) ` - Change a set of knobs in the beam lines in order to match assigned targets. * - :ref:`match_knob(...) ` - Match a new knob in the beam line such that the specified targets are matched when the knob is set to the value `knob_value_end` and the state of the line before tha matching is recovered when the knob is set to the value `knob_value_start`. * - :ref:`twiss(...) ` - Compute the twiss parameters for the lines. .. _line-api-tracker-setup-summary: .. list-table:: :ref:`Tracker Setup ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`build_trackers(...) ` - Build the trackers for the lines. * - :ref:`discard_trackers(...) ` - Discard all trackers in all lines of the environment. .. _line-api-constructors-and-serialization-summary: .. list-table:: :ref:`Constructors and Serialization ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`call(...) ` - Call a file with xtrack commands. * - :ref:`copy(...) ` - Create a deep copy of the environment. * - :ref:`from_dict(...) ` - Rebuild an environment from a serialized dictionary. * - :ref:`from_json(...) ` - Constructs an environment from a JSON file. * - :ref:`to_dict(...) ` - Serialize the environment to a JSON-compatible dictionary. * - :ref:`to_json(...) ` - Save the environment to a json file. .. _line-api-deprecated-summary: .. list-table:: :ref:`Deprecated ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`from_madx(...) ` - Load a multiline from a MAD-X file. * - :ref:`new_builder(...) ` - Deprecated. Create a new composer. * - :ref:`set_multipolar_errors(...) ` - Deprecated: set multipolar errors for specified elements of the environment. * - :ref:`varval ` - Convenience accessor to variable values. * - :ref:`vv ` - Short alias for variable values. .. _line-api-upcoming-deprecations-summary: .. list-table:: :ref:`Upcoming deprecations ` :class: line-api-summary-table :header-rows: 1 :width: 100% :widths: 40 60 * - Member - Description * - :ref:`apply_filling_pattern(...) ` - Deprecated alias for ``env.xfields.apply_filling_pattern(...)``. * - :ref:`configure_beambeam_interactions(...) ` - Deprecated alias for ``env.xfields.configure_beambeam_interactions(...)``. * - :ref:`install_beambeam_interactions(...) ` - Deprecated alias for ``env.xfields.install_beambeam_interactions(...)``. Members - full description -------------------------- .. _line-api-editing-inspection-variables-and-configuration: Editing, Inspection, Variables and Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-editing-inspection-variables-and-configuration-methods: .. _line-api-editing-inspection-variables-and-configuration-method-eval: .. automethod:: xtrack.environment.Environment.eval .. _line-api-editing-inspection-variables-and-configuration-method-extend-knl-ksl: .. automethod:: xtrack.environment.Environment.extend_knl_ksl .. _line-api-editing-inspection-variables-and-configuration-method-extend-knl-rel-ksl-rel: .. automethod:: xtrack.environment.Environment.extend_knl_rel_ksl_rel .. _line-api-editing-inspection-variables-and-configuration-method-get: .. automethod:: xtrack.environment.Environment.get .. _line-api-editing-inspection-variables-and-configuration-method-get-expr: .. automethod:: xtrack.environment.Environment.get_expr .. _line-api-editing-inspection-variables-and-configuration-method-import-line: .. automethod:: xtrack.environment.Environment.import_line .. _line-api-editing-inspection-variables-and-configuration-method-info: .. automethod:: xtrack.environment.Environment.info .. _line-api-editing-inspection-variables-and-configuration-method-new: .. automethod:: xtrack.environment.Environment.new .. _line-api-editing-inspection-variables-and-configuration-method-new-expr: .. automethod:: xtrack.environment.Environment.new_expr .. _line-api-editing-inspection-variables-and-configuration-method-new-line: .. automethod:: xtrack.environment.Environment.new_line .. _line-api-editing-inspection-variables-and-configuration-method-place: .. automethod:: xtrack.environment.Environment.place .. _line-api-editing-inspection-variables-and-configuration-method-remove: .. automethod:: xtrack.environment.Environment.remove .. _line-api-editing-inspection-variables-and-configuration-method-replace-replica: .. automethod:: xtrack.environment.Environment.replace_replica .. _line-api-editing-inspection-variables-and-configuration-method-set: .. automethod:: xtrack.environment.Environment.set .. _line-api-editing-inspection-variables-and-configuration-properties: .. _line-api-editing-inspection-variables-and-configuration-property-element-dict: .. autoproperty:: xtrack.environment.Environment.element_dict .. _line-api-editing-inspection-variables-and-configuration-property-element-refs: .. autoproperty:: xtrack.environment.Environment.element_refs .. _line-api-editing-inspection-variables-and-configuration-property-elements: .. autoproperty:: xtrack.environment.Environment.elements .. _line-api-editing-inspection-variables-and-configuration-property-functions: .. autoproperty:: xtrack.environment.Environment.functions .. _line-api-editing-inspection-variables-and-configuration-property-line-names: .. autoproperty:: xtrack.environment.Environment.line_names .. _line-api-editing-inspection-variables-and-configuration-property-lines: .. autoproperty:: xtrack.environment.Environment.lines .. _line-api-editing-inspection-variables-and-configuration-property-metadata: .. autoproperty:: xtrack.environment.Environment.metadata .. _line-api-editing-inspection-variables-and-configuration-property-ref: .. autoproperty:: xtrack.environment.Environment.ref .. _line-api-editing-inspection-variables-and-configuration-property-ref-manager: .. autoproperty:: xtrack.environment.Environment.ref_manager .. _line-api-editing-inspection-variables-and-configuration-property-vars: .. autoproperty:: xtrack.environment.Environment.vars .. _line-api-editing-inspection-variables-and-configuration-property-xcoll: .. autoproperty:: xtrack.environment.Environment.xcoll .. _line-api-editing-inspection-variables-and-configuration-property-xfields: .. autoproperty:: xtrack.environment.Environment.xfields .. _line-api-reference-particle-and-particle-generation: Reference Particle and Particle Generation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-reference-particle-and-particle-generation-methods: .. _line-api-reference-particle-and-particle-generation-method-new-particle: .. automethod:: xtrack.environment.Environment.new_particle .. _line-api-reference-particle-and-particle-generation-method-set-particle-ref: .. automethod:: xtrack.environment.Environment.set_particle_ref .. _line-api-reference-particle-and-particle-generation-properties: .. _line-api-reference-particle-and-particle-generation-property-particle-ref: .. autoproperty:: xtrack.environment.Environment.particle_ref .. _line-api-reference-particle-and-particle-generation-property-particles: .. autoproperty:: xtrack.environment.Environment.particles .. _line-api-analysis-and-matching: Analysis and Matching ~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-analysis-and-matching-methods: .. _line-api-analysis-and-matching-method-match: .. automethod:: xtrack.environment.Environment.match .. _line-api-analysis-and-matching-method-match-knob: .. automethod:: xtrack.environment.Environment.match_knob .. _line-api-analysis-and-matching-method-twiss: .. automethod:: xtrack.environment.Environment.twiss .. _line-api-tracker-setup: Tracker Setup ~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-tracker-setup-methods: .. _line-api-tracker-setup-method-build-trackers: .. automethod:: xtrack.environment.Environment.build_trackers .. _line-api-tracker-setup-method-discard-trackers: .. automethod:: xtrack.environment.Environment.discard_trackers .. _line-api-constructors-and-serialization: Constructors and Serialization ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-constructors-and-serialization-methods: .. _line-api-constructors-and-serialization-method-call: .. automethod:: xtrack.environment.Environment.call .. _line-api-constructors-and-serialization-method-copy: .. automethod:: xtrack.environment.Environment.copy .. _line-api-constructors-and-serialization-method-from-dict: .. automethod:: xtrack.environment.Environment.from_dict .. _line-api-constructors-and-serialization-method-from-json: .. automethod:: xtrack.environment.Environment.from_json .. _line-api-constructors-and-serialization-method-to-dict: .. automethod:: xtrack.environment.Environment.to_dict .. _line-api-constructors-and-serialization-method-to-json: .. automethod:: xtrack.environment.Environment.to_json .. _line-api-deprecated: Deprecated ~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-deprecated-methods: .. _line-api-deprecated-method-from-madx: .. automethod:: xtrack.environment.Environment.from_madx .. _line-api-deprecated-method-new-builder: .. automethod:: xtrack.environment.Environment.new_builder .. _line-api-deprecated-method-set-multipolar-errors: .. automethod:: xtrack.environment.Environment.set_multipolar_errors .. _line-api-deprecated-properties: .. _line-api-deprecated-property-varval: .. autoproperty:: xtrack.environment.Environment.varval .. _line-api-deprecated-property-vv: .. autoproperty:: xtrack.environment.Environment.vv .. _line-api-upcoming-deprecations: Upcoming deprecations ~~~~~~~~~~~~~~~~~~~~~ Go to :ref:`Summary table ` .. _line-api-upcoming-deprecations-methods: .. _line-api-upcoming-deprecations-method-apply-filling-pattern: .. automethod:: xtrack.environment.Environment.apply_filling_pattern .. _line-api-upcoming-deprecations-method-configure-beambeam-interactions: .. automethod:: xtrack.environment.Environment.configure_beambeam_interactions .. _line-api-upcoming-deprecations-method-install-beambeam-interactions: .. automethod:: xtrack.environment.Environment.install_beambeam_interactions