Read and write data

twissed.read_dst(filename: str, charge: float | None = None, **kwargs) → Step[source]

Read dst file into a Step class. All information on the beam are computed.

Example

step = twissed.read_dst("treacewin.dst", charge = 100, inverse_x_and_y=True)

Todo

Check charge in pC. Check z distribution.

Parameters:

  • filename (str) – Path of the dst file.

  • charge (float, optional) – Overwrite the total charge to the given amount in pC.

  • **kwargs (List of properties) –

    • verbose (bool): Display information. Defaults to True.

    • inverse_x_and_y (bool): Inverse the x and y axis. Defaults to False.

Returns:

class containing beam information twissed.step().

Return type:

Step