zhucaoxiang/stellopt repository overview

⁠INSTALLATION

This version of STELLOPT makes use of make_***.inc files in the SHARE subdirectory to set various options at compile time. The make.inc file in the main directory is a script which picks these files based on what is returned by the uname -n command on your machine. This can be overridden by setting the environment variable MACHINE to the file you wish to use. For example to use SHARE/make_bobdole.inc you would set MACHINE=bobdole before calling the build scripts. It is also important to set STELLOPT_PATH to the path to your current directory where you've pulled the repository.

Once you configure the environment variables, you can begin to compile the code by

 ./build_all 

By default, it will compile all the codes in the folder with the option clean_release. You can customize the script by providing additional commandline arguments, like ./build_all -o release -j 4 STELLOPTV2. To check the options, type ./build_all -h.

There is also a Docker image available for use at https://hub.docker.com/r/zhucaoxiang/stellopt⁠.

For more information, please view STELLOPT compilation⁠.

⁠EDITING CODE

Once a working copy is developed for your computer, you are welcome to push it back to the main repository for other users. You can ask for a write permission and push your changes into a remote branch. Then submit a pull request through GitHub⁠.

Or you can share your changes via git fork⁠, which doesn't require you have the write permission.

GitHub actions will be triggered by each push and pull-request. The code will be compiled with debug option and you can check the full log at GitHub actions⁠.

⁠UTILITIES

A Python interface using CTYPES is also included but it requires a static shared build of LIBSTELL. This is still a highly experimental option. You can find the python scripts at ./pySTEL.

There are also some other plotting packages developed by group members. Here are some examples.

• matlabVMEC⁠: MATLAB packages for various codes.
• coilpy⁠: Python package for toroidal Fourier surface, coils, FOCUS and STELLOPT.

If you are willing to share your code, please add your contributions here.

⁠REPORT BUGS

If you find any bugs or have any suggestions, please submit an issue through GitHub issues⁠. You are suggested to provide detailed description and assign someone when creating an issue.

⁠DOCUMENTATION

You can find some wiki pages at GitHub pages⁠. This is automatically generated from the markdown source files in the gh-pages⁠ branch. You are welcome to report/fix/update the wiki pages.