Basic structure

A FramAT model file is a simple text-based file, more specifically a JSON file. Essentially, JSON files are made up of keywords and data fields. Using this keyword-data structure arbitrarily complex object definitions can be generated. Notice that there is a very strict syntax. For instance, keywords must be delimited by quotation marks and brackets must always be closed. If the JSON syntax of any input file is invalid, FramAT will not be able to import the file. Notice also that all keywords and data entries are case-sensitive (e.g. true and false must be lower-case according to the JSON syntax).

Hint

You can also find example files in the Tutorials section.

Each FramAT model has different basic keys which make up the structure of the JSON file.

{
    "beamlines": [],
    "materialdata": [],
    "profildata": [],
    "acceleration": {},
    "boundary_conditions": {},
    "analysis": {},
    "postproc": {}
}

• beamlines The keyword beamlines is followed by a list of all individual beams descriptions.

  • Key beamlines

• materialdata Basic material properties which can be referred to from a beam definition.

  • Key materialdata

• profildata Basic profile properties which can be referred to from a beam definition.

  • Key profildata

• acceleration Definition of an accelerated state.

  • Key acceleration

• boundary_conditions Definition of single node constraints and beam connections.

  • Key boundary_conditions

• analysis The analysis to perform.

  • Key analysis

• postproc Definition of plots and files to save.

  • Key postproc