desc.examples.get

desc.examples.get(name, data=None)Source

Get example equilibria and data.

Returns a solved equilibrium or selected attributes for one of several examples.

A full list of valid names can be found with desc.examples.listall()

Parameters:

• name (str (case insensitive)) – Name of the example equilibrium to load from, should be one from desc.examples.listall().

• data ({None, "all", "boundary", "pressure", "iota", "current"}) – Data to return. None returns the final solved equilibrium. “all” returns the intermediate solutions from the continuation method as an EquilibriaFamily. “boundary” returns a representation for the last closed flux surface. “pressure”, “iota”, and “current” return the profile objects.

Returns:

data (varies) – Data requested, see “data” argument for more details.