simsopt
v0.8.0
Contents
Overview
Ways to use simsopt
Input files
Optimization stages
Optimization
Modules
Installation
Requirements
Optional Packages
Virtual Environments
venv
conda
Installation methods
PyPi
conda
From source
Docker container
Post-Installation
Containers
Docker container
Requirements
Install From Docker Hub
Ways to use simsopt docker container
IPython Shell
Bash Shell
Jupyter notebook
Persistent containers
Shifter container
Singularity container
Singularity Images
Simsopt Specifics
Running the Singularity Container
Serial Jobs
Parallel Jobs
Defining optimization problems
The Optimizable class
Optimizable degrees of freedom
Dependencies
Function reference
Caching
Specifying least-squares objective functions
Custom objective functions and optimizable objects
Derivatives
Geometric objects
Curves
Surfaces
Caching
Graphics
Magnetic fields
Field types
Coils and BiotSavart
ToroidalField
PoloidalField
ScalarPotentialRZMagneticField
CircularCoil
Dommaschk
Reiman
InterpolatedField
Scaling and summing fields
Common operations
Field line and particle tracing
Particle motion in cylindrical coordinates
MPI partitions and worker groups
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
Tutorials
Optimizing an equilibrium code
SPEC version
VMEC version
Optimizing for quasisymmetry
Fixed resolution
Dynamic resolution
Bmn objective
Eliminating magnetic islands
Coil optimization
API
simsopt package
Subpackages
simsopt._core package
Submodules
simsopt._core.derivative module
simsopt._core.finite_difference 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.curveperturbed module
simsopt.geo.curverzfourier module
simsopt.geo.curvexyzfourier module
simsopt.geo.finitebuild 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.bootstrap module
simsopt.mhd.boozer module
simsopt.mhd.profiles module
simsopt.mhd.spec module
simsopt.mhd.virtual_casing 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.least_squares module
simsopt.objectives.utilities module
Module contents
simsopt.solve package
Submodules
simsopt.solve.mpi module
simsopt.solve.serial module
Module contents
simsopt.util package
Submodules
simsopt.util.constants module
simsopt.util.dev module
simsopt.util.fourier_interpolation module
simsopt.util.log module
simsopt.util.mpi module
simsopt.util.mpi_logger module
simsopt.util.types module
simsopt.util.zoo module
Module contents
simsoptpp package
Module contents
Module contents
simsopt
»
Search
Please activate JavaScript to enable the search functionality.
Read the Docs
v: v0.8.0
Versions
latest
stable
v0.8.0
v0.7.4
v0.7.3
v0.7.2
v0.7.1
v0.7.0
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