Skip to content

Introduction to solps-doc

Welcome to the SOLPS-ITER documentation developed at IPP Prague! Our goal is to create documentation focused on beginners. As the responsible person, Katka Hromasová, says:

“I want tutorials that are so easy to understand that, half a year from now, even I will be able to use them.”

We would like to thank our contributors:

  • Kateřina Hromasová
  • Jan Hečko
  • Aleš Podolník
  • Irina Borodkina
  • Oleg Shyshkin
  • Jakub Seidl
  • Matěj Tomeš
  • Diana Naydenkova
  • Lukáš Kripner

This documentation is developed by and for IPP Prague. It contains nearly all of Katka’s SOLPS-ITER know-how since October 2018, when she was first trained in using the code, and the combined knowledge of her colleagues. It is open to all SOLPS-ITER users for reading, but our primary focus is writing documentation for our own purposes. For this reason, many tutorials are strictly COMPASS-related and no effort is made to elucidate them to outsiders. One might therefore often need to adapt the knowledge to their own circumstances. Nonetheless, we believe that this documentation can, in a large part, be helpful to SOLPS-ITER beginners around the world.

Send your suggestions, questions and error reports to Katka: mail hromasova@ipp.cas.cz. If you are interested in contributing directly, the source code is hosted on the IPP Prague's GitLab as the solps/solps-doc project. As of this moment, internal account is needed.

Quick access to the individual chapters is provided by the sidebar on the left. The first chapter, starting with The SOLPS-ITER codebase, is dedicated to the great act of installing SOLPS-ITER on the machine of your choice. The following five tutorials take you from the beginning to the end of using SOLPS-ITER: making a simulation, running the simulation, processing its output and comparing it to experimental data. Official docs lists selected docs-related files from official sources outside of IPP Prague, mainly for convenience. Remote access explains how to do it all remotely (especially relevant now, when we're all stuck in home office). B2.5 input docs documents B2 switches. Common pitfalls covers larger problems which are ubiquitous and universal. The download table is a dump for information which takes to table form rather than text form (a few discharges, info about diagnostics, SOLPSpy variables). Questions and answers is a fragmented collection of things we have once wondered about. The Energy fluxes deep dive explains what are the SOLPS energy fluxes hitting the target and what their components are. Finally, SOLPS-ITER user wisdom contains "meta" information and treatises on various topics.

First steps

If you wish to familiarise yourself with SOLPS-ITER and solps-doc, I suggest the following: