simsopt
v0.1.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
Eliminating magnetic islands
API
simsopt package
Subpackages
simsopt.core package
Submodules
simsopt.core.dofs module
simsopt.core.functions module
simsopt.core.least_squares_problem module
simsopt.core.optimizable module
simsopt.core.util module
Module contents
simsopt.geo package
Submodules
simsopt.geo.biotsavart module
simsopt.geo.config module
simsopt.geo.curve module
simsopt.geo.curverzfourier module
simsopt.geo.curvexyzfourier module
simsopt.geo.jit module
simsopt.geo.objectives module
simsopt.geo.surface module
simsopt.geo.surfacegarabedian module
simsopt.geo.surfacerzfourier module
simsopt.geo.surfacexyzfourier module
Module contents
simsopt.mhd package
Submodules
simsopt.mhd.boozer module
simsopt.mhd.spec module
simsopt.mhd.vmec module
Module contents
simsopt.solve package
Submodules
simsopt.solve.mpi_solve module
simsopt.solve.serial_solve module
Module contents
simsopt.util package
Submodules
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
A() (simsopt.geo.biotsavart.BiotSavart method)
Adder (class in simsopt.core.functions)
Affine (class in simsopt.core.functions)
all_fixed() (simsopt.core.optimizable.Optimizable method)
allocate() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
apart() (simsopt.util.mpi.MpiPartition method)
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() (simsopt.geo.biotsavart.BiotSavart method)
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)
C
change_resolution() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
clear_cached_properties() (simsopt.geo.biotsavart.BiotSavart method)
closest_index() (in module simsopt.mhd.boozer)
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)
CurveRZFourier (class in simsopt.geo.curverzfourier)
CurveXYZFourier (class in simsopt.geo.curvexyzfourier)
D
d2A_by_dXdX() (simsopt.geo.biotsavart.BiotSavart method)
d2B_by_dXdcoilcurrents() (simsopt.geo.biotsavart.BiotSavart method)
d2B_by_dXdX() (simsopt.geo.biotsavart.BiotSavart method)
d3B_by_dXdXdcoilcurrents() (simsopt.geo.biotsavart.BiotSavart method)
dA_by_dX() (simsopt.geo.biotsavart.BiotSavart method)
darea() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
dB_by_dcoilcurrents() (simsopt.geo.biotsavart.BiotSavart method)
dB_by_dX() (simsopt.geo.biotsavart.BiotSavart method)
df() (simsopt.core.functions.Adder property)
(simsopt.core.functions.Identity property)
(simsopt.core.functions.TestObject1 property)
(simsopt.core.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)
dJ() (simsopt.core.functions.Adder method)
(simsopt.core.functions.Affine method)
(simsopt.core.functions.Identity method)
(simsopt.core.functions.TestObject1 method)
(simsopt.core.functions.TestObject2 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)
Dofs (class in simsopt.core.dofs)
dterm1() (simsopt.core.functions.Rosenbrock method)
dterm1prop() (simsopt.core.functions.Rosenbrock property)
dterm2() (simsopt.core.functions.Rosenbrock method)
dterm2prop() (simsopt.core.functions.Rosenbrock property)
dterms() (simsopt.core.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.core.dofs.Dofs method)
(simsopt.core.functions.Adder property)
(simsopt.core.functions.Identity property)
(simsopt.core.functions.Rosenbrock method)
(simsopt.core.functions.TestObject1 property)
(simsopt.core.functions.TestObject2 property)
(simsopt.core.least_squares_problem.LeastSquaresProblem method)
f_from_unshifted() (simsopt.core.least_squares_problem.LeastSquaresProblem method)
f_out() (simsopt.core.least_squares_problem.LeastSquaresTerm method)
fd_jac() (simsopt.core.dofs.Dofs method)
fd_jac_mpi() (in module simsopt.solve.mpi_solve)
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.core.least_squares_problem.LeastSquaresTerm class method)
function_from_user() (in module simsopt.core.optimizable)
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() (simsopt.core.optimizable.Optimizable method)
get_Delta() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
get_dofs() (simsopt.core.functions.Adder method)
(simsopt.core.functions.Affine method)
(simsopt.core.functions.Identity method)
(simsopt.core.functions.Rosenbrock method)
(simsopt.core.functions.TestObject1 method)
(simsopt.core.functions.TestObject2 method)
(simsopt.core.optimizable.Optimizable method)
(simsopt.core.optimizable.Target method)
(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.mhd.boozer.Boozer method)
(simsopt.mhd.boozer.Quasisymmetry method)
(simsopt.mhd.spec.Residue method)
(simsopt.mhd.spec.Spec method)
(simsopt.mhd.vmec.Vmec method)
get_fixed() (simsopt.core.optimizable.Optimizable method)
get_max_mn() (simsopt.mhd.vmec.Vmec method)
get_owners() (in module simsopt.core.dofs)
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)
I
Identity (class in simsopt.core.functions)
incremental_arclength_pure() (in module simsopt.geo.curve)
incremental_arclength_vjp() (in module simsopt.geo.curve)
index() (simsopt.core.optimizable.Optimizable method)
iota() (simsopt.mhd.spec.Spec method)
iota_axis() (simsopt.mhd.vmec.Vmec method)
iota_edge() (simsopt.mhd.vmec.Vmec method)
isbool() (in module simsopt.core.util)
isnumber() (in module simsopt.core.util)
J
J() (simsopt.core.functions.Adder method)
(simsopt.core.functions.Affine method)
(simsopt.core.functions.Identity method)
(simsopt.core.functions.TestObject1 method)
(simsopt.core.functions.TestObject2 method)
(simsopt.core.optimizable.Target method)
(simsopt.mhd.boozer.Quasisymmetry method)
(simsopt.mhd.spec.Residue method)
jac() (simsopt.core.dofs.Dofs method)
(simsopt.core.least_squares_problem.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.mpi_solve)
least_squares_serial_solve() (in module simsopt.solve.serial_solve)
LeastSquaresProblem (class in simsopt.core.least_squares_problem)
LeastSquaresTerm (class in simsopt.core.least_squares_problem)
load_curves_from_file() (simsopt.geo.curvexyzfourier.CurveXYZFourier static method)
load_wout() (simsopt.mhd.vmec.Vmec method)
log() (in module simsopt.util.mpi)
M
make_names() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
make_names_helper() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
mobilize_leaders() (simsopt.util.mpi.MpiPartition method)
mobilize_workers() (simsopt.util.mpi.MpiPartition method)
module
simsopt
simsopt.core
simsopt.core.dofs
simsopt.core.functions
simsopt.core.least_squares_problem
simsopt.core.optimizable
simsopt.core.util
simsopt.geo
simsopt.geo.biotsavart
simsopt.geo.config
simsopt.geo.curve
simsopt.geo.curverzfourier
simsopt.geo.curvexyzfourier
simsopt.geo.jit
simsopt.geo.surface
simsopt.geo.surfacegarabedian
simsopt.geo.surfacerzfourier
simsopt.geo.surfacexyzfourier
simsopt.mhd
simsopt.mhd.boozer
simsopt.mhd.spec
simsopt.mhd.vmec
simsopt.solve
simsopt.solve.mpi_solve
simsopt.solve.serial_solve
simsopt.util
simsopt.util.mpi
mpi_leaders_task() (in module simsopt.solve.mpi_solve)
mpi_workers_task() (in module simsopt.solve.mpi_solve)
MpiPartition (class in simsopt.util.mpi)
N
nested_lists_to_array() (in module simsopt.mhd.spec)
num_dofs() (simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.curvexyzfourier.JaxCurveXYZFourier method)
O
objective() (simsopt.core.least_squares_problem.LeastSquaresProblem method)
objective_from_shifted_f() (simsopt.core.least_squares_problem.LeastSquaresProblem method)
objective_from_unshifted_f() (simsopt.core.least_squares_problem.LeastSquaresProblem method)
Optimizable (class in simsopt.core.optimizable)
optimizable() (in module simsopt.core.optimizable)
P
plot() (simsopt.geo.curve.Curve method)
(simsopt.geo.surface.Surface method)
plot_mayavi() (simsopt.geo.curve.Curve method)
Q
Quasisymmetry (class in simsopt.mhd.boozer)
R
register() (simsopt.mhd.boozer.Boozer method)
Residue (class in simsopt.mhd.spec)
Rosenbrock (class in simsopt.core.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.core.least_squares_problem.LeastSquaresProblem method)
serial_solve() (in module simsopt.solve.serial_solve)
set() (simsopt.core.dofs.Dofs method)
(simsopt.core.optimizable.Optimizable method)
set_Delta() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
set_dofs() (simsopt.core.functions.Adder method)
(simsopt.core.functions.Affine method)
(simsopt.core.functions.Identity method)
(simsopt.core.functions.Rosenbrock method)
(simsopt.core.functions.TestObject1 method)
(simsopt.core.functions.TestObject2 method)
(simsopt.core.optimizable.Optimizable method)
(simsopt.core.optimizable.Target method)
(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.mhd.boozer.Boozer method)
(simsopt.mhd.boozer.Quasisymmetry method)
(simsopt.mhd.spec.Residue method)
(simsopt.mhd.spec.Spec method)
(simsopt.mhd.vmec.Vmec method)
set_dofs_impl() (simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.curvexyzfourier.JaxCurveXYZFourier method)
set_fixed() (simsopt.core.optimizable.Optimizable method)
set_points() (simsopt.geo.biotsavart.BiotSavart 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.core
module
simsopt.core.dofs
module
simsopt.core.functions
module
simsopt.core.least_squares_problem
module
simsopt.core.optimizable
module
simsopt.core.util
module
simsopt.geo
module
simsopt.geo.biotsavart
module
simsopt.geo.config
module
simsopt.geo.curve
module
simsopt.geo.curverzfourier
module
simsopt.geo.curvexyzfourier
module
simsopt.geo.jit
module
simsopt.geo.surface
module
simsopt.geo.surfacegarabedian
module
simsopt.geo.surfacerzfourier
module
simsopt.geo.surfacexyzfourier
module
simsopt.mhd
module
simsopt.mhd.boozer
module
simsopt.mhd.spec
module
simsopt.mhd.vmec
module
simsopt.solve
module
simsopt.solve.mpi_solve
module
simsopt.solve.serial_solve
module
simsopt.util
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)
Struct (class in simsopt.core.util)
Surface (class in simsopt.geo.surface)
SurfaceGarabedian (class in simsopt.geo.surfacegarabedian)
SurfaceRZFourier (class in simsopt.geo.surfacerzfourier)
SurfaceXYZFourier (class in simsopt.geo.surfacexyzfourier)
T
Target (class in simsopt.core.optimizable)
term1() (simsopt.core.functions.Rosenbrock method)
term1prop() (simsopt.core.functions.Rosenbrock property)
term2() (simsopt.core.functions.Rosenbrock method)
term2prop() (simsopt.core.functions.Rosenbrock property)
terms() (simsopt.core.functions.Rosenbrock method)
TestObject1 (class in simsopt.core.functions)
TestObject2 (class in simsopt.core.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)
together() (simsopt.util.mpi.MpiPartition method)
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
unique() (in module simsopt.core.util)
update_resolution() (simsopt.mhd.spec.Spec method)
V
Vmec (class in simsopt.mhd.vmec)
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.core.dofs.Dofs property)
(simsopt.core.least_squares_problem.LeastSquaresProblem property)
Read the Docs
v: v0.1.0
Versions
latest
stable
v0.1.0
v0.0.10
v0.0.9
v0.0.8
Downloads
On Read the Docs
Project Home
Builds