Welcome to flame-gui's official user documentation! Use the quick index below to help find the things that may interest you.

Index

Getting Started

• Preparing a .lat and data file
• Inserting, editing, and removing model elements
• Graphing elements
• Configuring initial beam state
• Optimizing model
• Viewing model element phase space

General

• Canvas
  • How To Use
• Canvas Toolbar
  • Actions
• Element View
  • Expanding Elements
  • Insert, Edit, and Remove Elements
• Element Configuration Window
  • Inserting Elements
  • Editing Elements
• Optimization Window
  • Optimization Methods
  • How To Use
• Initial Beam State Window
  • How To Use
• Parameter Tree
  • How To Use
• Phase Space Window
  • How To Use
• Select Element Window
  • How To Use

---

Documentation

Canvas

Displays the graph of the figure model.

How To Use

• Click & drag the legend to move it
• Add/Remove lines using the Parameter Tree
• Advanced control using the Canvas Toolbar

  Default Colors

• #d62728
• #1f77b4
• #2ca02c
• #ff7f0e

Canvas Toolbar

Advanced controls/commands for the Canvas.

Actions

• Home – Reset to original view
• Back – Back to previous view
• Forward – Forward to next view
• Pan – Pan throughout plot
• Zoom – Zoom into plot
• Configure plot – Manually configure borders/spacings
• Select Line Color – Manually change the color of a line
• Save – Save a screenshot of the canvas

Color Dialog

Accessed from the Select Line Color action within the Canvas Toolbar

Helps you select a line color for the Canvas.

Element View

Expanding Elements

By pressing the ▶ button found within the index column, the element belonging to that index will be expand – bringing into the rest of its attributes into view.

Insert, Edit, and Remove Elements

By right-clicking the Element View, you will be presented with three options:

1. Insert Element
2. Edit Selected Element
3. Remove Element

Element Config Window

Accessed by right-clicking the Element View.

Used for inserting new and editing current elements.

Inserting Elements

After selecting Insert Element from Element View’s right-click menu, you will be find an element’s blank template. The element that you create here will be inserted at your selected index. Choose from each element type and required attributes and default values (such as the phi’s value) will be filled automatically.

Editing Elements

After choosing Edit Selected Element from Element View’s right-click menu, the element will be opened – making its attributes and their associated values available for edit. Note: element index, name, and type are unavailable for change.

Initial Beam State Window

Accessed from Edit on the menubar.

Set values for the initial beam state using this window.

How To Use

• Set any values
• Restore previous values using Reset
• Apply

Optimization Window

Accessed from Edit on the menubar.

Optimize the model using selected knobs and target location.

Optimization Methods

• Nelder-Mead
• Differential Evolution

How To Use

1. Select Elements
2. Set x0 values
3. Set Target Value and Weight (in relation to other parameters)
4. Optimize

Parameter Tree

Used for selecting which parameters to graph (limited to four). After startup, the Parameter Tree will be completely collapsed.

How To Use

• To expand a category: use the ▶ button
• To collapse a category: use the ▼ button
• To select a parameter to graph: use the ☐ button
• To remove a parameter from the graph: use the ☑ button

Phase Space Window

Accessed from View on the menubar.

View the phase space plot for an element.

How To Use

• To select an element: use the box in the top-left
• To filter the selectable elements: use the box in the top-right

Select Element Window

Accessed from the Optimization Window

Choose the knobs and target location for optimization.

How To Use

1. Filter elements by type or name (optional)
2. Choose from beamstate/model elements any number of knobs and a target. This target must be at or beyond all knobs, otherwise your selection will be rejected and a pop-up will inform you of your error.
3. Confirm