User Guide# User Guide Installation Prerequisites Install GVEC with pip Installing pre-releases Troubleshooting Getting GVEC with git Installing the python bindings manually Stages Increasing resolution Prescribing a toroidal current profile Theory The default approach Basic control Advanced control GVEC parameter list Initialization parameters Discretization parameters Boundary and axis parameters Profile parameters Minimizer parameters hmap parameters Visualization and output parameters Theory Continuous problem Coordinate maps A simple map: the torus The magnetic field The MHD energy functional First variation of the energy functional Discretization Boundary conditions in radial direction Approximation of the integrals An equation for lambda Solving the discrete equation Transformation to Boozer coordinates Computing \(|B|\) in Boozer coordinates Other choices for hmap Periodic Cylinder The knot Frenet-Serret frame of a closed curve Curve evaluation G-Frame: A generalized curve-following frame References Coordinate conventions GVEC coordinates Different conventions Geometric Quantities reciprocal basis vectors contravariant components of a vector \(\boldsymbol{Q}\) Jacobian determinant components of the metric tensor components of the second fundamental form (of the fluxsurfaces) Tutorials Getting Started Virtual Environments Installing GVEC On the tutorials Running Jupyter notebooks Elliptic Tokamak Setting up a GVEC run Problem setup Physics parameters Boundary shape Numerical setup Running GVEC Post-processing Evaluate the equilibrium state Visualize profiles Visualize poloidal plane pygvec command line interface Elliptic Stellarator Setting up the GVEC run Problem setup Running GVEC Post-processing Loading the state Evaluating equilibrium quantities Visualization Profiles Visualize axis quantities Plotting poloidal planes 3D visualization Exporting data for visualization Boozer transform Load previously computed state Boozer transform Visualization in Boozer angles Radial grid refinement via stages Add stages to parameter dictionary Run without stages Prescribe a current profile New parameters Running GVEC with prescribed toroidal current Understanding the diagnostics Visualize the result Summary Postprocessing Derived Quantities Computing integrals Boozer transform Field-aligned grid Available quantities for evaluation Interfaces CAS3D Usage Interface Coordinates field-periodic representation QUASR Other Interfaces VMEC
