Cherab’s documentation

Welcome to the Cherab project. A python library for forward modelling diagnostics based on spectroscopic plasma emission.

Please note that these documentation pages are in a state of flux and might not become stable until we have finished moving the source code to github.

Table of Contents

• 1. Welcome
  • 1.1. Current Development Team
  • 1.2. Contributors
  • 1.3. Project History
  • 1.4. Citations
  • 1.5. Publications
• 2. Licence
  • 2.1. European Union Public Licence
• 3. Project Governance
  • 3.1. Rationale
  • 3.2. Overview
  • 3.3. Roles and responsibilities
  • 3.4. Decision making process
• 4. Installation and Project Structure
  • 4.1. Prerequisites
  • 4.2. Project Structure
  • 4.3. Installation
  • 4.4. Configuring Atomic Data
  • 4.5. Testing
• 5. Available Packages
  • 5.1. Atomic Data Providers
  • 5.2. Fusion Experiment Packages
  • 5.3. Code Interface Packages
• 6. Atomic Data
  • 6.1. Elements and Isotopes
  • 6.2. Spectroscopic Emission Lines
  • 6.3. Rate Coefficients
  • 6.4. Gaunt factors
• 7. Plasmas
  • 7.1. Core Plasma Classes
  • 7.2. Plasma equilibrium
  • 7.3. Mono-energetic Particle Beams
  • 7.4. Laser
• 8. Emission Models
  • 8.1. Custom emission models
  • 8.2. CXS models
  • 8.3. Calculation of predicted charge-exchange spectra seen by a line-of-sight
  • 8.4. BES - Beam Emission Spectroscopy
  • 8.5. Total Radiated Power
  • 8.6. Bremsstrahlung
  • 8.7. Basic Line Emission
  • 8.8. Spectral Line Shapes
  • 8.9. Laser
• 9. Function Framework
  • 9.1. Caching
  • 9.2. Clamps
  • 9.3. Functions
  • 9.4. Interpolators
  • 9.5. Mappers
  • 9.6. Masks
  • 9.7. Samplers
  • 9.8. Slicing
• 10. Tools
  • 10.1. Plasmas
  • 10.2. Materials
  • 10.3. Primitives
  • 10.4. Observers
  • 10.5. Spectroscopy
  • 10.6. Tomography
  • 10.7. Utilities

Demonstrations

• Atomic Data
• Creating Plasmas
• Surface Radiation Loads
• Active Spectroscopy
• Passive Spectroscopy
• Bolometry
• Geometry Matrices
• Code examples gallery

Indices and tables

• Index

• Module Index