simsopt
v0.3.00
Contents
Getting started
Requirements
Mandatory Packages
Optional Packages
Installation
From PyPi
From Source
From docker image
Post-Installation
simsopt in a 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
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
Citing Simsopt
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.dofs module
simsopt._core.graph_optimizable module
simsopt._core.optimizable module
simsopt._core.util module
Module contents
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.curvehelical module
simsopt.geo.curveobjectives module
simsopt.geo.curverzfourier module
simsopt.geo.curvexyzfourier module
simsopt.geo.graph_surface module
simsopt.geo.jit module
simsopt.geo.magneticfield module
simsopt.geo.magneticfieldclasses 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.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.logging module
simsopt.util.mpi module
simsopt.util.types 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
|
Z
_
__eq__() (simsopt._core.graph_optimizable.Optimizable method)
__init__() (simsopt._core.graph_optimizable.DOFs method)
(simsopt._core.graph_optimizable.Optimizable method)
(simsopt.mhd.boozer.Boozer method)
(simsopt.mhd.boozer.Quasisymmetry method)
(simsopt.mhd.spec.Residue method)
(simsopt.objectives.functions.Affine method)
__repr__() (simsopt.mhd.vmec.Vmec method)
_abc_impl (simsopt._core.graph_optimizable.Optimizable attribute)
(simsopt.geo.graph_surface.Surface attribute)
(simsopt.geo.graph_surface.SurfaceGarabedian attribute)
(simsopt.geo.graph_surface.SurfaceRZFourier 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)
_add_child() (simsopt._core.graph_optimizable.Optimizable method)
_get_ancestors() (simsopt._core.graph_optimizable.Optimizable method)
_ids (simsopt._core.graph_optimizable.Optimizable attribute)
(simsopt.geo.graph_surface.SurfaceGarabedian attribute)
(simsopt.geo.graph_surface.SurfaceRZFourier 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)
_init() (simsopt.objectives.least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
_mpi_leaders_task() (in module simsopt.solve.graph_mpi)
(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_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.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
A
A() (simsopt.geo.magneticfield.MagneticField method)
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)
all_owners (simsopt._core.dofs.Dofs attribute)
allocate() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
any_fixed() (simsopt._core.graph_optimizable.DOFs method)
any_free() (simsopt._core.graph_optimizable.DOFs method)
apart() (simsopt.util.mpi.MpiPartition method)
append_parent() (simsopt._core.graph_optimizable.Optimizable method)
Area (class in simsopt.geo.surfaceobjectives)
area() (simsopt.geo.graph_surface.SurfaceGarabedian method)
(simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
area_volume() (simsopt.geo.graph_surface.SurfaceGarabedian method)
(simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
area_volume_pure() (in module simsopt.geo.graph_surface)
aspect() (simsopt.mhd.vmec.Vmec method)
aspect_ratio() (simsopt.geo.surface.Surface method)
B
B() (simsopt.geo.magneticfield.MagneticField method)
B_and_dB_vjp() (simsopt.geo.biotsavart.BiotSavart method)
B_vjp() (simsopt.geo.biotsavart.BiotSavart method)
Beale (class in simsopt.objectives.functions)
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)
bounds (simsopt._core.graph_optimizable.DOFs property)
(simsopt._core.graph_optimizable.Optimizable property)
C
change_resolution() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
CircularCoil (class in simsopt.geo.magneticfieldclasses)
clear_cached_properties() (simsopt.geo.magneticfield.MagneticField 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)
(simsopt.geo.magneticfield.MagneticField method)
(simsopt.geo.magneticfield.MagneticFieldMultiply method)
(simsopt.geo.magneticfield.MagneticFieldSum method)
(simsopt.geo.magneticfieldclasses.CircularCoil method)
(simsopt.geo.magneticfieldclasses.Dommaschk method)
(simsopt.geo.magneticfieldclasses.Reiman method)
(simsopt.geo.magneticfieldclasses.ScalarPotentialRZMagneticField method)
(simsopt.geo.magneticfieldclasses.ToroidalField method)
compute_A() (simsopt.geo.biotsavart.BiotSavart method)
(simsopt.geo.magneticfield.MagneticField method)
(simsopt.geo.magneticfield.MagneticFieldMultiply method)
(simsopt.geo.magneticfield.MagneticFieldSum method)
(simsopt.geo.magneticfieldclasses.CircularCoil method)
(simsopt.geo.magneticfieldclasses.ToroidalField method)
cross_section() (simsopt.geo.surface.Surface method)
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)
CurveXYZFourier (class in simsopt.geo.curvexyzfourier)
D
d2A_by_dXdX() (simsopt.geo.magneticfield.MagneticField method)
d2B_by_dXdcoilcurrents() (simsopt.geo.biotsavart.BiotSavart method)
d2B_by_dXdX() (simsopt.geo.magneticfield.MagneticField 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)
dA_by_dX() (simsopt.geo.magneticfield.MagneticField method)
darea() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
darea_volume() (simsopt.geo.graph_surface.SurfaceRZFourier method)
dataset_area_volume() (in module simsopt.geo.graph_surface)
dB_by_dcoilcurrents() (simsopt.geo.biotsavart.BiotSavart method)
dB_by_dX() (simsopt.geo.magneticfield.MagneticField method)
Delta (simsopt.geo.graph_surface.SurfaceGarabedian property)
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.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)
(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.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_owners (simsopt._core.dofs.Dofs attribute)
dof_size (simsopt._core.graph_optimizable.Optimizable property)
Dofs (class in simsopt._core.dofs)
DOFs (class in simsopt._core.graph_optimizable)
dofs_free_status (simsopt._core.graph_optimizable.Optimizable property)
Dommaschk (class in simsopt.geo.magneticfieldclasses)
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.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier 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._core.dofs.Dofs method)
(simsopt.geo.graph_surface.SurfaceGarabedian method)
(simsopt.geo.graph_surface.SurfaceRZFourier method)
(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)
(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() (simsopt._core.dofs.Dofs method)
fd_jac_mpi() (in module simsopt.solve.graph_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)
fixed_range() (simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
frenet_frame() (simsopt.geo.curve.Curve method)
from_focus() (simsopt.geo.graph_surface.SurfaceRZFourier class method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier class method)
from_sigma() (simsopt.objectives.graph_least_squares.LeastSquaresProblem class method)
(simsopt.objectives.least_squares.LeastSquaresTerm class method)
(simsopt.objectives.LeastSquaresTerm class method)
from_tuples() (simsopt.objectives.graph_least_squares.LeastSquaresProblem class method)
full_dof_size (simsopt._core.graph_optimizable.Optimizable 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)
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.graph_optimizable.Optimizable method)
(simsopt._core.optimizable.Optimizable method)
get_Delta() (simsopt.geo.graph_surface.SurfaceGarabedian method)
(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.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.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)
get_fixed() (simsopt._core.optimizable.Optimizable method)
get_max_mn() (simsopt.mhd.vmec.Vmec method)
get_owners() (in module simsopt._core.dofs)
get_parent_return_fns_list() (simsopt._core.graph_optimizable.Optimizable method)
get_rc() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
get_return_fn_list() (simsopt._core.graph_optimizable.Optimizable method)
get_return_fns() (simsopt._core.graph_optimizable.Optimizable method)
get_rs() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
get_zc() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
get_zs() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
group (simsopt.util.mpi.MpiPartition attribute)
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)
indices (simsopt._core.dofs.Dofs attribute)
init() (simsopt.mhd.spec.Spec method)
initialize_logging() (in module simsopt.util.logging)
InstanceCounterMeta (class in simsopt._core.util)
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)
is_fixed() (simsopt._core.graph_optimizable.Optimizable method)
is_free() (simsopt._core.graph_optimizable.Optimizable method)
isbool() (in module simsopt._core.util)
isnumber() (in module simsopt._core.util)
iter (simsopt.mhd.vmec.Vmec attribute)
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.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.Beale method)
(simsopt.objectives.functions.Failer method)
(simsopt.objectives.functions.Identity method)
(simsopt.objectives.functions.TestObject1 method)
(simsopt.objectives.functions.TestObject2 method)
jac() (simsopt._core.dofs.Dofs method)
(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)
jaxHelicalfouriercurve_pure() (in module simsopt.geo.curvehelical)
jit() (in module simsopt.geo.jit)
jit_area_volume_pure() (in module simsopt.geo.graph_surface)
jit_dataset_area_volume() (in module simsopt.geo.graph_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
leaders_loop() (simsopt.util.mpi.MpiPartition method)
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)
(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)
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_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.geo.magneticfield)
MagneticFieldMultiply (class in simsopt.geo.magneticfield)
MagneticFieldSum (class in simsopt.geo.magneticfield)
make_names() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
make_names_helper() (simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
make_optimizable() (in module simsopt._core.optimizable)
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)
MinimumDistance (class in simsopt.geo.curveobjectives)
mobilize_leaders() (simsopt.util.mpi.MpiPartition method)
mobilize_workers() (simsopt.util.mpi.MpiPartition method)
module
simsopt
simsopt._core
simsopt._core.dofs
simsopt._core.graph_optimizable
simsopt._core.optimizable
simsopt._core.util
simsopt.geo
simsopt.geo.biotsavart
simsopt.geo.boozersurface
simsopt.geo.coilcollection
simsopt.geo.config
simsopt.geo.curve
simsopt.geo.curvehelical
simsopt.geo.curveobjectives
simsopt.geo.curverzfourier
simsopt.geo.curvexyzfourier
simsopt.geo.graph_surface
simsopt.geo.jit
simsopt.geo.magneticfield
simsopt.geo.magneticfieldclasses
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.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.logging
simsopt.util.mpi
simsopt.util.types
MpiPartition (class in simsopt.util.mpi)
N
names (simsopt._core.dofs.Dofs attribute)
(simsopt._core.graph_optimizable.DOFs property)
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.curvehelical.CurveHelical method)
(simsopt.geo.curvexyzfourier.JaxCurveXYZFourier method)
O
objective() (simsopt.objectives.graph_least_squares.LeastSquaresProblem method)
(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)
ObjectiveFailure
Optimizable (class in simsopt._core.graph_optimizable)
(class in simsopt._core.optimizable)
OptimizableMeta (class in simsopt._core.util)
P
parent_return_fns_no (simsopt._core.graph_optimizable.Optimizable property)
plot() (simsopt.geo.curve.Curve method)
(simsopt.geo.surface.Surface method)
plot_mayavi() (simsopt.geo.curve.Curve method)
pop_parent() (simsopt._core.graph_optimizable.Optimizable method)
print_return_fn_names() (simsopt._core.graph_optimizable.Optimizable 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)
rc (simsopt.geo.graph_surface.SurfaceRZFourier property)
reduced_len (simsopt._core.graph_optimizable.DOFs property)
register() (simsopt.mhd.boozer.Boozer method)
RegisterMeta (class in simsopt._core.util)
Reiman (class in simsopt.geo.magneticfieldclasses)
remove_parent() (simsopt._core.graph_optimizable.Optimizable method)
residuals() (simsopt.objectives.graph_least_squares.LeastSquaresProblem method)
Residue (class in simsopt.mhd.spec)
return_fn_map (simsopt._core.graph_optimizable.Optimizable attribute)
(simsopt.geo.graph_surface.SurfaceGarabedian attribute)
(simsopt.geo.graph_surface.SurfaceRZFourier 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)
Rosenbrock (class in simsopt.objectives.functions)
(class in simsopt.objectives.graph_functions)
RosenbrockWithFailures (class in simsopt.objectives.functions)
RotatedCurve (class in simsopt.geo.curve)
rs (simsopt.geo.graph_surface.SurfaceRZFourier property)
run() (simsopt.mhd.boozer.Boozer method)
(simsopt.mhd.spec.Spec 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.geo.magneticfieldclasses)
scale_dofs_jac() (simsopt.objectives.least_squares.LeastSquaresProblem method)
(simsopt.objectives.LeastSquaresProblem method)
serial_solve() (in module simsopt.solve)
(in module simsopt.solve.graph_serial)
(in module simsopt.solve.serial)
set() (simsopt._core.dofs.Dofs method)
(simsopt._core.graph_optimizable.Optimizable method)
(simsopt._core.optimizable.Optimizable method)
set_Delta() (simsopt.geo.graph_surface.SurfaceGarabedian method)
(simsopt.geo.surfacegarabedian.SurfaceGarabedian method)
set_dofs() (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.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.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)
set_dofs_impl() (simsopt.geo.curve.RotatedCurve method)
(simsopt.geo.curvehelical.CurveHelical method)
(simsopt.geo.curvexyzfourier.JaxCurveXYZFourier method)
set_fixed() (simsopt._core.optimizable.Optimizable method)
set_points() (simsopt.geo.magneticfield.MagneticField method)
(simsopt.geo.magneticfield.MagneticFieldMultiply method)
(simsopt.geo.magneticfield.MagneticFieldSum method)
set_rc() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
set_rs() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
set_zc() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
set_zs() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
simsopt
module
simsopt._core
module
simsopt._core.dofs
module
simsopt._core.graph_optimizable
module
simsopt._core.optimizable
module
simsopt._core.util
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.curvehelical
module
simsopt.geo.curveobjectives
module
simsopt.geo.curverzfourier
module
simsopt.geo.curvexyzfourier
module
simsopt.geo.graph_surface
module
simsopt.geo.jit
module
simsopt.geo.magneticfield
module
simsopt.geo.magneticfieldclasses
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.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.logging
module
simsopt.util.mpi
module
simsopt.util.types
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)
sum() (simsopt.objectives.graph_functions.Adder method)
Surface (class in simsopt.geo.graph_surface)
(class in simsopt.geo.surface)
SurfaceGarabedian (class in simsopt.geo.graph_surface)
(class in simsopt.geo.surfacegarabedian)
SurfaceRZFourier (class in simsopt.geo.graph_surface)
(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_Garabedian() (simsopt.geo.graph_surface.SurfaceRZFourier method)
(simsopt.geo.surfacerzfourier.SurfaceRZFourier method)
to_RZFourier() (simsopt.geo.graph_surface.Surface method)
(simsopt.geo.graph_surface.SurfaceGarabedian method)
(simsopt.geo.graph_surface.SurfaceRZFourier method)
(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)
ToroidalField (class in simsopt.geo.magneticfieldclasses)
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
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)
unique() (in module simsopt._core.util)
unweighted_residuals() (simsopt.objectives.graph_least_squares.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)
Vmec (class in simsopt.mhd.vmec)
Volume (class in simsopt.geo.surfaceobjectives)
volume() (simsopt.geo.graph_surface.SurfaceGarabedian method)
(simsopt.geo.graph_surface.SurfaceRZFourier method)
(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.graph_optimizable.DOFs property)
(simsopt._core.graph_optimizable.Optimizable property)
(simsopt.objectives.least_squares.LeastSquaresProblem property)
(simsopt.objectives.LeastSquaresProblem property)
Z
zc (simsopt.geo.graph_surface.SurfaceRZFourier property)
zs (simsopt.geo.graph_surface.SurfaceRZFourier property)
Read the Docs
v: v0.3.00
Versions
latest
stable
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