High-performance orbit-following code for fusion plasma physics and engineering.
New (and old) users are welcome to join our weekly meetings or Slack channel to discuss their research and plans with regards to ASCOT5.
This repository is maintained by ASCOT team in Aalto University and VTT Technical Research Centre of Finland.
Clone the repository:
git clone https://github.com/ascot4fusion/ascot5.git
Requirements
- C compiler
- HDF5
- OpenMP
- Python >= 3.10 (pre- and postprocessing)
- MPI (optional)
- VTK (optional, for 3D wall visualization)
For running ASCOT5 on this platform and performing pre- and post-processing on another platform:
cd ascot5
make ascot5_main
The binary is located at build/ascot5_main
.
For full installation both ascot5_main and libascot.so are needed:
cd ascot5
make ascot5_main
make libascot
Useful even for minimal installation; it provides command-line tools for updating simulation options.
Create a virtual environment (optional but recommended), activate it, and install a5py
:
cd ..
virtualenv -p python3 --system-site-packages ascotenv
source ascotenv/bin/activate
pip install -e ascot5/
As an User:
- Verify your results and report violations in issues.
- Add compiling instructions for popular platforms and consider updating the table with example simulation times for novel entries.
- When benchmarking ASCOT5 against other codes or validating it against experiments, please contact the maintainers to archive the simulation for use as a regression test.
As a Developer:
- Don't let the code daunt you! We're here to assist with any feature contributions, whether it's a small post-processing tool, a new plot, or an enhancement of an existing feature.
- Start by creating an issue, then (fork and) make a branch
feature/<issuenumber>-issue
from develop. - When ready to merge, create a pull request running automated tests on your branch.
- Upon test completion and acceptance, your feature will be merged into develop for inclusion in the next release.
The ASCOT5 and associated programs are distributed under the terms of the GNU Lesser General Public License (LGPL). Please see the files COPYING and COPYING.LESSER for more information.
This has been done after the code was released to the original authors by the Dean of School of Science of Aalto University and discussion between the key contributors, including Jari Varje, Konsta Särkimäki, Antti Snicker and Simppa Äkäslompolo.