Skip to content

Commit

Permalink
Installation docs: clarification about vmec python extension
Browse files Browse the repository at this point in the history
  • Loading branch information
landreman committed Oct 27, 2023
1 parent e3568fc commit 6fa8b37
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,19 @@ Optional Packages
-----------------

Several other optional packages are needed for certain aspects of
simsopt, such as visualization/graphics and building the documentation. These
requirements can be found in the ``[options.extras_require]`` section
of
`setup.cfg <https://github.com/hiddenSymmetries/simsopt/blob/master/setup.cfg>`_.
simsopt, such as running SPEC or VMEC, visualization/graphics, and building the
documentation. These requirements can be found in the
``[options.extras_require]`` section of `setup.cfg
<https://github.com/hiddenSymmetries/simsopt/blob/master/setup.cfg>`_.
Also,

- For MPI support:
* mpi4py
- For VMEC support:
* https://github.com/hiddenSymmetries/vmec2000
* https://github.com/hiddenSymmetries/vmec2000 Note that the
python extension in this repository is required to run VMEC or
optimize VMEC configurations, but is not needed for computing
properties of existing ``wout`` output files.
- For computing Boozer coordinates:
* `booz_xform <https://hiddensymmetries.github.io/booz_xform/>`_
- For SPEC support:
Expand Down

0 comments on commit 6fa8b37

Please sign in to comment.