simsopt
v0.6.1
Contents
Getting started
Requirements
Mandatory Packages
Optional Packages
Installation
From PyPi
From Source
From docker container
Post-Installation
Docker container
Requirements
Install From Docker Hub
Ways to use simsopt docker container
IPython Shell
Bash Shell
Jupyter notebook
Persistent containers
Concepts
Ways to use simsopt
Input files
Optimization
MPI Partitions and worker groups
Geometric Objects
Curves
Surfaces
Caching
Magnetic Field Classes
BiotSavart
ToroidalField
PoloidalField
ScalarPotentialRZMagneticField
CircularCoil
Dommaschk
Reiman
InterpolatedField
Particle Tracing
Defining optimization problems
Optimizable objects
Specifying functions that go into the objective function
Degrees of freedom (“dofs”)
Helpful functions
Fixing degrees of freedom
Dependencies
Derivatives
Testing
Python test suite
Longer examples
Continuous integration
Source code on GitHub
Publications
Contributing to Simsopt
Types of Contribution
Submit Feedback
Bug Reports
Fix Bugs
Implement New Features or Algorithms
Improve Documentation
Code development Workflow
Examples
Optimizing an equilibrium code
SPEC version
VMEC version
Optimizing for quasisymmetry
Fixed resolution
Dynamic resolution
Eliminating magnetic islands
API
simsopt package
Subpackages
simsopt._core package
Submodules
simsopt._core.derivative module
simsopt._core.dofs module
simsopt._core.graph_optimizable module
simsopt._core.optimizable module
simsopt._core.util module
Module contents
simsopt.field package
Submodules
simsopt.field.biotsavart module
simsopt.field.boozermagneticfield module
simsopt.field.coil module
simsopt.field.magneticfield module
simsopt.field.magneticfieldclasses module
simsopt.field.sampling module
simsopt.field.tracing module
Module contents
simsopt.geo package
Submodules
simsopt.geo.boozersurface module
simsopt.geo.config module
simsopt.geo.curve module
simsopt.geo.curvehelical module
simsopt.geo.curveobjectives module
simsopt.geo.curverzfourier module
simsopt.geo.curvexyzfourier module
simsopt.geo.jit module
simsopt.geo.plot module
simsopt.geo.qfmsurface module
simsopt.geo.surface module
simsopt.geo.surfacegarabedian module
simsopt.geo.surfacehenneberg module
simsopt.geo.surfaceobjectives module
simsopt.geo.surfacerzfourier module
simsopt.geo.surfacexyzfourier module
simsopt.geo.surfacexyztensorfourier module
Module contents
simsopt.mhd package
Submodules
simsopt.mhd.boozer module
simsopt.mhd.spec module
simsopt.mhd.vmec module
simsopt.mhd.vmec_diagnostics module
Module contents
simsopt.objectives package
Submodules
simsopt.objectives.fluxobjective module
simsopt.objectives.functions module
simsopt.objectives.graph_functions module
simsopt.objectives.graph_least_squares module
simsopt.objectives.least_squares module
Module contents
simsopt.solve package
Submodules
simsopt.solve.graph_mpi module
simsopt.solve.graph_serial module
simsopt.solve.mpi module
simsopt.solve.serial module
Module contents
simsopt.util package
Submodules
simsopt.util.constants module
simsopt.util.dev module
simsopt.util.logging module
simsopt.util.mpi module
simsopt.util.mpi_logger module
simsopt.util.types module
simsopt.util.zoo module
Module contents
Module contents
simsopt
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
_
__add__() (simsopt.field.magneticfield.MagneticField method)
__call__() (simsopt._core.derivative.Derivative method)
(simsopt.util.dev.SimsoptRequires method)
__eq__() (simsopt._core.graph_optimizable.Optimizable method)
__init__() (simsopt._core.graph_optimizable.DOFs method)
(simsopt._core.graph_optimizable.Optimizable method)
(simsopt.field.boozermagneticfield.InterpolatedBoozerField method)
(simsopt.field.magneticfieldclasses.InterpolatedField method)
(simsopt.geo.surface.SurfaceClassifier method)
(simsopt.mhd.boozer.Boozer method)
(simsopt.mhd.boozer.Quasisymmetry method)
(simsopt.objectives.functions.Affine method)
__mul__() (simsopt.field.magneticfield.MagneticField method)
__repr__() (simsopt.mhd.vmec.Vmec method)
__rmul__() (simsopt.field.magneticfield.MagneticField method)
_abc_impl (simsopt._core.graph_optimizable.Optimizable attribute)
(simsopt._core.util.WeakKeyDefaultDict attribute)
_add_child() (simsopt._core.graph_optimizable.Optimizable method)
_get_ancestors() (simsopt._core.graph_optimizable.Optimizable method)
_ids (simsopt._core.graph_optimizable.Optimizable attribute)
_make_names() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
_mpi_leaders_task() (in module simsopt.solve.mpi)
_mpi_workers_task() (in module simsopt.solve.graph_mpi)
(in module simsopt.solve.mpi)
_remove_child() (simsopt._core.graph_optimizable.Optimizable method)
_set_local_x() (simsopt._core.graph_optimizable.Optimizable method)
_set_new_x() (simsopt._core.graph_optimizable.Optimizable method)
_update_free_dof_size_indices() (simsopt._core.graph_optimizable.Optimizable method)
_update_full_dof_size_indices() (simsopt._core.graph_optimizable.Optimizable method)
_validate_mn() (simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
A
add_parent() (simsopt._core.graph_optimizable.Optimizable method)
add_return_fn() (simsopt._core.graph_optimizable.Optimizable method)
Adder (class in simsopt.objectives.functions)
(class in simsopt.objectives.graph_functions)
Affine (class in simsopt.objectives.functions)
(class in simsopt.objectives.graph_functions)
all_fixed() (simsopt._core.graph_optimizable.DOFs method)
(simsopt._core.optimizable.Optimizable method)
all_free() (simsopt._core.graph_optimizable.DOFs method)
allocate() (simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
any_fixed() (simsopt._core.graph_optimizable.DOFs method)
any_free() (simsopt._core.graph_optimizable.DOFs method)
append_parent() (simsopt._core.graph_optimizable.Optimizable method)
arclength_poloidal_angle() (simsopt.geo.surface.Surface method)
Area (class in simsopt.geo.surfaceobjectives)
area() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
area_volume() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
aspect() (simsopt.mhd.vmec.Vmec method)
aspect_ratio() (simsopt.geo.surface.Surface method)
B
B_and_dB_vjp() (simsopt.field.biotsavart.BiotSavart method)
B_cartesian() (in module simsopt.mhd.vmec_diagnostics)
B_vjp() (simsopt.field.biotsavart.BiotSavart method)
(simsopt.field.magneticfield.MagneticFieldSum method)
Beale (class in simsopt.objectives.functions)
(class in simsopt.objectives.graph_functions)
BiotSavart (class in simsopt.field.biotsavart)
Boozer (class in simsopt.mhd.boozer)
boozer_exact_constraints() (simsopt.geo.boozersurface.BoozerSurface method)
boozer_penalty_constraints() (simsopt.geo.boozersurface.BoozerSurface method)
boozer_surface_residual() (in module simsopt.geo.surfaceobjectives)
BoozerAnalytic (class in simsopt.field.boozermagneticfield)
BoozerMagneticField (class in simsopt.field.boozermagneticfield)
BoozerRadialInterpolant (class in simsopt.field.boozermagneticfield)
BoozerSurface (class in simsopt.geo.boozersurface)
boundary (simsopt.mhd.vmec.Vmec property)
bounds (simsopt._core.graph_optimizable.DOFs property)
(simsopt._core.graph_optimizable.Optimizable property)
C
change_resolution() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
ChebyshevInterpolationRule (class in simsopt.field.magneticfieldclasses)
CircularCoil (class in simsopt.field.magneticfieldclasses)
clear_cached_properties() (simsopt.field.boozermagneticfield.BoozerMagneticField method)
(simsopt.field.magneticfield.MagneticField method)
Coil (class in simsopt.field.coil)
CoilOptObjective (class in simsopt.objectives.fluxobjective)
coils_via_symmetries() (in module simsopt.field.coil)
compute() (simsopt.mhd.vmec_diagnostics.QuasisymmetryRatioResidual method)
compute_A() (simsopt.field.biotsavart.BiotSavart method)
compute_fieldlines() (in module simsopt.field.tracing)
compute_gc_radius() (in module simsopt.field.tracing)
compute_K() (simsopt.field.boozermagneticfield.BoozerRadialInterpolant method)
compute_poloidal_transits() (in module simsopt.field.tracing)
compute_resonances() (in module simsopt.field.tracing)
compute_toroidal_transits() (in module simsopt.field.tracing)
copy_numpy_dict() (in module simsopt._core.derivative)
create_equally_spaced_curves() (in module simsopt.geo.curve)
cross_section() (simsopt.geo.surface.Surface method)
Current (class in simsopt.field.coil)
Curve (class in simsopt.geo.curve)
curve_length_pure() (in module simsopt.geo.curveobjectives)
CurveHelical (class in simsopt.geo.curvehelical)
CurveLength (class in simsopt.geo.curveobjectives)
CurveRZFourier (class in simsopt.geo.curverzfourier)
curves_to_vtk() (in module simsopt.geo.curve)
CurveXYZFourier (class in simsopt.geo.curvexyzfourier)
D
d2B_by_dXdcoilcurrents() (simsopt.field.biotsavart.BiotSavart method)
d2J_by_dsurfacecoefficientsdsurfacecoefficients() (simsopt.geo.surfaceobjectives.Area method)
(simsopt.geo.surfaceobjectives.ToroidalFlux method)
(simsopt.geo.surfaceobjectives.Volume method)
d3B_by_dXdXdcoilcurrents() (simsopt.field.biotsavart.BiotSavart method)
darea() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
dB_by_dcoilcurrents() (simsopt.field.biotsavart.BiotSavart method)
Delta (simsopt.geo.surfacegarabedian.SurfaceGarabedian property)
deprecated() (in module simsopt.util.dev)
Derivative (class in simsopt._core.derivative)
derivative_dec() (in module simsopt._core.derivative)
df (simsopt.objectives.functions.Adder property)
(simsopt.objectives.functions.Identity property)
(simsopt.objectives.functions.TestObject1 property)
(simsopt.objectives.functions.TestObject2 property)
(simsopt.objectives.graph_functions.Adder property)
dfrenet_frame_by_dcoeff() (simsopt.geo.curve.Curve method)
dgamma_by_dcoeff_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
dgamma_by_dcoeff_vjp() (simsopt.geo.curve.Curve method)
(simsopt.geo.curve.RotatedCurve method)
dgamma_by_dcoeff_vjp_impl() (simsopt.geo.curve.JaxCurve method)
dgammadash_by_dcoeff_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadash_by_dcoeff_vjp() (simsopt.geo.curve.Curve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadash_by_dcoeff_vjp_impl() (simsopt.geo.curve.JaxCurve method)
dgammadashdash_by_dcoeff_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadashdash_by_dcoeff_vjp() (simsopt.geo.curve.Curve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadashdash_by_dcoeff_vjp_impl() (simsopt.geo.curve.JaxCurve method)
dgammadashdashdash_by_dcoeff_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadashdashdash_by_dcoeff_vjp() (simsopt.geo.curve.Curve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadashdashdash_by_dcoeff_vjp_impl() (simsopt.geo.curve.JaxCurve method)
dincremental_arclength_by_dcoeff_vjp() (simsopt.geo.curve.Curve method)
distance_pure() (in module simsopt.geo.curveobjectives)
dJ() (simsopt.geo.curveobjectives.CurveLength method)
(simsopt.geo.curveobjectives.LpCurveCurvature method)
(simsopt.geo.curveobjectives.LpCurveTorsion method)
(simsopt.geo.curveobjectives.MinimumDistance method)
(simsopt.mhd.vmec_diagnostics.IotaTargetMetric method)
(simsopt.mhd.vmec_diagnostics.IotaWeighted method)
(simsopt.mhd.vmec_diagnostics.WellWeighted method)
(simsopt.objectives.fluxobjective.CoilOptObjective method)
(simsopt.objectives.fluxobjective.SquaredFlux method)
(simsopt.objectives.functions.Adder method)
(simsopt.objectives.functions.Affine method)
(simsopt.objectives.functions.Identity method)
(simsopt.objectives.functions.TestObject1 method)
(simsopt.objectives.functions.TestObject2 method)
(simsopt.objectives.graph_functions.Adder method)
(simsopt.objectives.graph_functions.Affine method)
(simsopt.objectives.graph_functions.Identity method)
(simsopt.objectives.graph_functions.TestObject1 method)
(simsopt.objectives.graph_functions.TestObject2 method)
dJ_by_dsurfacecoefficients() (simsopt.geo.surfaceobjectives.Area method)
(simsopt.geo.surfaceobjectives.QfmResidual method)
(simsopt.geo.surfaceobjectives.ToroidalFlux method)
(simsopt.geo.surfaceobjectives.Volume method)
dkappa_by_dcoeff_impl() (simsopt.geo.curve.Curve method)
dkappa_by_dcoeff_vjp() (simsopt.geo.curve.Curve method)
(simsopt.geo.curve.JaxCurve method)
dkappadash_by_dcoeff() (simsopt.geo.curve.Curve method)
dof_names (simsopt._core.graph_optimizable.Optimizable property)
dof_size (simsopt._core.graph_optimizable.Optimizable property)
DofLengthMismatchError
DOFs (class in simsopt._core.graph_optimizable)
dofs_free_status (simsopt._core.graph_optimizable.Optimizable property)
Dommaschk (class in simsopt.field.magneticfieldclasses)
draw_uniform_on_curve() (in module simsopt.field.sampling)
draw_uniform_on_surface() (in module simsopt.field.sampling)
ds (simsopt.mhd.vmec.Vmec attribute)
dterm1 (simsopt.objectives.graph_functions.Rosenbrock property)
dterm1() (simsopt.objectives.functions.Rosenbrock method)
dterm1prop (simsopt.objectives.functions.Rosenbrock property)
dterm2 (simsopt.objectives.graph_functions.Rosenbrock property)
dterm2() (simsopt.objectives.functions.Rosenbrock method)
dterm2prop (simsopt.objectives.functions.Rosenbrock property)
dterms() (simsopt.objectives.functions.Rosenbrock method)
(simsopt.objectives.graph_functions.Rosenbrock method)
dtorsion_by_dcoeff_impl() (simsopt.geo.curve.Curve method)
dtorsion_by_dcoeff_vjp() (simsopt.geo.curve.Curve method)
(simsopt.geo.curve.JaxCurve method)
dvolume() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
E
evaluate() (simsopt.geo.surface.SurfaceClassifier method)
F
f (simsopt.objectives.functions.Adder property)
(simsopt.objectives.functions.Identity property)
(simsopt.objectives.functions.TestObject1 property)
(simsopt.objectives.functions.TestObject2 property)
f() (simsopt.objectives.functions.Rosenbrock method)
(simsopt.objectives.graph_functions.Affine method)
(simsopt.objectives.graph_functions.Identity method)
(simsopt.objectives.graph_functions.Rosenbrock method)
(simsopt.objectives.graph_functions.TestObject1 method)
(simsopt.objectives.graph_functions.TestObject2 method)
f_out() (simsopt.objectives.least_squares.LeastSquaresTerm method)
Failer (class in simsopt.objectives.functions)
(class in simsopt.objectives.graph_functions)
fd_jac_mpi() (in module simsopt.solve.mpi)
finite_difference_steps() (in module simsopt._core.util)
fix() (simsopt._core.graph_optimizable.DOFs method)
(simsopt._core.graph_optimizable.Optimizable method)
fix_all() (simsopt._core.graph_optimizable.DOFs method)
(simsopt._core.graph_optimizable.Optimizable method)
fix_matplotlib_3d() (in module simsopt.geo.plot)
fix_range() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
fixed_range() (simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
free_status (simsopt._core.graph_optimizable.DOFs property)
frenet_frame() (simsopt.geo.curve.Curve method)
from_focus() (simsopt.geo.surfacerzfourier.SurfaceRZFourier class method)
from_RZFourier() (simsopt.geo.surfacegarabedian.SurfaceGarabedian class method)
(simsopt.geo.surfacehenneberg.SurfaceHenneberg class method)
from_sigma() (simsopt.objectives.graph_least_squares.LeastSquaresProblem class method)
(simsopt.objectives.least_squares.LeastSquaresTerm class method)
(simsopt.objectives.LeastSquaresProblem class method)
from_tuples() (simsopt.objectives.graph_least_squares.LeastSquaresProblem class method)
(simsopt.objectives.LeastSquaresProblem class method)
from_vmec_input() (simsopt.geo.surfacerzfourier.SurfaceRZFourier class method)
from_wout() (simsopt.geo.surfacerzfourier.SurfaceRZFourier class method)
full_dof_names (simsopt._core.graph_optimizable.Optimizable property)
full_dof_size (simsopt._core.graph_optimizable.Optimizable property)
full_names (simsopt._core.graph_optimizable.DOFs property)
full_x (simsopt._core.graph_optimizable.DOFs property)
(simsopt._core.graph_optimizable.Optimizable property)
function_from_user() (in module simsopt._core.optimizable)
G
gamma_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
gamma_lin() (simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
gammadash1_impl() (simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
gammadash2_impl() (simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
gammadash_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
gammadashdash_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
gammadashdashdash_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
gc_to_fullorbit_initial_guesses() (in module simsopt.field.tracing)
get() (simsopt._core.graph_optimizable.DOFs method)
(simsopt._core.graph_optimizable.Optimizable method)
(simsopt._core.optimizable.Optimizable method)
get_Delta() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
get_dofs() (simsopt._core.optimizable.Optimizable method)
(simsopt._core.optimizable.Target method)
(simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.curvehelical.CurveHelical method)
(simsopt.geo.curverzfourier.CurveRZFourier method)
(simsopt.geo.curvexyzfourier.CurveXYZFourier method)
(simsopt.geo.curvexyzfourier.JaxCurveXYZFourier method)
(simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
(simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
(simsopt.geo.surfacexyzfourier.SurfaceXYZFourier method)
(simsopt.geo.surfacexyztensorfourier.SurfaceXYZTensorFourier method)
(simsopt.mhd.vmec.Vmec method)
(simsopt.objectives.functions.Adder method)
(simsopt.objectives.functions.Affine method)
(simsopt.objectives.functions.Beale method)
(simsopt.objectives.functions.Failer method)
(simsopt.objectives.functions.Identity method)
(simsopt.objectives.functions.Rosenbrock method)
(simsopt.objectives.functions.TestObject1 method)
(simsopt.objectives.functions.TestObject2 method)
(simsopt.objectives.graph_functions.Failer method)
get_fixed() (simsopt._core.optimizable.Optimizable method)
get_max_mn() (simsopt.mhd.vmec.Vmec method)
get_ncsx_data() (in module simsopt.util.zoo)
get_owners() (in module simsopt._core.dofs)
get_parent_return_fns_list() (simsopt._core.graph_optimizable.Optimizable method)
get_quadpoints() (simsopt.geo.surface.Surface method)
get_rc() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
get_return_fn_list() (simsopt._core.graph_optimizable.Optimizable method)
get_return_fn_names() (simsopt._core.graph_optimizable.Optimizable method)
get_return_fns() (simsopt._core.graph_optimizable.Optimizable method)
get_rhomn() (simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
get_rs() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
get_stellsym_mask() (simsopt.geo.surfacexyztensorfourier.SurfaceXYZTensorFourier method)
get_zc() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
get_zs() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
I
id (simsopt._core.util.ImmutableId attribute)
Identity (class in simsopt.objectives.functions)
(class in simsopt.objectives.graph_functions)
ImmutableId (class in simsopt._core.util)
incremental_arclength_pure() (in module simsopt.geo.curve)
incremental_arclength_vjp() (in module simsopt.geo.curve)
index() (simsopt._core.optimizable.Optimizable method)
init_splines() (simsopt.field.boozermagneticfield.BoozerRadialInterpolant method)
initialize_logging() (in module simsopt.util.logging)
InstanceCounterMeta (class in simsopt._core.util)
interpolate_on_arclength_grid() (simsopt.geo.surface.Surface method)
InterpolatedBoozerField (class in simsopt.field.boozermagneticfield)
InterpolatedField (class in simsopt.field.magneticfieldclasses)
invalidate_cache() (simsopt.geo.surfaceobjectives.QfmResidual method)
(simsopt.geo.surfaceobjectives.ToroidalFlux method)
iota_axis() (simsopt.mhd.vmec.Vmec method)
iota_edge() (simsopt.mhd.vmec.Vmec method)
IotaTargetMetric (class in simsopt.mhd.vmec_diagnostics)
IotaWeighted (class in simsopt.mhd.vmec_diagnostics)
is_fixed() (simsopt._core.graph_optimizable.Optimizable method)
is_free() (simsopt._core.graph_optimizable.DOFs method)
(simsopt._core.graph_optimizable.Optimizable method)
isbool() (in module simsopt._core.util)
isnumber() (in module simsopt._core.util)
iter (simsopt.mhd.vmec.Vmec attribute)
IterationStoppingCriterion (class in simsopt.field.tracing)
J
J() (simsopt._core.optimizable.Target method)
(simsopt.geo.curveobjectives.CurveLength method)
(simsopt.geo.curveobjectives.LpCurveCurvature method)
(simsopt.geo.curveobjectives.LpCurveTorsion method)
(simsopt.geo.curveobjectives.MinimumDistance method)
(simsopt.geo.surfaceobjectives.Area method)
(simsopt.geo.surfaceobjectives.QfmResidual method)
(simsopt.geo.surfaceobjectives.ToroidalFlux method)
(simsopt.geo.surfaceobjectives.Volume method)
(simsopt.mhd.boozer.Quasisymmetry method)
(simsopt.mhd.spec.Residue method)
(simsopt.mhd.vmec_diagnostics.IotaTargetMetric method)
(simsopt.mhd.vmec_diagnostics.IotaWeighted method)
(simsopt.mhd.vmec_diagnostics.WellWeighted method)
(simsopt.objectives.fluxobjective.CoilOptObjective method)
(simsopt.objectives.fluxobjective.SquaredFlux method)
(simsopt.objectives.functions.Adder method)
(simsopt.objectives.functions.Affine method)
(simsopt.objectives.functions.Beale method)
(simsopt.objectives.functions.Failer method)
(simsopt.objectives.functions.Identity method)
(simsopt.objectives.functions.TestObject1 method)
(simsopt.objectives.functions.TestObject2 method)
(simsopt.objectives.graph_functions.Beale method)
(simsopt.objectives.graph_functions.Failer method)
JaxCurve (class in simsopt.geo.curve)
JaxCurveXYZFourier (class in simsopt.geo.curvexyzfourier)
jaxfouriercurve_pure() (in module simsopt.geo.curvexyzfourier)
jaxHelicalfouriercurve_pure() (in module simsopt.geo.curvehelical)
jit() (in module simsopt.geo.jit)
K
kappa_impl() (simsopt.geo.curve.Curve method)
kappa_pure() (in module simsopt.geo.curve)
kappadash() (simsopt.geo.curve.Curve method)
kappagrad0() (in module simsopt.geo.curve)
kappagrad1() (in module simsopt.geo.curve)
kappavjp0() (in module simsopt.geo.curve)
kappavjp1() (in module simsopt.geo.curve)
L
least_squares_mpi_solve() (in module simsopt.solve.graph_mpi)
(in module simsopt.solve.mpi)
least_squares_serial_solve() (in module simsopt.solve)
(in module simsopt.solve.graph_serial)
(in module simsopt.solve.serial)
LeastSquaresProblem (class in simsopt.objectives)
(class in simsopt.objectives.graph_least_squares)
LeastSquaresTerm (class in simsopt.objectives.least_squares)
LevelsetStoppingCriterion (class in simsopt.field.tracing)
load_curves_from_file() (simsopt.geo.curvexyzfourier.CurveXYZFourier static method)
load_wout() (simsopt.mhd.vmec.Vmec method)
local_bounds (simsopt._core.graph_optimizable.Optimizable property)
local_dof_names (simsopt._core.graph_optimizable.Optimizable property)
local_dof_size (simsopt._core.graph_optimizable.Optimizable property)
local_dofs_free_status (simsopt._core.graph_optimizable.Optimizable property)
local_full_dof_names (simsopt._core.graph_optimizable.Optimizable property)
local_full_dof_size (simsopt._core.graph_optimizable.Optimizable property)
local_full_x (simsopt._core.graph_optimizable.Optimizable property)
local_lower_bounds (simsopt._core.graph_optimizable.Optimizable property)
local_upper_bounds (simsopt._core.graph_optimizable.Optimizable property)
local_x (simsopt._core.graph_optimizable.Optimizable property)
log() (in module simsopt.util.mpi)
lower_bounds (simsopt._core.graph_optimizable.DOFs property)
(simsopt._core.graph_optimizable.Optimizable property)
Lp_curvature_pure() (in module simsopt.geo.curveobjectives)
Lp_torsion_pure() (in module simsopt.geo.curveobjectives)
LpCurveCurvature (class in simsopt.geo.curveobjectives)
LpCurveTorsion (class in simsopt.geo.curveobjectives)
M
MagneticField (class in simsopt.field.magneticfield)
MagneticFieldMultiply (class in simsopt.field.magneticfield)
MagneticFieldSum (class in simsopt.field.magneticfield)
make_optimizable() (in module simsopt._core.graph_optimizable)
(in module simsopt._core.optimizable)
MaxToroidalFluxStoppingCriterion (class in simsopt.field.tracing)
mean_iota() (simsopt.mhd.vmec.Vmec method)
mean_shear() (simsopt.mhd.vmec.Vmec method)
minimize_boozer_exact_constraints_newton() (simsopt.geo.boozersurface.BoozerSurface method)
minimize_boozer_penalty_constraints_LBFGS() (simsopt.geo.boozersurface.BoozerSurface method)
minimize_boozer_penalty_constraints_ls() (simsopt.geo.boozersurface.BoozerSurface method)
minimize_boozer_penalty_constraints_newton() (simsopt.geo.boozersurface.BoozerSurface method)
minimize_qfm() (simsopt.geo.qfmsurface.QfmSurface method)
minimize_qfm_exact_constraints_SLSQP() (simsopt.geo.qfmsurface.QfmSurface method)
minimize_qfm_penalty_constraints_LBFGS() (simsopt.geo.qfmsurface.QfmSurface method)
MinimumDistance (class in simsopt.geo.curveobjectives)
MinToroidalFluxStoppingCriterion (class in simsopt.field.tracing)
module
simsopt
simsopt._core
simsopt._core.derivative
simsopt._core.dofs
simsopt._core.graph_optimizable
simsopt._core.optimizable
simsopt._core.util
simsopt.field
simsopt.field.biotsavart
simsopt.field.boozermagneticfield
simsopt.field.coil
simsopt.field.magneticfield
simsopt.field.magneticfieldclasses
simsopt.field.sampling
simsopt.field.tracing
simsopt.geo
simsopt.geo.boozersurface
simsopt.geo.config
simsopt.geo.curve
simsopt.geo.curvehelical
simsopt.geo.curveobjectives
simsopt.geo.curverzfourier
simsopt.geo.curvexyzfourier
simsopt.geo.jit
simsopt.geo.plot
simsopt.geo.qfmsurface
simsopt.geo.surface
simsopt.geo.surfacegarabedian
simsopt.geo.surfacehenneberg
simsopt.geo.surfaceobjectives
simsopt.geo.surfacerzfourier
simsopt.geo.surfacexyzfourier
simsopt.geo.surfacexyztensorfourier
simsopt.mhd
simsopt.mhd.boozer
simsopt.mhd.spec
simsopt.mhd.vmec
simsopt.mhd.vmec_diagnostics
simsopt.objectives
simsopt.objectives.fluxobjective
simsopt.objectives.functions
simsopt.objectives.graph_functions
simsopt.objectives.graph_least_squares
simsopt.objectives.least_squares
simsopt.solve
simsopt.solve.graph_mpi
simsopt.solve.graph_serial
simsopt.solve.mpi
simsopt.solve.serial
simsopt.util
simsopt.util.constants
simsopt.util.dev
simsopt.util.logging
simsopt.util.mpi
simsopt.util.mpi_logger
simsopt.util.types
simsopt.util.zoo
N
names (simsopt._core.graph_optimizable.DOFs property)
nested_lists_to_array() (in module simsopt._core.util)
num_dofs() (simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.curvehelical.CurveHelical method)
(simsopt.geo.curvexyzfourier.JaxCurveXYZFourier method)
(simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
O
objective() (simsopt.objectives.graph_least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
ObjectiveFailure
Optimizable (class in simsopt._core.graph_optimizable)
(class in simsopt._core.optimizable)
OptimizableDefaultDict (class in simsopt._core.derivative)
OptimizableMeta (class in simsopt._core.util)
P
parallel_loop_bounds() (in module simsopt.field.tracing)
parameter_derivatives() (in module simsopt.geo.surfaceobjectives)
parent_return_fns_no (simsopt._core.graph_optimizable.Optimizable property)
particles_to_vtk() (in module simsopt.field.tracing)
plot() (simsopt.geo.curve.Curve method)
(simsopt.geo.surface.Surface method)
plot_poincare_data() (in module simsopt.field.tracing)
PoloidalField (class in simsopt.field.magneticfieldclasses)
pop_parent() (simsopt._core.graph_optimizable.Optimizable method)
profile() (simsopt.mhd.vmec_diagnostics.QuasisymmetryRatioResidual method)
Q
qfm_label_constraint() (simsopt.geo.qfmsurface.QfmSurface method)
qfm_objective() (simsopt.geo.qfmsurface.QfmSurface method)
qfm_penalty_constraints() (simsopt.geo.qfmsurface.QfmSurface method)
QfmResidual (class in simsopt.geo.surfaceobjectives)
QfmSurface (class in simsopt.geo.qfmsurface)
Quasisymmetry (class in simsopt.mhd.boozer)
QuasisymmetryRatioResidual (class in simsopt.mhd.vmec_diagnostics)
R
RANGE_FIELD_PERIOD (simsopt.geo.surface.Surface attribute)
RANGE_FULL_TORUS (simsopt.geo.surface.Surface attribute)
RANGE_HALF_PERIOD (simsopt.geo.surface.Surface attribute)
recompute_bell() (simsopt._core.graph_optimizable.Optimizable method)
(simsopt.field.boozermagneticfield.BoozerMagneticField method)
(simsopt.field.magneticfield.MagneticField method)
(simsopt.geo.curve.Curve method)
(simsopt.geo.curveobjectives.MinimumDistance method)
(simsopt.geo.surfaceobjectives.QfmResidual method)
(simsopt.geo.surfaceobjectives.ToroidalFlux method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
(simsopt.geo.surfacexyzfourier.SurfaceXYZFourier method)
(simsopt.geo.surfacexyztensorfourier.SurfaceXYZTensorFourier method)
(simsopt.mhd.boozer.Boozer method)
(simsopt.mhd.boozer.Quasisymmetry method)
(simsopt.mhd.spec.Residue method)
(simsopt.mhd.vmec.Vmec method)
reduced_len (simsopt._core.graph_optimizable.DOFs property)
register() (simsopt.mhd.boozer.Boozer method)
RegisterMeta (class in simsopt._core.util)
Reiman (class in simsopt.field.magneticfieldclasses)
remove_parent() (simsopt._core.graph_optimizable.Optimizable method)
residuals() (simsopt.mhd.vmec_diagnostics.QuasisymmetryRatioResidual method)
(simsopt.objectives.graph_least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
Residue (class in simsopt.mhd.spec)
return_fn_map (simsopt._core.graph_optimizable.Optimizable attribute)
(simsopt.geo.curveobjectives.CurveLength attribute)
(simsopt.geo.curveobjectives.LpCurveCurvature attribute)
(simsopt.geo.curveobjectives.LpCurveTorsion attribute)
(simsopt.geo.curveobjectives.MinimumDistance attribute)
(simsopt.geo.surfacegarabedian.SurfaceGarabedian attribute)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier attribute)
(simsopt.geo.surfacexyzfourier.SurfaceXYZFourier attribute)
(simsopt.mhd.boozer.Quasisymmetry attribute)
(simsopt.mhd.vmec.Vmec attribute)
(simsopt.objectives.graph_functions.Adder attribute)
(simsopt.objectives.graph_functions.Affine attribute)
(simsopt.objectives.graph_functions.Identity attribute)
(simsopt.objectives.graph_functions.Rosenbrock attribute)
(simsopt.objectives.graph_functions.TestObject1 attribute)
(simsopt.objectives.graph_functions.TestObject2 attribute)
(simsopt.objectives.graph_least_squares.LeastSquaresProblem attribute)
(simsopt.objectives.LeastSquaresProblem attribute)
Rosenbrock (class in simsopt.objectives.functions)
(class in simsopt.objectives.graph_functions)
RosenbrockWithFailures (class in simsopt.objectives.functions)
RotatedCurve (class in simsopt.geo.curve)
run() (simsopt.mhd.boozer.Boozer method)
(simsopt.mhd.vmec.Vmec method)
S
s_full_grid (simsopt.mhd.vmec.Vmec attribute)
s_half_grid (simsopt.mhd.vmec.Vmec attribute)
ScalarPotentialRZMagneticField (class in simsopt.field.magneticfieldclasses)
ScaledCurrent (class in simsopt.field.coil)
serial_solve() (in module simsopt.solve)
(in module simsopt.solve.graph_serial)
(in module simsopt.solve.serial)
set() (simsopt._core.graph_optimizable.DOFs method)
(simsopt._core.graph_optimizable.Optimizable method)
(simsopt._core.optimizable.Optimizable method)
set_B0() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_Bbar() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_Delta() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
set_dofs() (simsopt._core.optimizable.Optimizable method)
(simsopt._core.optimizable.Target method)
(simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curverzfourier.CurveRZFourier method)
(simsopt.geo.curvexyzfourier.CurveXYZFourier method)
(simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
(simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
(simsopt.geo.surfacexyzfourier.SurfaceXYZFourier method)
(simsopt.geo.surfacexyztensorfourier.SurfaceXYZTensorFourier method)
(simsopt.mhd.vmec.Vmec method)
(simsopt.objectives.functions.Adder method)
(simsopt.objectives.functions.Affine method)
(simsopt.objectives.functions.Beale method)
(simsopt.objectives.functions.Failer method)
(simsopt.objectives.functions.Identity method)
(simsopt.objectives.functions.Rosenbrock method)
(simsopt.objectives.functions.TestObject1 method)
(simsopt.objectives.functions.TestObject2 method)
(simsopt.objectives.graph_functions.Failer method)
set_dofs_impl() (simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.curvehelical.CurveHelical method)
(simsopt.geo.curvexyzfourier.JaxCurveXYZFourier method)
(simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
set_etabar() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_fixed() (simsopt._core.optimizable.Optimizable method)
set_G0() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_G1() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_I0() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_I1() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_iota0() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_K1() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_N() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_psi0() (simsopt.field.boozermagneticfield.BoozerAnalytic method)
set_rc() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
set_rhomn() (simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
set_rs() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
set_zc() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
set_zs() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
shape_gradient() (simsopt.mhd.vmec_diagnostics.IotaTargetMetric method)
(simsopt.mhd.vmec_diagnostics.IotaWeighted method)
(simsopt.mhd.vmec_diagnostics.WellWeighted method)
signed_distance_from_surface() (in module simsopt.geo.surface)
simsopt
module
simsopt._core
module
simsopt._core.derivative
module
simsopt._core.dofs
module
simsopt._core.graph_optimizable
module
simsopt._core.optimizable
module
simsopt._core.util
module
simsopt.field
module
simsopt.field.biotsavart
module
simsopt.field.boozermagneticfield
module
simsopt.field.coil
module
simsopt.field.magneticfield
module
simsopt.field.magneticfieldclasses
module
simsopt.field.sampling
module
simsopt.field.tracing
module
simsopt.geo
module
simsopt.geo.boozersurface
module
simsopt.geo.config
module
simsopt.geo.curve
module
simsopt.geo.curvehelical
module
simsopt.geo.curveobjectives
module
simsopt.geo.curverzfourier
module
simsopt.geo.curvexyzfourier
module
simsopt.geo.jit
module
simsopt.geo.plot
module
simsopt.geo.qfmsurface
module
simsopt.geo.surface
module
simsopt.geo.surfacegarabedian
module
simsopt.geo.surfacehenneberg
module
simsopt.geo.surfaceobjectives
module
simsopt.geo.surfacerzfourier
module
simsopt.geo.surfacexyzfourier
module
simsopt.geo.surfacexyztensorfourier
module
simsopt.mhd
module
simsopt.mhd.boozer
module
simsopt.mhd.spec
module
simsopt.mhd.vmec
module
simsopt.mhd.vmec_diagnostics
module
simsopt.objectives
module
simsopt.objectives.fluxobjective
module
simsopt.objectives.functions
module
simsopt.objectives.graph_functions
module
simsopt.objectives.graph_least_squares
module
simsopt.objectives.least_squares
module
simsopt.solve
module
simsopt.solve.graph_mpi
module
simsopt.solve.graph_serial
module
simsopt.solve.mpi
module
simsopt.solve.serial
module
simsopt.util
module
simsopt.util.constants
module
simsopt.util.dev
module
simsopt.util.logging
module
simsopt.util.mpi
module
simsopt.util.mpi_logger
module
simsopt.util.types
module
simsopt.util.zoo
module
SimsoptRequires (class in simsopt.util.dev)
solve_residual_equation_exactly_newton() (simsopt.geo.boozersurface.BoozerSurface method)
SquaredFlux (class in simsopt.objectives.fluxobjective)
Struct (class in simsopt._core.util)
sum() (simsopt.objectives.graph_functions.Adder method)
Surface (class in simsopt.geo.surface)
SurfaceClassifier (class in simsopt.geo.surface)
SurfaceGarabedian (class in simsopt.geo.surfacegarabedian)
SurfaceHenneberg (class in simsopt.geo.surfacehenneberg)
SurfaceRZFourier (class in simsopt.geo.surfacerzfourier)
SurfaceXYZFourier (class in simsopt.geo.surfacexyzfourier)
SurfaceXYZTensorFourier (class in simsopt.geo.surfacexyztensorfourier)
T
Target (class in simsopt._core.optimizable)
term1 (simsopt.objectives.graph_functions.Rosenbrock property)
term1() (simsopt.objectives.functions.Rosenbrock method)
(simsopt.objectives.functions.RosenbrockWithFailures method)
term1prop (simsopt.objectives.functions.Rosenbrock property)
term2 (simsopt.objectives.graph_functions.Rosenbrock property)
term2() (simsopt.objectives.functions.Rosenbrock method)
term2prop (simsopt.objectives.functions.Rosenbrock property)
terms (simsopt.objectives.graph_functions.Rosenbrock property)
terms() (simsopt.objectives.functions.Rosenbrock method)
TestObject1 (class in simsopt.objectives.functions)
(class in simsopt.objectives.graph_functions)
TestObject2 (class in simsopt.objectives.functions)
(class in simsopt.objectives.graph_functions)
to_RZFourier() (simsopt.geo.surface.Surface method)
(simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
(simsopt.geo.surfacehenneberg.SurfaceHenneberg method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
(simsopt.geo.surfacexyzfourier.SurfaceXYZFourier method)
(simsopt.geo.surfacexyztensorfourier.SurfaceXYZTensorFourier method)
to_vtk() (simsopt.field.magneticfield.MagneticField method)
(simsopt.field.magneticfieldclasses.InterpolatedField method)
(simsopt.geo.surface.Surface method)
(simsopt.geo.surface.SurfaceClassifier method)
ToroidalField (class in simsopt.field.magneticfieldclasses)
ToroidalFlux (class in simsopt.geo.surfaceobjectives)
ToroidalTransitStoppingCriterion (class in simsopt.field.tracing)
torsion_impl() (simsopt.geo.curve.Curve method)
torsion_pure() (in module simsopt.geo.curve)
torsionvjp0() (in module simsopt.geo.curve)
torsionvjp1() (in module simsopt.geo.curve)
torsionvjp2() (in module simsopt.geo.curve)
total() (simsopt.mhd.vmec_diagnostics.QuasisymmetryRatioResidual method)
trace_particles() (in module simsopt.field.tracing)
trace_particles_boozer() (in module simsopt.field.tracing)
trace_particles_starting_on_curve() (in module simsopt.field.tracing)
trace_particles_starting_on_surface() (in module simsopt.field.tracing)
U
unfix() (simsopt._core.graph_optimizable.DOFs method)
(simsopt._core.graph_optimizable.Optimizable method)
unfix_all() (simsopt._core.graph_optimizable.DOFs method)
(simsopt._core.graph_optimizable.Optimizable method)
UniformInterpolationRule (class in simsopt.field.magneticfieldclasses)
unique() (in module simsopt._core.util)
unweighted_residuals() (simsopt.objectives.graph_least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
update_bounds() (simsopt._core.graph_optimizable.DOFs method)
update_lower_bound() (simsopt._core.graph_optimizable.DOFs method)
update_upper_bound() (simsopt._core.graph_optimizable.DOFs method)
upper_bounds (simsopt._core.graph_optimizable.DOFs property)
(simsopt._core.graph_optimizable.Optimizable property)
V
vacuum_well() (simsopt.mhd.vmec.Vmec method)
vjp() (simsopt.field.coil.Coil method)
(simsopt.field.coil.Current method)
(simsopt.field.coil.ScaledCurrent method)
Vmec (class in simsopt.mhd.vmec)
Volume (class in simsopt.geo.surfaceobjectives)
volume() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
(simsopt.mhd.vmec.Vmec method)
W
WeakKeyDefaultDict (class in simsopt._core.util)
WellWeighted (class in simsopt.mhd.vmec_diagnostics)
write_nml() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
X
x (simsopt._core.graph_optimizable.DOFs property)
(simsopt._core.graph_optimizable.Optimizable property)
Read the Docs
v: v0.6.1
Versions
latest
stable
v0.6.1
v0.6.0
v0.5.1
v0.5.0
v0.4.7
v0.4.6
v0.4.5
v0.4.4
v0.4.3
v0.4.2
v0.4.0
v0.3.03
v0.3.00
v0.2.03
v0.2.02
v0.2.01
v0.2.0
v0.2.0-alpha
v0.1.0
v0.0.10
v0.0.9
v0.0.8
Downloads
On Read the Docs
Project Home
Builds