simsopt Logo
v0.2.0-alpha

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
    • Fixed resolution
    • Dynamic resolution
  • Eliminating magnetic islands

API

  • simsopt package
    • Subpackages
      • 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.curveobjectives module
        • simsopt.geo.curverzfourier module
        • simsopt.geo.curvexyzfourier module
        • simsopt.geo.jit 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.least_squares module
        • Module contents
      • simsopt.solve package
        • Submodules
        • simsopt.solve.mpi module
        • simsopt.solve.serial module
        • Module contents
      • simsopt.util package
        • Submodules
        • simsopt.util.logging module
        • simsopt.util.mpi module
        • Module contents
    • Module contents
simsopt
  • »
  • Python Module Index

Python Module Index

s
 
s
- simsopt
    simsopt.geo
    simsopt.geo.biotsavart
    simsopt.geo.boozersurface
    simsopt.geo.coilcollection
    simsopt.geo.config
    simsopt.geo.curve
    simsopt.geo.curveobjectives
    simsopt.geo.curverzfourier
    simsopt.geo.curvexyzfourier
    simsopt.geo.jit
    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.least_squares
    simsopt.solve
    simsopt.solve.mpi
    simsopt.solve.serial
    simsopt.util
    simsopt.util.logging
    simsopt.util.mpi

© Copyright 2020, Simsopt Development Team. Revision 71d6d115.

Built with Sphinx using a theme provided by Read the Docs.