simsopt Logo
desc_in_container

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
    • Serialization
  • Geometric objects
    • Curves
    • Surfaces
    • Caching
    • Graphics
  • Magnetic fields
    • Field types
      • Coils and BiotSavart
      • ToroidalField
      • PoloidalField
      • ScalarPotentialRZMagneticField
      • CircularCoil
      • Dommaschk
      • Reiman
      • MirrorModel
      • 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
    • Modular testing
    • Parallel Testing
    • 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
  • C++ backend
    • pybind11
    • xtensor and xtensor-python
    • OpenMP
    • SIMD
    • CMake

Tutorials

  • Optimizing an equilibrium code
    • SPEC version
    • VMEC version
  • Optimizing for quasisymmetry
    • Fixed resolution
    • Dynamic resolution
    • Bmn objective
  • Eliminating magnetic islands
  • Coil optimization
    • Minimal example
    • Further coil regularization terms
    • Stochastic Optimization
    • Finite Beta Optimization
    • Finite Build Optimization
  • Single stage optimization
    • Vacuum optimization
    • Finite beta optimization
  • Permanent magnet optimization
    • Minimal permanent magnets example
    • Further options for improved optimization

API reference

  • Public functions and classes
    • Subpackages
      • _core
        • Derivative
        • Float
        • Integer
        • ObjectiveFailure
        • OneofIntegers
        • OneofStrings
        • Optimizable
        • OptimizableSum
        • PositiveFloat
        • PositiveInteger
        • ScaledOptimizable
        • String
        • load()
        • make_optimizable()
        • save()
      • configs
        • get_giuliani_data()
        • get_hsx_data()
        • get_ncsx_data()
        • get_w7x_data()
      • field
        • BiotSavart
        • BoozerAnalytic
        • BoozerMagneticField
        • BoozerRadialInterpolant
        • CircularCoil
        • Coil
        • Current
        • DipoleField
        • Dommaschk
        • InterpolatedBoozerField
        • InterpolatedField
        • IterationStoppingCriterion
        • LevelsetStoppingCriterion
        • MGrid
        • MagneticField
        • MagneticFieldMultiply
        • MagneticFieldSum
        • MaxRStoppingCriterion
        • MaxToroidalFluxStoppingCriterion
        • MaxZStoppingCriterion
        • MinRStoppingCriterion
        • MinToroidalFluxStoppingCriterion
        • MinZStoppingCriterion
        • MirrorModel
        • NormalField
        • PoloidalField
        • Reiman
        • ScalarPotentialRZMagneticField
        • SurfaceClassifier
        • ToroidalField
        • ToroidalTransitStoppingCriterion
        • apply_symmetries_to_currents()
        • apply_symmetries_to_curves()
        • coils_to_focus()
        • coils_to_makegrid()
        • coils_via_symmetries()
        • compute_fieldlines()
        • compute_on_axis_iota()
        • compute_poloidal_transits()
        • compute_resonances()
        • compute_toroidal_transits()
        • load_coils_from_makegrid_file()
        • particles_to_vtk()
        • plot_poincare_data()
        • trace_particles()
        • trace_particles_boozer()
        • trace_particles_starting_on_curve()
        • trace_particles_starting_on_surface()
      • geo
        • ArclengthVariation
        • Area
        • BoozerSurface
        • CoilStrain
        • Curve
        • CurveCurveDistance
        • CurveFilament
        • CurveHelical
        • CurveLength
        • CurvePerturbed
        • CurvePlanarFourier
        • CurveRZFourier
        • CurveSurfaceDistance
        • CurveXYZFourier
        • FrameRotation
        • FramedCurve
        • FramedCurveCentroid
        • FramedCurveFrenet
        • GaussianSampler
        • Iotas
        • JaxCurveXYZFourier
        • LPBinormalCurvatureStrainPenalty
        • LPTorsionalStrainPenalty
        • LinkingNumber
        • LpCurveCurvature
        • LpCurveTorsion
        • MajorRadius
        • MeanSquaredCurvature
        • NonQuasiSymmetricRatio
        • PermanentMagnetGrid
        • PerturbationSample
        • PrincipalCurvature
        • QfmResidual
        • QfmSurface
        • RotatedCurve
        • Surface
        • SurfaceClassifier
        • SurfaceGarabedian
        • SurfaceHenneberg
        • SurfaceRZFourier
        • SurfaceRZPseudospectral
        • SurfaceScaled
        • SurfaceXYZFourier
        • SurfaceXYZTensorFourier
        • ToroidalFlux
        • Volume
        • ZeroRotation
        • best_nphi_over_ntheta()
        • boozer_surface_residual()
        • create_equally_spaced_curves()
        • create_equally_spaced_planar_curves()
        • create_multifilament_grid()
        • curves_to_vtk()
        • fix_matplotlib_3d()
        • plot()
        • signed_distance_from_surface()
      • mhd
        • Boozer
        • IotaTargetMetric
        • IotaWeighted
        • Profile
        • ProfilePolynomial
        • ProfilePressure
        • ProfileScaled
        • ProfileSpec
        • ProfileSpline
        • Quasisymmetry
        • QuasisymmetryRatioResidual
        • RedlGeomBoozer
        • RedlGeomVmec
        • Residue
        • Spec
        • VirtualCasing
        • Vmec
        • VmecRedlBootstrapMismatch
        • WellWeighted
        • compute_trapped_fraction()
        • j_dot_B_Redl()
        • vmec_compute_geometry()
        • vmec_fieldlines()
        • vmec_splines()
      • objectives
        • ConstrainedProblem
        • LeastSquaresProblem
        • MPIObjective
        • QuadraticPenalty
        • SquaredFlux
        • Weight
        • forward_backward()
      • solve
        • GPMO()
        • constrained_mpi_solve()
        • constrained_serial_solve()
        • least_squares_mpi_solve()
        • least_squares_serial_solve()
        • relax_and_split()
        • serial_solve()
      • util
        • FocusData
        • FocusPlasmaBnormal
        • calculate_on_axis_B()
        • coil_optimization()
        • discretize_polarizations()
        • edge_triplet()
        • face_triplet()
        • initialize_coils()
        • initialize_default_kwargs()
        • initialize_logging()
        • log()
        • make_Bnormal_plots()
        • make_optimization_plots()
        • make_qfm()
        • orientation_phi()
        • polarization_axes()
        • proc0_print()
        • read_focus_coils()
        • run_Poincare_plots()
        • stell_point_transform()
        • stell_vector_transform()
        • trace_fieldlines()
  • Full listing (for developers)
    • Subpackages
      • simsopt._core package
        • Submodules
        • simsopt._core.derivative module
        • simsopt._core.descriptor module
        • simsopt._core.finite_difference module
        • simsopt._core.optimizable module
        • simsopt._core.util module
      • simsopt.configs package
        • Submodules
        • simsopt.configs.zoo module
      • 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.mgrid module
        • simsopt.field.normal_field module
        • simsopt.field.sampling module
        • simsopt.field.tracing module
      • 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.curveplanarfourier module
        • simsopt.geo.curvexyzfourier module
        • simsopt.geo.finitebuild module
        • simsopt.geo.framedcurve module
        • simsopt.geo.jit module
        • simsopt.geo.permanent_magnet_grid module
        • simsopt.geo.plotting module
        • simsopt.geo.qfmsurface module
        • simsopt.geo.strain_optimization 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
      • 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
      • simsopt.objectives package
        • Submodules
        • simsopt.objectives.constrained module
        • simsopt.objectives.fluxobjective module
        • simsopt.objectives.functions module
        • simsopt.objectives.least_squares module
        • simsopt.objectives.utilities module
      • simsopt.solve package
        • Submodules
        • simsopt.solve.mpi module
        • simsopt.solve.permanent_magnet_optimization module
        • simsopt.solve.serial module
      • simsopt.util package
        • Submodules
        • simsopt.util.constants module
        • simsopt.util.famus_helpers module
        • simsopt.util.fourier_interpolation module
        • simsopt.util.logger module
        • simsopt.util.mpi module
        • simsopt.util.mpi_logger module
        • simsopt.util.permanent_magnet_helper_functions module
        • simsopt.util.polarization_project module
      • simsoptpp package
        • BiotSavart
        • BoozerMagneticField
        • ChebyshevInterpolationRule
        • Coil
        • Current
        • CurrentBase
        • Curve
        • CurvePlanarFourier
        • CurveRZFourier
        • CurveXYZFourier
        • DommaschkB()
        • DommaschkdB()
        • GPMO_ArbVec()
        • GPMO_ArbVec_backtracking()
        • GPMO_backtracking()
        • GPMO_baseline()
        • GPMO_multi()
        • InterpolatedBoozerField
        • InterpolatedField
        • InterpolationRule
        • IterationStoppingCriterion
        • LevelsetStoppingCriterion
        • MagneticField
        • MaxRStoppingCriterion
        • MaxToroidalFluxStoppingCriterion
        • MaxZStoppingCriterion
        • MinRStoppingCriterion
        • MinToroidalFluxStoppingCriterion
        • MinZStoppingCriterion
        • MwPGP_algorithm()
        • RegularGridInterpolant3D
        • ReimanB()
        • ReimandB()
        • StoppingCriterion
        • Surface
        • SurfaceRZFourier
        • SurfaceXYZFourier
        • SurfaceXYZTensorFourier
        • ToroidalTransitStoppingCriterion
        • UniformInterpolationRule
        • biot_savart()
        • biot_savart_B()
        • biot_savart_vector_potential_vjp_graph()
        • biot_savart_vjp()
        • biot_savart_vjp_graph()
        • boozer_dresidual_dc()
        • compute_kmnc_kmns()
        • compute_kmns()
        • compute_linking_number()
        • define_a_uniform_cartesian_grid_between_two_toroidal_surfaces()
        • dipole_field_A()
        • dipole_field_B()
        • dipole_field_Bn()
        • dipole_field_dA()
        • dipole_field_dB()
        • fieldline_tracing()
        • fourier_transform_even()
        • fourier_transform_odd()
        • get_phi()
        • get_pointclouds_closer_than_threshold_between_two_collections()
        • get_pointclouds_closer_than_threshold_within_collection()
        • integral_BdotN()
        • inverse_fourier_transform_even()
        • inverse_fourier_transform_odd()
        • matmult()
        • particle_fullorbit_tracing()
        • particle_guiding_center_boozer_tracing()
        • particle_guiding_center_tracing()
        • vjp()
    • Module contents
simsopt
  • Search

© Copyright 2020, Simsopt Development Team. Revision 4968ece0.

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