Introduction#
This project aims to standardise gyrokinetic analysis by providing a single interface for reading and writing input and output files from different gyrokinetic codes, normalising to a common standard, and performing standard analysis methods.
A general Pyro object can be loaded either from simulation/experimental data or
from an existing gyrokinetics file.
Currently pyrokinetics can do the following:
Read data in from:
Gyrokinetic input files
Integrated modelling/Global Equilibrium simulation output
Write input files for various gyrokinetics codes
Generate N-D
Pyroobject for scansRead in gyrokinetic outputs
Standardise analysis of gyrokinetics outputs
Future development includes:
Submit gyrokinetics simulations to cluster
Integrate with GKDB to store/catalog GK runs
At a minimum pyrokinetics needs the local geometry and species data. This can be taken from a GK input file. At the moment the following local gyrokinetic codes are supported:
It is also possible to load in global data from the following codes, from which local parameters can be calculated.
JETTO
SCENE
User Guide
- Getting Started
- User Guide
- How-to Guides
- 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.
- Generate an input file from equilibrium and profiles
- Reading and plotting nonlinear outputs
- Examples
- Tutorials
Reference
Developer Guide