simsopt
v0.4.7
Contents
Getting started
Requirements
Mandatory Packages
Optional Packages
Installation
From PyPi
From Source
From docker container
Post-Installation
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
Geometric Objects
Curves
Surfaces
Caching
Magnetic Field Classes
BiotSavart
ToroidalField
PoloidalField
ScalarPotentialRZMagneticField
CircularCoil
Dommaschk
Reiman
InterpolatedField
Particle Tracing
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
Publications
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.field package
Submodules
simsopt.field.biotsavart module
simsopt.field.magneticfield module
simsopt.field.magneticfieldclasses module
simsopt.field.tracing module
Module contents
simsopt.geo package
Submodules
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.jit module
simsopt.geo.qfmsurface module
simsopt.geo.plot 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.boozer module
simsopt.mhd.spec module
simsopt.mhd.vmec module
simsopt.mhd.vmec_diagnostics 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.dev module
simsopt.util.logging module
simsopt.util.mpi module
simsopt.util.mpi_logger module
simsopt.util.types module
Module contents
Module contents
simsopt
»
Search
Please activate JavaScript to enable the search functionality.
Read the Docs
v: v0.4.7
Versions
latest
stable
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