Input file documentation for qimpy.transport

QimPy uses the YAML format for input files. See below for a complete list of settings. Most settings have sensible defaults: start with the Tutorials to see the most commonly used settings and then use the following as a reference for more information on each setting.

Click on each setting to open a more detailed documentation, and also to link to the corresponding entry in the API Reference. In addition to settings listed below, the special keyword include can be used at any level to effectively load another YAML file into that level of the heirarchy.

geometry:                                                                                   # Geometry specification:
  vertices: [list of list of float,, or <class 'numpy.ndarray'> or <class 'torch.Tensor'>]  # Caretsian vertex coordinates (n_vertices x 2).
  edges: [list of list of int,, or <class 'numpy.ndarray'> or <class 'torch.Tensor'>]       # Indices of vertices in edges (n_edges x 4).
  quads: [list of list of int,, or <class 'numpy.ndarray'> or <class 'torch.Tensor'>]       # Indices of edges in each quad (n_quads x 4).
material:                                                                                   # Material specification:
  fname: [string]                                                                           # File name to load materials data from.
  rotation: ((1, 0, 0), (0, 1, 0, (0, 0, 1)))                                               # 3 x 3 rotation matrix from material to simulation frame.
checkpoint: null                                                                            # Checkpoint file to read at start-up.
checkpoint-out: null                                                                        # Checkpoint file to write.

Component classes: