How-to Guides

Todo

These how-to guides give an overview of how to accomplish different tasks with pyrokinetics, and signpost the user towards more detailed documentation

How do I…?

• Convert input files from code A to code B
• Reading and plotting linear outputs
• Merge (multiple) species into a base species
• Normalisation conventions
• Using Units
• Reference values
• Outputs
• Perform a N-D scan in parameters A,B,C etc.
  • Simple 1-D scan
  • Running/Submitting simulations
  • Analysing output
  • Higher dimensional scans
  • Bespoke parameters/functions
• Generate an input file from equilibrium and profiles
• Reading and plotting nonlinear outputs

Todo

Write all of these

• Read kinetics/equilibrium data from A and make input file for gk code B…

• Look at linear/nonlinear outputs…

• Run a scan in parameter A, B, C…

• Generation of input files from data sources like GEQDSK and TRANSP…

• Conversion of input files from one GK code to another…

• Cross-code validation for simple and complicated geometries…

• Performing scans using the code…

• Reading and plotting of basic output data…

• More advanced output analysis (Poincare plots, field line tearing, non-zonal transitions)…

• Applications of generation database for ML training…

• Synthetic diagnostic comparisons…

• Using GK outputs with QL saturation rules…

• Submitting simulations to databases (simDB, GKDB) via IMAS DD…

• Submitting jobs to cluster…

• Storing metadata of simulations…

• Access metric elements (jacobian, gxx, gxy, etc…)…

• How to use synthetic diagnostics…