gbspy.tutorial module
Provides a few simulations to start with GBSpy
- gbspy.tutorial.Sim(name)
Open a remote “tutorial” simulation
Provided an internet connection is available and the pooch package is installed, this function will download an example simulation and open it.
Available simulations include,
"double_null": An upper double null."snowflake": A low field side snowflake minus."tcv_neutrals": A half-size TCV simulation including neutrals.
All simulations also include a “full resolution” version, which can be downloaded by suffixing
"_highres"to each name. Note that these simulations may require significant disk space.- Parameters
name (str) – The name of the tutorial simulation you want to open.
- Returns
Simulation object of the downloaded data.
- Return type
See also