Skip to main content
Back to top
Ctrl
+
K
pyrokinetics 0.6.2.dev276+g5870b09.d20240515 documentation
User Guide
Getting Started
User Guide
Structure
Analysis
LocalGeometryMiller
Toroidal coordinate system
Collision frequency
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
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
Ideal ballooning solver
Load JETTO data
Load TRANSP data
Parameter scans
Pyro basic usage
Read GK Outputs
Tutorials
Equilibrium Tutorial
File Readers
Using Pyrokinetics on HPC Systems
Reference
API Reference
pyrokinetics
pyrokinetics.cli
pyrokinetics.cli.convert
pyrokinetics.cli.entrypoint
pyrokinetics.cli.generate
pyrokinetics.constants
pyrokinetics.databases
pyrokinetics.databases.imas
pyrokinetics.dataset_wrapper
pyrokinetics.dataset_wrapper.DatasetWrapper
pyrokinetics.decorators
pyrokinetics.decorators.not_implemented
pyrokinetics.diagnostics
pyrokinetics.diagnostics.gamma_ball_full
pyrokinetics.diagnostics.Diagnostics
pyrokinetics.equilibrium
pyrokinetics.equilibrium.equilibrium
pyrokinetics.equilibrium.flux_surface
pyrokinetics.equilibrium.gacode
pyrokinetics.equilibrium.geqdsk
pyrokinetics.equilibrium.transp
pyrokinetics.equilibrium.utils
pyrokinetics.factory
pyrokinetics.factory.Factory
pyrokinetics.file_utils
pyrokinetics.file_utils.AbstractFileReader
pyrokinetics.file_utils.FileReader
pyrokinetics.file_utils.FileReaderFactory
pyrokinetics.file_utils.ReadableFromFile
pyrokinetics.file_utils.FileInferenceException
pyrokinetics.gk_code
pyrokinetics.gk_code.cgyro
pyrokinetics.gk_code.gene
pyrokinetics.gk_code.gk_input
pyrokinetics.gk_code.gk_output
pyrokinetics.gk_code.gkw
pyrokinetics.gk_code.gs2
pyrokinetics.gk_code.ids
pyrokinetics.gk_code.tglf
pyrokinetics.kinetics
pyrokinetics.kinetics.gacode
pyrokinetics.kinetics.jetto
pyrokinetics.kinetics.kinetics
pyrokinetics.kinetics.pfile
pyrokinetics.kinetics.scene
pyrokinetics.kinetics.transp
pyrokinetics.local_geometry
pyrokinetics.local_geometry.fourier_cgyro
pyrokinetics.local_geometry.fourier_gene
pyrokinetics.local_geometry.local_geometry
pyrokinetics.local_geometry.metric
pyrokinetics.local_geometry.miller
pyrokinetics.local_geometry.miller_turnbull
pyrokinetics.local_geometry.mxh
pyrokinetics.local_species
pyrokinetics.local_species.LocalSpecies
pyrokinetics.metadata
pyrokinetics.metadata.metadata
pyrokinetics.normalisation
pyrokinetics.normalisation.NORMALISATION_CONVENTIONS
pyrokinetics.normalisation.convert_dict
pyrokinetics.normalisation.Convention
pyrokinetics.normalisation.ConventionNormalisation
pyrokinetics.normalisation.SimulationNormalisation
pyrokinetics.numerics
pyrokinetics.numerics.Numerics
pyrokinetics.plugins
pyrokinetics.plugins.register_file_reader_plugins
pyrokinetics.pyro
pyrokinetics.pyro.Pyro
pyrokinetics.pyroscan
pyrokinetics.pyroscan.cd
pyrokinetics.pyroscan.get_attr_or_item
pyrokinetics.pyroscan.get_from_dict
pyrokinetics.pyroscan.set_in_dict
pyrokinetics.pyroscan.NumpyEncoder
pyrokinetics.pyroscan.PyroScan
pyrokinetics.species
pyrokinetics.species.Species
pyrokinetics.templates
pyrokinetics.typing
pyrokinetics.units
pyrokinetics.units.ureg
pyrokinetics.units.Normalisation
pyrokinetics.units.PyroQuantity
pyrokinetics.units.PyroUnitRegistry
pyrokinetics.units.UnitSpline
pyrokinetics.units.UnitSpline2D
pyrokinetics.units.PyroNormalisationError
Developer Guide
Contributing Guide
Writing Documentation
Repository
Suggest edit
Open issue
.rst
.pdf
pyrokinetics.constants
pyrokinetics.constants
#