simsopt
v0.2.0
Contents
Getting started
Requirements
Mandatory Packages
Optional Packages
Installation
From PyPi
From Source
Post-Installation
Concepts
Ways to use simsopt
Input files
Optimization
MPI Partitions and worker groups
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
Examples
Optimizing an equilibrium code
SPEC version
VMEC version
Optimizing for quasisymmetry
Fixed resolution
Dynamic resolution
Eliminating magnetic islands
API
simsopt package
Subpackages
simsopt.geo package
Submodules
simsopt.geo.biotsavart module
simsopt.geo.boozersurface module
simsopt.geo.coilcollection module
simsopt.geo.config module
simsopt.geo.curve module
simsopt.geo.curveobjectives module
simsopt.geo.curverzfourier module
simsopt.geo.curvexyzfourier module
simsopt.geo.jit module
simsopt.geo.surface module
simsopt.geo.surfacegarabedian 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
Module contents
simsopt.objectives package
Submodules
simsopt.objectives.functions module
simsopt.objectives.least_squares module
Module contents
simsopt.solve package
Submodules
simsopt.solve.mpi module
simsopt.solve.serial module
Module contents
simsopt.util package
Submodules
simsopt.util.logging module
simsopt.util.mpi module
Module contents
Module contents
simsopt
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
F
|
G
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
_
__repr__() (simsopt.mhd.vmec.Vmec method)
A
Adder (class in simsopt.objectives.functions)
Affine (class in simsopt.objectives.functions)
allocate() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
apart() (simsopt.util.mpi.MpiPartition 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.geo.biotsavart.BiotSavart method)
B_vjp() (simsopt.geo.biotsavart.BiotSavart method)
BiotSavart (class in simsopt.geo.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)
BoozerSurface (class in simsopt.geo.boozersurface)
C
change_resolution() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
CoilCollection (class in simsopt.geo.coilcollection)
comm_groups (simsopt.util.mpi.MpiPartition attribute)
comm_leaders (simsopt.util.mpi.MpiPartition attribute)
comm_world (simsopt.util.mpi.MpiPartition attribute)
compute() (simsopt.geo.biotsavart.BiotSavart method)
compute_A() (simsopt.geo.biotsavart.BiotSavart method)
cross_section() (simsopt.geo.surface.Surface method)
Curve (class in simsopt.geo.curve)
curve_length_pure() (in module simsopt.geo.curveobjectives)
CurveLength (class in simsopt.geo.curveobjectives)
CurveRZFourier (class in simsopt.geo.curverzfourier)
CurveXYZFourier (class in simsopt.geo.curvexyzfourier)
D
d2B_by_dXdcoilcurrents() (simsopt.geo.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.geo.biotsavart.BiotSavart method)
darea() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
dB_by_dcoilcurrents() (simsopt.geo.biotsavart.BiotSavart method)
df() (simsopt.objectives.functions.Adder property)
(simsopt.objectives.functions.Identity property)
(simsopt.objectives.functions.TestObject1 property)
(simsopt.objectives.functions.TestObject2 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.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadash_by_dcoeff_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadash_by_dcoeff_vjp() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadashdash_by_dcoeff_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadashdash_by_dcoeff_vjp() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadashdashdash_by_dcoeff_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve method)
dgammadashdashdash_by_dcoeff_vjp() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve 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.objectives.functions.Adder method)
(simsopt.objectives.functions.Affine method)
(simsopt.objectives.functions.Identity method)
(simsopt.objectives.functions.TestObject1 method)
(simsopt.objectives.functions.TestObject2 method)
dJ_by_dsurfacecoefficients() (simsopt.geo.surfaceobjectives.Area 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)
dterm1() (simsopt.objectives.functions.Rosenbrock method)
dterm1prop() (simsopt.objectives.functions.Rosenbrock property)
dterm2() (simsopt.objectives.functions.Rosenbrock method)
dterm2prop() (simsopt.objectives.functions.Rosenbrock property)
dterms() (simsopt.objectives.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)
F
f() (simsopt.objectives.functions.Adder property)
(simsopt.objectives.functions.Identity property)
(simsopt.objectives.functions.Rosenbrock method)
(simsopt.objectives.functions.TestObject1 property)
(simsopt.objectives.functions.TestObject2 property)
(simsopt.objectives.least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
f_from_unshifted() (simsopt.objectives.least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
f_out() (simsopt.objectives.least_squares.LeastSquaresTerm method)
(simsopt.objectives.LeastSquaresTerm method)
Failer (class in simsopt.objectives.functions)
fd_jac_mpi() (in module simsopt.solve)
(in module simsopt.solve.mpi)
fixed_range() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
frenet_frame() (simsopt.geo.curve.Curve method)
from_focus() (simsopt.geo.surfacerzfourier.SurfaceRZFourier class method)
from_sigma() (simsopt.objectives.least_squares.LeastSquaresTerm class method)
(simsopt.objectives.LeastSquaresTerm class method)
G
gamma_impl() (simsopt.geo.curve.JaxCurve method)
(simsopt.geo.curve.RotatedCurve 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)
get_Delta() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
get_dofs() (simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.curverzfourier.CurveRZFourier method)
(simsopt.geo.curvexyzfourier.CurveXYZFourier method)
(simsopt.geo.curvexyzfourier.JaxCurveXYZFourier method)
(simsopt.geo.surfacegarabedian.SurfaceGarabedian 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.spec.Spec method)
(simsopt.mhd.vmec.Vmec method)
(simsopt.objectives.functions.Adder method)
(simsopt.objectives.functions.Affine 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)
get_max_mn() (simsopt.mhd.vmec.Vmec method)
get_rc() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
get_rs() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
get_zc() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
get_zs() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
group (simsopt.util.mpi.MpiPartition attribute)
I
Identity (class in simsopt.objectives.functions)
incremental_arclength_pure() (in module simsopt.geo.curve)
incremental_arclength_vjp() (in module simsopt.geo.curve)
initialize_logging() (in module simsopt.util.logging)
invalidate_cache() (simsopt.geo.surfaceobjectives.ToroidalFlux method)
iota() (simsopt.mhd.spec.Spec method)
iota_axis() (simsopt.mhd.vmec.Vmec method)
iota_edge() (simsopt.mhd.vmec.Vmec method)
J
J() (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.ToroidalFlux method)
(simsopt.geo.surfaceobjectives.Volume method)
(simsopt.mhd.boozer.Quasisymmetry method)
(simsopt.mhd.spec.Residue method)
(simsopt.objectives.functions.Adder method)
(simsopt.objectives.functions.Affine method)
(simsopt.objectives.functions.Failer method)
(simsopt.objectives.functions.Identity method)
(simsopt.objectives.functions.TestObject1 method)
(simsopt.objectives.functions.TestObject2 method)
jac() (simsopt.objectives.least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
JaxCurve (class in simsopt.geo.curve)
JaxCurveXYZFourier (class in simsopt.geo.curvexyzfourier)
jaxfouriercurve_pure() (in module simsopt.geo.curvexyzfourier)
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
leaders_loop() (simsopt.util.mpi.MpiPartition method)
least_squares_mpi_solve() (in module simsopt.solve)
(in module simsopt.solve.mpi)
least_squares_serial_solve() (in module simsopt.solve)
(in module simsopt.solve.serial)
LeastSquaresProblem (class in simsopt.objectives)
(class in simsopt.objectives.least_squares)
LeastSquaresTerm (class in simsopt.objectives)
(class in simsopt.objectives.least_squares)
load_curves_from_file() (simsopt.geo.curvexyzfourier.CurveXYZFourier static method)
load_wout() (simsopt.mhd.vmec.Vmec method)
log() (in module simsopt.util.mpi)
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
make_names() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
make_names_helper() (simsopt.geo.surfacerzfourier.SurfaceRZFourier 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)
MinimumDistance (class in simsopt.geo.curveobjectives)
mobilize_leaders() (simsopt.util.mpi.MpiPartition method)
mobilize_workers() (simsopt.util.mpi.MpiPartition method)
module
simsopt
simsopt.geo
simsopt.geo.biotsavart
simsopt.geo.boozersurface
simsopt.geo.coilcollection
simsopt.geo.config
simsopt.geo.curve
simsopt.geo.curveobjectives
simsopt.geo.curverzfourier
simsopt.geo.curvexyzfourier
simsopt.geo.jit
simsopt.geo.surface
simsopt.geo.surfacegarabedian
simsopt.geo.surfaceobjectives
simsopt.geo.surfacerzfourier
simsopt.geo.surfacexyzfourier
simsopt.geo.surfacexyztensorfourier
simsopt.mhd
simsopt.mhd.boozer
simsopt.mhd.spec
simsopt.mhd.vmec
simsopt.objectives
simsopt.objectives.functions
simsopt.objectives.least_squares
simsopt.solve
simsopt.solve.mpi
simsopt.solve.serial
simsopt.util
simsopt.util.logging
simsopt.util.mpi
MpiPartition (class in simsopt.util.mpi)
N
nested_lists_to_array() (in module simsopt.mhd.spec)
ngroups (simsopt.util.mpi.MpiPartition attribute)
nprocs_groups (simsopt.util.mpi.MpiPartition attribute)
nprocs_leaders (simsopt.util.mpi.MpiPartition attribute)
nprocs_world (simsopt.util.mpi.MpiPartition attribute)
num_dofs() (simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.curvexyzfourier.JaxCurveXYZFourier method)
O
objective() (simsopt.objectives.least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
objective_from_shifted_f() (simsopt.objectives.least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
objective_from_unshifted_f() (simsopt.objectives.least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
P
plot() (simsopt.geo.curve.Curve method)
(simsopt.geo.surface.Surface method)
plot_mayavi() (simsopt.geo.curve.Curve method)
proc0_groups (simsopt.util.mpi.MpiPartition attribute)
proc0_world (simsopt.util.mpi.MpiPartition attribute)
Q
Quasisymmetry (class in simsopt.mhd.boozer)
R
rank_groups (simsopt.util.mpi.MpiPartition attribute)
rank_leaders (simsopt.util.mpi.MpiPartition attribute)
rank_world (simsopt.util.mpi.MpiPartition attribute)
register() (simsopt.mhd.boozer.Boozer method)
Residue (class in simsopt.mhd.spec)
Rosenbrock (class in simsopt.objectives.functions)
RosenbrockWithFailures (class in simsopt.objectives.functions)
RotatedCurve (class in simsopt.geo.curve)
run() (simsopt.mhd.boozer.Boozer method)
(simsopt.mhd.spec.Spec method)
(simsopt.mhd.vmec.Vmec method)
S
scale_dofs_jac() (simsopt.objectives.least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
serial_solve() (in module simsopt.solve)
(in module simsopt.solve.serial)
set_Delta() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
set_dofs() (simsopt.geo.curverzfourier.CurveRZFourier method)
(simsopt.geo.curvexyzfourier.CurveXYZFourier method)
(simsopt.geo.surfacegarabedian.SurfaceGarabedian 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.spec.Spec method)
(simsopt.mhd.vmec.Vmec method)
(simsopt.objectives.functions.Adder method)
(simsopt.objectives.functions.Affine 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)
set_dofs_impl() (simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.curvexyzfourier.JaxCurveXYZFourier method)
set_rc() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
set_rs() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
set_zc() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
set_zs() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
simsopt
module
simsopt.geo
module
simsopt.geo.biotsavart
module
simsopt.geo.boozersurface
module
simsopt.geo.coilcollection
module
simsopt.geo.config
module
simsopt.geo.curve
module
simsopt.geo.curveobjectives
module
simsopt.geo.curverzfourier
module
simsopt.geo.curvexyzfourier
module
simsopt.geo.jit
module
simsopt.geo.surface
module
simsopt.geo.surfacegarabedian
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.objectives
module
simsopt.objectives.functions
module
simsopt.objectives.least_squares
module
simsopt.solve
module
simsopt.solve.mpi
module
simsopt.solve.serial
module
simsopt.util
module
simsopt.util.logging
module
simsopt.util.mpi
module
Spec (class in simsopt.mhd.spec)
stop_leaders() (simsopt.util.mpi.MpiPartition method)
stop_workers() (simsopt.util.mpi.MpiPartition method)
Surface (class in simsopt.geo.surface)
SurfaceGarabedian (class in simsopt.geo.surfacegarabedian)
SurfaceRZFourier (class in simsopt.geo.surfacerzfourier)
SurfaceXYZFourier (class in simsopt.geo.surfacexyzfourier)
SurfaceXYZTensorFourier (class in simsopt.geo.surfacexyztensorfourier)
T
term1() (simsopt.objectives.functions.Rosenbrock method)
(simsopt.objectives.functions.RosenbrockWithFailures method)
term1prop() (simsopt.objectives.functions.Rosenbrock property)
term2() (simsopt.objectives.functions.Rosenbrock method)
term2prop() (simsopt.objectives.functions.Rosenbrock property)
terms() (simsopt.objectives.functions.Rosenbrock method)
TestObject1 (class in simsopt.objectives.functions)
TestObject2 (class in simsopt.objectives.functions)
to_Garabedian() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
to_RZFourier() (simsopt.geo.surface.Surface method)
(simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
(simsopt.geo.surfacexyzfourier.SurfaceXYZFourier method)
(simsopt.geo.surfacexyztensorfourier.SurfaceXYZTensorFourier method)
together() (simsopt.util.mpi.MpiPartition method)
ToroidalFlux (class in simsopt.geo.surfaceobjectives)
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)
U
update_resolution() (simsopt.mhd.spec.Spec method)
V
Vmec (class in simsopt.mhd.vmec)
Volume (class in simsopt.geo.surfaceobjectives)
volume() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
(simsopt.mhd.spec.Spec method)
(simsopt.mhd.vmec.Vmec method)
W
worker_loop() (simsopt.util.mpi.MpiPartition method)
write() (simsopt.util.mpi.MpiPartition method)
X
x() (simsopt.objectives.least_squares.LeastSquaresProblem property)
(simsopt.objectives.LeastSquaresProblem property)
Read the Docs
v: v0.2.0
Versions
latest
stable
v0.2.0
v0.1.0
v0.0.10
v0.0.9
v0.0.8
Downloads
On Read the Docs
Project Home
Builds