Sequence

class georges_core.sequences.Sequence(name: str = '', data=None, metadata: Optional[georges_core.sequences.sequence.SequenceMetadata] = None, element_keys: Optional[Mapping[str, str]] = None)[source]

Bases: object

Sequence.

Parameters
  • name – the name of the physics

  • data

  • metadata

  • element_keys

Attributes Summary

betablock

TODO

df

TODO

kinematics

Provides the kinematics data associated with the sequence metadata.

metadata

Provides the metadata associated with the sequence.

name

Provides the name of the sequence.

particle

Provides the particle type associated with the sequence metadata.

Methods Summary

apply(func[, axis])

param func

from_bdsim([filename, path])

TODO

from_madx_twiss([filename, path, columns, …])

TODO

from_survey()

TODO

from_transport([filename, path])

TODO

to_df([df, strip_units])

TODO

Attributes Documentation

betablock

TODO

df

TODO

kinematics

Provides the kinematics data associated with the sequence metadata.

metadata

Provides the metadata associated with the sequence.

name

Provides the name of the sequence.

particle

Provides the particle type associated with the sequence metadata.

Methods Documentation

apply(func, axis=0)[source]
Parameters
  • func

  • axis

Returns:

static from_bdsim(filename: str = 'output.root', path: str = '.')[source]

TODO

Returns:

static from_madx_twiss(filename: str = 'twiss.outx', path: str = '.', columns: Optional[List] = None, from_element: Optional[str] = None, to_element: Optional[str] = None) → georges_core.sequences.sequence.Sequence[source]

TODO

Parameters
  • filename – name of the Twiss table file

  • path – path to the Twiss table file

  • columns – the list of columns in the Twiss file

  • from_element

  • to_element

Returns:

Examples

TODO

static from_survey()[source]

TODO

Returns:

static from_transport(filename: str = 'transport.txt', path: str = '.')[source]

TODO

Parameters
  • filename

  • path

Returns:

to_df(df: Optional[pandas.core.frame.DataFrame] = None, strip_units: bool = False) → pandas.core.frame.DataFrame[source]

TODO