fusionsc.hint.HintEquilibrium

class fusionsc.hint.HintEquilibrium(val=None, msgSize=1024, byReference=False)

Methods

__init__([val, msgSize, byReference])	Creates a new instance by either: - Allocating a new message of size msgSize (if val is None) - Storing a reference to the target (if byReference is set) - Copying the message from the given target (accepts Cap'n'proto messages, YAML strings, lists, dicts, and NumPy arrays)
asField()	Extracts a magnetic configuration from the equilibrium
cache(filename)	Note Has asynchronous variant '.asnc(...)' that returns Promise[...]
graph(**kwargs)	Visualizes the contents in a graph structure.
load()	Loads an instance of this class from a previously written archive file.
ptree()	Prints a tree version of this object.
save(filename)	Saves the object into an archive file (including all referenced data)
toYaml([flow])	Prints the contents as block-structured YAML
upload()	Note Has asynchronous variant '.asnc(...)' that returns Promise[...]

Attributes

data	Underlying Cap'n'proto struct (usually a builder type).
type

Methods

HintEquilibrium.__init__(val=None, msgSize=1024, byReference=False)

Creates a new instance by either: - Allocating a new message of size msgSize (if val is None) - Storing a reference to the target (if byReference is set) - Copying the message from the given target (accepts Cap’n’proto messages,

YAML strings, lists, dicts, and NumPy arrays)

HintEquilibrium.asField()

Extracts a magnetic configuration from the equilibrium

HintEquilibrium.cache(filename) → Any

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]

HintEquilibrium.graph(**kwargs)

Visualizes the contents in a graph structure. Requires graphviz

HintEquilibrium.load() → Any

Loads an instance of this class from a previously written archive file.

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]

HintEquilibrium.ptree()

Prints a tree version of this object. Requires the printree library.

HintEquilibrium.save(filename) → Any

Saves the object into an archive file (including all referenced data)

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]

HintEquilibrium.toYaml(flow=False)

Prints the contents as block-structured YAML

HintEquilibrium.upload() → Any

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]