simsopt
v0.0.9
Contents
Getting started
Requirements
Installation
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
API
simsopt package
Subpackages
simsopt.core
Submodules
simsopt.core.dofs module
simsopt.core.functions module
simsopt.core.least_squares_problem module
simsopt.core.optimizable module
simsopt.core.surface module
simsopt.core.util module
Module contents
simsopt.geo
Submodules
simsopt.geo.biotsavart module
simsopt.geo.config module
simsopt.geo.curve module
simsopt.geo.fouriercurve module
simsopt.geo.jit module
simsopt.geo.magneticaxis module
simsopt.geo.objectives module
simsopt.geo.parameterfreecurve module
Module contents
simsopt.mhd
Submodules
simsopt.mhd.boozer module
simsopt.mhd.spec module
simsopt.mhd.vmec module
Module contents
simsopt.solve
Submodules
simsopt.solve.mpi_solve module
simsopt.solve.serial_solve module
Module contents
simsopt.util
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
|
X
A
Adder (class in simsopt.core.functions)
Affine (class in simsopt.core.functions)
all_fixed() (simsopt.core.optimizable.Optimizable method)
allocate() (simsopt.core.surface.SurfaceGarabedian method)
(simsopt.core.surface.SurfaceRZFourier method)
area() (simsopt.core.surface.SurfaceGarabedian method)
(simsopt.core.surface.SurfaceRZFourier method)
area_volume() (simsopt.core.surface.SurfaceGarabedian method)
(simsopt.core.surface.SurfaceRZFourier method)
area_volume_pure() (in module simsopt.core.surface)
B
B() (simsopt.geo.biotsavart.BiotSavart method)
B_and_dB_vjp() (simsopt.geo.biotsavart.BiotSavart method)
BiotSavart (class in simsopt.geo.biotsavart)
C
change_resolution() (simsopt.core.surface.SurfaceRZFourier method)
clear_cached_properties() (simsopt.geo.biotsavart.BiotSavart method)
closest_index() (in module simsopt.mhd.boozer)
compute() (simsopt.geo.biotsavart.BiotSavart method)
Curve (class in simsopt.geo.curve)
curve_length_pure() (in module simsopt.geo.objectives)
CurveLength (class in simsopt.geo.objectives)
D
d2B_by_dXdcoilcurrents() (simsopt.geo.biotsavart.BiotSavart method)
d2B_by_dXdX() (simsopt.geo.biotsavart.BiotSavart method)
d3B_by_dXdXdcoilcurrents() (simsopt.geo.biotsavart.BiotSavart method)
darea() (simsopt.core.surface.SurfaceRZFourier method)
darea_volume() (simsopt.core.surface.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)
distance_pure() (in module simsopt.geo.objectives)
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)
(simsopt.geo.objectives.CurveLength method)
(simsopt.geo.objectives.LpCurveCurvature method)
(simsopt.geo.objectives.LpCurveTorsion method)
(simsopt.geo.objectives.MinimumDistance 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.core.surface.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.core.surface.SurfaceGarabedian method)
(simsopt.core.surface.SurfaceRZFourier method)
FourierCurve (class in simsopt.geo.fouriercurve)
frenet_frame() (simsopt.geo.curve.Curve method)
from_focus() (simsopt.core.surface.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.core.surface.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.core.surface.SurfaceGarabedian method)
(simsopt.core.surface.SurfaceRZFourier method)
(simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.fouriercurve.FourierCurve method)
(simsopt.geo.fouriercurve.JaxFourierCurve method)
(simsopt.geo.magneticaxis.JaxStellaratorSymmetricCylindricalFourierCurve method)
(simsopt.geo.magneticaxis.StellaratorSymmetricCylindricalFourierCurve method)
(simsopt.geo.parameterfreecurve.ParameterFreeCurve method)
(simsopt.mhd.boozer.Quasisymmetry method)
get_fixed() (simsopt.core.optimizable.Optimizable method)
get_owners() (in module simsopt.core.dofs)
get_rc() (simsopt.core.surface.SurfaceRZFourier method)
get_rs() (simsopt.core.surface.SurfaceRZFourier method)
get_zc() (simsopt.core.surface.SurfaceRZFourier method)
get_zs() (simsopt.core.surface.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)
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.geo.objectives.CurveLength method)
(simsopt.geo.objectives.LpCurveCurvature method)
(simsopt.geo.objectives.LpCurveTorsion method)
(simsopt.geo.objectives.MinimumDistance method)
(simsopt.mhd.boozer.Quasisymmetry method)
jac() (simsopt.core.dofs.Dofs method)
(simsopt.core.least_squares_problem.LeastSquaresProblem method)
JaxCurve (class in simsopt.geo.curve)
JaxFourierCurve (class in simsopt.geo.fouriercurve)
jaxfouriercurve_pure() (in module simsopt.geo.fouriercurve)
JaxStellaratorSymmetricCylindricalFourierCurve (class in simsopt.geo.magneticaxis)
jit() (in module simsopt.geo.jit)
jit_area_volume_pure() (in module simsopt.core.surface)
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.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)
log() (in module simsopt.util.mpi)
Lp_curvature_pure() (in module simsopt.geo.objectives)
Lp_torsion_pure() (in module simsopt.geo.objectives)
LpCurveCurvature (class in simsopt.geo.objectives)
LpCurveTorsion (class in simsopt.geo.objectives)
M
make_names() (simsopt.core.surface.SurfaceRZFourier method)
MinimumDistance (class in simsopt.geo.objectives)
module
simsopt
simsopt.core
simsopt.core.dofs
simsopt.core.functions
simsopt.core.least_squares_problem
simsopt.core.optimizable
simsopt.core.surface
simsopt.core.util
simsopt.geo
simsopt.geo.biotsavart
simsopt.geo.config
simsopt.geo.curve
simsopt.geo.fouriercurve
simsopt.geo.jit
simsopt.geo.magneticaxis
simsopt.geo.objectives
simsopt.geo.parameterfreecurve
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)
N
nested_lists_to_array() (in module simsopt.mhd.spec)
num_dofs() (simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.fouriercurve.JaxFourierCurve method)
(simsopt.geo.magneticaxis.JaxStellaratorSymmetricCylindricalFourierCurve method)
(simsopt.geo.parameterfreecurve.ParameterFreeCurve 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
ParameterFreeCurve (class in simsopt.geo.parameterfreecurve)
plot() (simsopt.geo.curve.Curve method)
Q
Quasisymmetry (class in simsopt.mhd.boozer)
R
reset_jacdt_flag (in module simsopt.mhd.vmec)
Rosenbrock (class in simsopt.core.functions)
RotatedCurve (class in simsopt.geo.curve)
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.core.surface.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.core.surface.SurfaceGarabedian method)
(simsopt.core.surface.SurfaceRZFourier method)
(simsopt.geo.fouriercurve.FourierCurve method)
(simsopt.geo.magneticaxis.StellaratorSymmetricCylindricalFourierCurve method)
(simsopt.mhd.boozer.Quasisymmetry method)
set_dofs_impl() (simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.fouriercurve.JaxFourierCurve method)
(simsopt.geo.magneticaxis.JaxStellaratorSymmetricCylindricalFourierCurve method)
(simsopt.geo.parameterfreecurve.ParameterFreeCurve method)
set_fixed() (simsopt.core.optimizable.Optimizable method)
set_points() (simsopt.geo.biotsavart.BiotSavart method)
set_rc() (simsopt.core.surface.SurfaceRZFourier method)
set_rs() (simsopt.core.surface.SurfaceRZFourier method)
set_zc() (simsopt.core.surface.SurfaceRZFourier method)
set_zs() (simsopt.core.surface.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.surface
module
simsopt.core.util
module
simsopt.geo
module
simsopt.geo.biotsavart
module
simsopt.geo.config
module
simsopt.geo.curve
module
simsopt.geo.fouriercurve
module
simsopt.geo.jit
module
simsopt.geo.magneticaxis
module
simsopt.geo.objectives
module
simsopt.geo.parameterfreecurve
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
StellaratorSymmetricCylindricalFourierCurve (class in simsopt.geo.magneticaxis)
stellaratorsymmetriccylindricalfouriercurve_pure() (in module simsopt.geo.magneticaxis)
Struct (class in simsopt.core.util)
Surface (class in simsopt.core.surface)
SurfaceGarabedian (class in simsopt.core.surface)
SurfaceRZFourier (class in simsopt.core.surface)
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.core.surface.SurfaceRZFourier method)
to_RZFourier() (simsopt.core.surface.Surface method)
(simsopt.core.surface.SurfaceGarabedian method)
(simsopt.core.surface.SurfaceRZFourier 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)
V
volume() (simsopt.core.surface.SurfaceGarabedian method)
(simsopt.core.surface.SurfaceRZFourier method)
X
x() (simsopt.core.dofs.Dofs property)
(simsopt.core.least_squares_problem.LeastSquaresProblem property)
Read the Docs
v: v0.0.9
Versions
latest
stable
rtd
v0.0.9
v0.0.8
Downloads
On Read the Docs
Project Home
Builds