This project aims to standardise gyrokinetic analysis.
A general pyro object can be loaded either from simulation/experimental data or from an existing gyrokinetics file.
In general pyrokinetics can do the following
- Read data in from:
- Gyrokinetic input files
- Simulations outputs
- Write input files for various GK codes
- WIP: Generate N-D pyro object for scans
- WIP: Read in gyrokinetic outputs
- WIP: Standardise analysis of gk outputs
At a minimum pyrokinetics needs the local geometry and species data. Example scripts can be found in the examples folder
Install pyrokinetics with pip as follows
pip install --user pyrokinetics
Otherwise, for the latest version install directly with
$ git clone https://github.com/pyro-kinetics/pyrokinetics.git
$ cd pyrokinetics
$ python setup.py install --user
Pyro object comprised of
- Equilibrium
- LocalGeometry
- Miller
- Fourier (to be added)
- LocalGeometry
- Kinetics
- LocalSpecies
- Numerics
- GKCodes
There also exists the PyroScan object which allows you to make a N-D parameter scan of Pyro objects
pyrokinetics currently supports
- GEQDSK
Future formats to be added are
- CHEASE
Sources of kinetic profile data currently supported are
- SCENE
- JETTO
- TRANSP
Future codes to be add
- SimDB
- OMFIT
The following gk codes are supported in pyrokinetics
- CGYRO
- GS2
- GENE
Codes to be added in the future
- TGLF
The pyro object uses standardised reference values to normalise the results. It will automatically handle converting to a GK codes standard units.
Note any scans/parameter changes made will be in standard pyro units so please account for this.
Reference values
It is possible to change the reference units but proceed with caution
This project is used by the following institutions
- CCFE
- University of York