Skip to main content

simsopt

GitHub codecov DOI

SIMSOPT SIMSOPT

simsopt is a framework for optimizing stellarators. The high-level routines of simsopt are in python, with calls to C++ or fortran where needed for performance. Several types of components are included:

  • Interfaces to physics codes, e.g. for MHD equilibrium.
  • Tools for defining objective functions and parameter spaces for optimization.
  • Geometric objects that are important for stellarators - surfaces and curves - with several available parameterizations.
  • An efficient implementation of the Biot-Savart law, including derivatives.
  • Tools for parallelized finite-difference gradient calculations.

Some of the physics modules with compiled code reside in separate repositories. These separate modules include

  • VMEC, for MHD equilibrium.
  • SPEC, for MHD equilibrium. (This repository is private.)
  • booz_xform, for Boozer coordinates and quasisymmetry.

The design of simsopt is guided by several principles:

  • Thorough unit testing, regression testing, and continuous integration.
  • Extensibility: It should be possible to add new codes and terms to the objective function without editing modules that already work, i.e. the open-closed principle. This is because any edits to working code can potentially introduce bugs.
  • Modularity: Physics modules that are not needed for your optimization problem do not need to be installed. For instance, to optimize SPEC equilibria, the VMEC module need not be installed.
  • Flexibility: The components used to define an objective function can be re-used for applications other than standard optimization. For instance, a simsopt objective function is a standard python function that can be plotted, passed to optimization packages outside of simsopt, etc.

simsopt is fully open-source, and anyone is welcome to make suggestions, contribute, and use. Several methods are available for installing simsopt. One recommended approach is to use pip

pip install simsopt

For more installation options and other information, see the main simsopt documentation here.

We gratefully acknowledge funding from the Simons Foundation's Hidden symmetries and fusion energy project.

Metadata

Release files for simsopt 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for simsopt 0.3.3
File Size Uploaded Provenance Actions
simsopt-0.3.3.tar.gz 5.1 MB Without provenance Details for simsopt-0.3.3.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for simsopt 0.3.3
File Actions
simsopt-0.3.3-cp39-cp39-manylinux2010_x86_64.whl CPython 3.9 CPython 3.9 Linux glibc 2.12+ x86-64 Details for simsopt-0.3.3-cp39-cp39-manylinux2010_x86_64.whl
simsopt-0.3.3-cp39-cp39-macosx_10_15_x86_64.whl CPython 3.9 CPython 3.9 macOS 10.15+ x86-64 Details for simsopt-0.3.3-cp39-cp39-macosx_10_15_x86_64.whl
simsopt-0.3.3-cp38-cp38-manylinux2010_x86_64.whl CPython 3.8 CPython 3.8 Linux glibc 2.12+ x86-64 Details for simsopt-0.3.3-cp38-cp38-manylinux2010_x86_64.whl
simsopt-0.3.3-cp38-cp38-macosx_10_15_x86_64.whl CPython 3.8 CPython 3.8 macOS 10.15+ x86-64 Details for simsopt-0.3.3-cp38-cp38-macosx_10_15_x86_64.whl
simsopt-0.3.3-cp37-cp37m-manylinux2010_x86_64.whl CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.12+ x86-64 Details for simsopt-0.3.3-cp37-cp37m-manylinux2010_x86_64.whl
simsopt-0.3.3-cp37-cp37m-macosx_10_15_x86_64.whl CPython 3.7 CPython 3.7 pymalloc macOS 10.15+ x86-64 Details for simsopt-0.3.3-cp37-cp37m-macosx_10_15_x86_64.whl

Total release size: 7.6 MB

Release files / simsopt-0.3.3.tar.gz

Download URL simsopt-0.3.3.tar.gz
Size 5.1 MB
Tags Source
SHA-256 checksum
How to use checksums
781cc103d70d441f84650e00bd458650e3c0c12c7f31f724842a9c94c12bab57
BLAKE2b-256 checksum
How to use checksums
1969540d60cf4212c3f186000001c27757af9408caafcc6147fe2353bd5df311
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Release files / simsopt-0.3.3-cp39-cp39-manylinux2010_x86_64.whl

Download URL simsopt-0.3.3-cp39-cp39-manylinux2010_x86_64.whl
Size 436.7 kB
Tags CPython 3.9 Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums
69014be7732c984fd16bcfb66f17169f2805dfa941f203163d44859d94505b92
BLAKE2b-256 checksum
How to use checksums
7c7187f4452539562b6ee0a20d5e49a9353c88cb67887875724129fe4da377e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Release files / simsopt-0.3.3-cp39-cp39-macosx_10_15_x86_64.whl

Download URL simsopt-0.3.3-cp39-cp39-macosx_10_15_x86_64.whl
Size 408.7 kB
Tags CPython 3.9 macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
082b11357a95cb384cf42da82d4f0ec9e24d8ec5cf7a26f4bfc9fbeab4db0885
BLAKE2b-256 checksum
How to use checksums
72c3a43461a1ef01ebbc27a6204d0c616210eee5a19bbcf8e9ba37a52c8a7a86
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Release files / simsopt-0.3.3-cp38-cp38-manylinux2010_x86_64.whl

Download URL simsopt-0.3.3-cp38-cp38-manylinux2010_x86_64.whl
Size 436.9 kB
Tags CPython 3.8 Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums
2c8300cc13d111187c8955a8496498c3388e9b99880793d3289f90704a8d3a46
BLAKE2b-256 checksum
How to use checksums
3ca721377f2f236fbecb22729cab86aab748adeaa833453da94f48ad0c407340
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Release files / simsopt-0.3.3-cp38-cp38-macosx_10_15_x86_64.whl

Download URL simsopt-0.3.3-cp38-cp38-macosx_10_15_x86_64.whl
Size 408.7 kB
Tags CPython 3.8 macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
600a6c4c63deca99126f431a1a9511f6aa1ca2884f2617b5257659da20d759ba
BLAKE2b-256 checksum
How to use checksums
1cd2af92fb04940d59878667b7ab47e8d662f1a506088d25438bd36511eab9df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Release files / simsopt-0.3.3-cp37-cp37m-manylinux2010_x86_64.whl

Download URL simsopt-0.3.3-cp37-cp37m-manylinux2010_x86_64.whl
Size 441.1 kB
Tags CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums
6670c117c73b58dd8fa3449927382c6aa7311aa506242adf310bc194e87298d1
BLAKE2b-256 checksum
How to use checksums
281c0c727d202c0ac3bfdd4eca679fb5d28bbc8528599e73569336fadb902e8a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Release files / simsopt-0.3.3-cp37-cp37m-macosx_10_15_x86_64.whl

Download URL simsopt-0.3.3-cp37-cp37m-macosx_10_15_x86_64.whl
Size 405.1 kB
Tags CPython 3.7 CPython 3.7 pymalloc macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
a83762203b080962d38a6197165c718c56325bb418ede34fc3daa810a3495176
BLAKE2b-256 checksum
How to use checksums
b2e38164b87c8b3b4e718924b6fa069794226ddb0387b72e0d3e1efa5ef59efb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Security for simsopt 0.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.3 This release

7 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page