pleiades – Basic Functionality¶
Building Current Objects and Groups¶
pleiades.Current |
Represents an axisymmetric ring of toroidal current. |
pleiades.CurrentGroup |
Grouping of Current objects that have the same current value |
pleiades.Magnet |
Represent a Rectangular cross-section dipole magnet with axisymmetric surface currents. |
pleiades.MagnetGroup |
Represent a group of dipole magnets. |
pleiades.CurrentArray |
A rectangular current array |
pleiades.Component |
A Container for representing multiple sets of objects and assigning a Green’s function to the object. |
pleiades.Coil |
A component representing a single Coil |
pleiades.CoilPack |
A component representing a single CoilPack |
pleiades.ZSymmCoilSet |
A component representing a coil set that is symmetric about Z=0 |
pleiades.Configuration |
A container for a full configuration of magnets for an experiment |
Building Grids¶
pleiades.RectGrid |
|
pleiades.PointsListGrid |
Computing Green’s Functions for Flux and Magnetic Field¶
pleiades.compute_greens |
Compute Green’s functions for psi, BR, and BZ |
WIPPL Magnetic Configurations¶
pleiades.BRB |
|
pleiades.PCX_magCage |
Represent an array of dipole magnets that comprise the PCX magnet cage. |
pleiades.PCX_HH |
PCX Helmholtz coil set |
Computing Equilibria¶
pleiades.compute_equilibrium |
Compute jxB=gradP equilibrium for given P as function of R |
pleiades.mirror_equilibrium |
Compute jxB=gradP equilibrium for given P as function of psi/psi_lim given by P(psi) = p0*(1-(psi/psi_lim)**alpha1)**alpha2 |
IO Functionality¶
pleiades.write_eqdsk |