CHERAB-PHiX documentation#
Welcome to the CHERAB-PHiX’s documentation. This package is developed to extend cherab’s fetures for PHiX - a small tokamak device developped at Tokyo Institute of Technology including specific features like Plasma emitter, device CAD, diagnostic configuration, etc.
Useful links: Source Repository | Issue Tracker | Contribution
Getting Started
New to CHERAB-PHiX? Check out the getting started guide. It contains an installation of CHERAB-PHiX and links to additional tutorials.
User Guide
The user guide provides in-depth information on the key concepts of CHERAB-PHiX with useful tutorials.
Example Gallery
Here it containes a collection of examples to experiment with CHERAB-PHiX source code.
API Reference
The reference guide contains a detailed description of the functions, modules, and objects included in CHERAB-PHiX. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts.