Cherab
1.4
Table of Contents
1. Welcome
2. Licence
3. Project Governance
4. Installation and Project Structure
5. Available Packages
6. Atomic Data
7. Plasmas
8. Emission Models
9. Function Framework
10. Tools
Demonstrations
Atomic Data
Creating Plasmas
Surface Radiation Loads
Active Spectroscopy
Passive Spectroscopy
Bolometry
Geometry Matrices
Code examples gallery
Cherab
Docs
»
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
Z
_
__call__()
built-in function
,
[1]
__call__() (cherab.core.atomic.gaunt.FreeFreeGauntFactor method)
(cherab.core.atomic.rates.BeamCXPEC method)
(cherab.core.distribution.DistributionFunction method)
(cherab.tools.inversions.opencl.sart_opencl.SartOpencl method)
__getitem__() (cherab.core.plasma.node.Composition method)
(cherab.tools.observers.bolometry.BolometerCamera method)
__iter__() (cherab.core.plasma.node.Composition method)
(cherab.tools.observers.bolometry.BolometerCamera method)
__len__() (cherab.tools.observers.bolometry.BolometerCamera method)
_SpectroscopicObserver0DBase (class in cherab.tools.observers.spectroscopy.base)
A
add() (cherab.core.plasma.node.Composition method)
add_foil_detector() (cherab.tools.observers.bolometry.BolometerCamera method)
add_gaussian_line (class in cherab.core.model.lineshape)
add_observer() (cherab.tools.observers.group.base.Observer0DGroup method)
AmuToKg (class in cherab.core.utility.conversion)
AngstromToNm (class in cherab.core.utility.conversion)
append() (cherab.core.utility.notify.NotifyingList method)
as_sightline() (cherab.tools.observers.bolometry.BolometerFoil method)
as_sightlines() (cherab.tools.observers.bolometry.BolometerIRVB method)
axisymmetric_mesh_from_polygon() (in module cherab.tools.primitives.axisymmetric_mesh)
AxisymmetricMapper (class in cherab.core.math.mappers)
AxisymmetricVoxel (class in cherab.tools.inversions.voxels)
B
BaseFactorConversion (class in cherab.core.utility.conversion)
Beam (class in cherab.core)
BeamCXLine (class in cherab.core.model.beam.charge_exchange)
BeamCXPEC (class in cherab.core.atomic.rates)
BeamEmissionPEC (class in cherab.core.atomic.rates)
BeamPopulationRate (class in cherab.core.atomic.rates)
BeamStoppingRate (class in cherab.core.atomic.rates)
BolometerCamera (class in cherab.tools.observers.bolometry)
BolometerFoil (class in cherab.tools.observers.bolometry)
BolometerIRVB (class in cherab.tools.observers.bolometry)
BolometerSlit (class in cherab.tools.observers.bolometry)
Bremsstrahlung (class in cherab.core.model.plasma.bremsstrahlung)
build_slab_plasma() (in module cherab.tools.plasmas.slab)
built-in function
__call__()
,
[1]
cherab.core.atomic.rates.FractionalAbundance.__call__()
cherab.core.atomic.rates.RadiatedPower.__call__()
cherab.core.atomic.rates.StageResolvedLineRadiation.__call__()
evaluate()
,
[1]
bulk_velocity() (cherab.core.distribution.DistributionFunction method)
(cherab.core.distribution.Maxwellian method)
C
Caching1D (class in cherab.core.math.caching.caching1d)
Caching2D (class in cherab.core.math.caching.caching2d)
Caching3D (class in cherab.core.math.caching.caching3d)
calculate_attenuation() (cherab.core.model.attenuator.singleray.SingleRayAttenuator method)
calculate_etendue() (cherab.tools.observers.bolometry.BolometerFoil method)
(cherab.tools.observers.bolometry.BolometerIRVB method)
calculate_sensitivity() (cherab.tools.observers.bolometry.BolometerFoil method)
(cherab.tools.observers.bolometry.BolometerIRVB method)
calculate_spectrum() (cherab.core.model.laser.model.SeldenMatobaThomsonSpectrum method)
calibrate() (cherab.tools.spectroscopy.Spectrometer method)
CartesianRayTransferEmitter (class in cherab.tools.raytransfer.emitters)
CartesianRayTransferIntegrator (class in cherab.tools.raytransfer.emitters)
cherab.core.atomic.rates.FractionalAbundance (built-in class)
cherab.core.atomic.rates.FractionalAbundance.__call__()
built-in function
cherab.core.atomic.rates.RadiatedPower (built-in class)
cherab.core.atomic.rates.RadiatedPower.__call__()
built-in function
cherab.core.atomic.rates.StageResolvedLineRadiation (built-in class)
cherab.core.atomic.rates.StageResolvedLineRadiation.__call__()
built-in function
cherab.core.math.caching.caching1d
module
cherab.core.math.caching.caching2d
module
cherab.core.math.caching.caching3d
module
cherab.core.math.clamp
module
cherab.core.math.mappers
module
cherab.core.math.mask
module
cherab.core.math.slice
module
cherab.core.utility.conversion
module
cherab.core.utility.notify
module
cherab.core.utility.recursivedict
module
ClampInput1D (class in cherab.core.math.clamp)
ClampInput2D (class in cherab.core.math.clamp)
ClampInput3D (class in cherab.core.math.clamp)
ClampOutput1D (class in cherab.core.math.clamp)
ClampOutput2D (class in cherab.core.math.clamp)
ClampOutput3D (class in cherab.core.math.clamp)
clean() (cherab.tools.inversions.opencl.sart_opencl.SartOpencl method)
clear() (cherab.core.plasma.node.Composition method)
(cherab.core.utility.notify.NotifyingList method)
Cm3ToM3 (class in cherab.core.utility.conversion)
Composition (class in cherab.core.plasma.node)
connect_pipelines() (cherab.tools.observers.group.base.Observer0DGroup method)
(cherab.tools.observers.spectroscopy.base._SpectroscopicObserver0DBase method)
ConstantBivariateGaussian (class in cherab.core.model.laser.profile)
ConstantSpectrum (class in cherab.core.model.laser.laserspectrum)
create_pipelines() (cherab.tools.spectroscopy.SpectroscopicInstrument method)
CylindricalRayTransferEmitter (class in cherab.tools.raytransfer.emitters)
CylindricalRayTransferIntegrator (class in cherab.tools.raytransfer.emitters)
CzernyTurnerSpectrometer (class in cherab.tools.spectroscopy)
D
density() (cherab.core.Beam method)
(cherab.core.distribution.DistributionFunction method)
(cherab.core.distribution.Maxwellian method)
(cherab.core.model.attenuator.singleray.SingleRayAttenuator method)
direction() (cherab.core.Beam method)
DistributionFunction (class in cherab.core.distribution)
E
effective_temperature() (cherab.core.distribution.DistributionFunction method)
(cherab.core.distribution.Maxwellian method)
EFITEquilibrium (class in cherab.tools.equilibrium.efit)
Element (class in cherab.core.atomic.elements)
emissivities_from_function() (cherab.tools.inversions.voxels.VoxelCollection method)
emissivity_from_function() (cherab.tools.inversions.voxels.AxisymmetricVoxel method)
evaluate()
built-in function
,
[1]
evaluate() (cherab.core.atomic.gaunt.FreeFreeGauntFactor method)
(cherab.core.atomic.gaunt.InterpolatedFreeFreeGauntFactor method)
(cherab.core.atomic.rates.BeamCXPEC method)
EvAmuToMS (class in cherab.core.utility.conversion)
EvToJ (class in cherab.core.utility.conversion)
example_equilibrium() (in module cherab.tools.equilibrium.example)
extend() (cherab.core.utility.notify.NotifyingList method)
F
FibreOpticGroup (class in cherab.tools.observers.group)
FreeFreeGauntFactor (class in cherab.core.atomic.gaunt)
freeze() (cherab.core.utility.recursivedict.RecursiveDict method)
from_dict() (cherab.core.utility.recursivedict.RecursiveDict class method)
G
GaussianBeamAxisymmetric (class in cherab.core.model.laser.profile)
GaussianLine (class in cherab.core.model.lineshape)
GaussianSpectrum (class in cherab.core.model.laser.laserspectrum)
generate_geometry() (cherab.core.laser.profile.LaserProfile method)
get() (cherab.core.plasma.node.Composition method)
get_energy_density() (cherab.core.laser.profile.LaserProfile method)
get_pipeline() (cherab.tools.observers.spectroscopy.base._SpectroscopicObserver0DBase method)
get_pointing() (cherab.core.laser.profile.LaserProfile method)
get_polarization() (cherab.core.laser.profile.LaserProfile method)
I
ImpactExcitationPEC (class in cherab.core.atomic.rates)
import_eqdsk() (in module cherab.tools.equilibrium.eqdsk)
insert() (cherab.core.utility.notify.NotifyingList method)
Interpolate1DCubic (class in cherab.core.math.interpolators.interpolators1d)
Interpolate1DLinear (class in cherab.core.math.interpolators.interpolators1d)
Interpolate2DCubic (class in cherab.core.math.interpolators.interpolators2d)
Interpolate2DLinear (class in cherab.core.math.interpolators.interpolators2d)
Interpolate3DCubic (class in cherab.core.math.interpolators.interpolators3d)
Interpolate3DLinear (class in cherab.core.math.interpolators.interpolators3d)
InterpolatedFreeFreeGauntFactor (class in cherab.core.atomic.gaunt)
inv() (cherab.core.utility.conversion.BaseFactorConversion class method)
(cherab.core.utility.conversion.EvAmuToMS class method)
(cherab.core.utility.conversion.PhotonToJ class method)
invert_constrained_sart() (in module cherab.tools.inversions.sart)
invert_regularised_nnls() (in module cherab.tools.inversions.nnls)
invert_sart() (in module cherab.tools.inversions.sart)
invert_svd() (in module cherab.tools.inversions.svd)
invert_voxel_map() (cherab.tools.raytransfer.raytransfer.RayTransferObject method)
ion_density() (cherab.core.Plasma method)
IsoMapper2D (class in cherab.core.math.mappers)
IsoMapper3D (class in cherab.core.math.mappers)
Isotope (class in cherab.core.atomic.elements)
L
LaserModel (class in cherab.core.laser.model)
LaserProfile (class in cherab.core.laser.profile)
LaserSpectrum (class in cherab.core.laser.laserspectrum)
Line (class in cherab.core.atomic.line)
LineShapeModel (class in cherab.core.model.lineshape)
lookup_element() (in module cherab.core.atomic.elements)
lookup_isotope() (in module cherab.core.atomic.elements)
M
map2d() (cherab.tools.equilibrium.efit.EFITEquilibrium method)
map3d() (cherab.tools.equilibrium.efit.EFITEquilibrium method)
map_vector2d() (cherab.tools.equilibrium.efit.EFITEquilibrium method)
map_vector3d() (cherab.tools.equilibrium.efit.EFITEquilibrium method)
Maxwellian (class in cherab.core.distribution)
MaxwellianFreeFreeGauntFactor (class in cherab.core.atomic.gaunt)
module
cherab.core.math.caching.caching1d
cherab.core.math.caching.caching2d
cherab.core.math.caching.caching3d
cherab.core.math.clamp
cherab.core.math.mappers
cherab.core.math.mask
cherab.core.math.slice
cherab.core.utility.conversion
cherab.core.utility.notify
cherab.core.utility.recursivedict
MultipletLineShape (class in cherab.core.model.lineshape)
N
names (cherab.tools.observers.group.base.Observer0DGroup property)
Notifier (class in cherab.core.utility.notify)
NotifyingList (class in cherab.core.utility.notify)
O
observe() (cherab.tools.observers.bolometry.BolometerCamera method)
(cherab.tools.observers.group.base.Observer0DGroup method)
Observer0DGroup (class in cherab.tools.observers.group.base)
observers (cherab.tools.observers.group.base.Observer0DGroup property)
P
ParametrisedZeemanTriplet (class in cherab.core.model.lineshape)
parent_all_voxels() (cherab.tools.inversions.voxels.VoxelCollection method)
PerCm3ToPerM3 (class in cherab.core.utility.conversion)
PhotonToJ (class in cherab.core.utility.conversion)
pipelines (cherab.tools.observers.group.base.Observer0DGroup property)
PixelGroup (class in cherab.tools.observers.group)
Plasma (class in cherab.core)
plot() (cherab.tools.inversions.voxels.ToroidalVoxelGrid method)
plot_equilibrium() (in module cherab.tools.equilibrium.plot)
plot_spectrum() (cherab.tools.observers.spectroscopy.base._SpectroscopicObserver0DBase method)
Polychromator (class in cherab.tools.spectroscopy)
PolychromatorFilter (class in cherab.tools.spectroscopy)
PolygonMask2D (class in cherab.core.math.mask)
pop() (cherab.core.utility.notify.NotifyingList method)
R
RadiationFunction (class in cherab.tools.emitters.radiation_function)
RayTransferBox (class in cherab.tools.raytransfer.raytransfer)
RayTransferCylinder (class in cherab.tools.raytransfer.raytransfer)
RayTransferEmitter (class in cherab.tools.raytransfer.emitters)
RayTransferIntegrator (class in cherab.tools.raytransfer.emitters)
RayTransferObject (class in cherab.tools.raytransfer.raytransfer)
RayTransferPipeline0D (class in cherab.tools.raytransfer.pipelines)
RayTransferPipeline1D (class in cherab.tools.raytransfer.pipelines)
RayTransferPipeline2D (class in cherab.tools.raytransfer.pipelines)
RecombinationPEC (class in cherab.core.atomic.rates)
RecursiveDict (class in cherab.core.utility.recursivedict)
remove() (cherab.core.utility.notify.NotifyingList method)
render_engine (cherab.tools.observers.group.base.Observer0DGroup property)
resolution() (cherab.tools.spectroscopy.CzernyTurnerSpectrometer method)
reverse() (cherab.core.utility.notify.NotifyingList method)
S
sample1d() (in module cherab.core.math.samplers)
sample1d_points() (in module cherab.core.math.samplers)
sample2d() (in module cherab.core.math.samplers)
sample2d_grid() (in module cherab.core.math.samplers)
sample2d_points() (in module cherab.core.math.samplers)
sample3d() (in module cherab.core.math.samplers)
sample3d_grid() (in module cherab.core.math.samplers)
sample3d_points() (in module cherab.core.math.samplers)
samplevector2d() (in module cherab.core.math.samplers)
samplevector2d_grid() (in module cherab.core.math.samplers)
samplevector2d_points() (in module cherab.core.math.samplers)
samplevector3d() (in module cherab.core.math.samplers)
samplevector3d_grid() (in module cherab.core.math.samplers)
samplevector3d_points() (in module cherab.core.math.samplers)
SartOpencl (class in cherab.tools.inversions.opencl.sart_opencl)
ScalarToVectorFunction2D (in module cherab.core.math.function)
ScalarToVectorFunction3D (in module cherab.core.math.function)
SeldenMatobaThomsonSpectrum (class in cherab.core.model.laser.model)
set() (cherab.core.plasma.node.Composition method)
set_active() (cherab.tools.inversions.voxels.VoxelCollection method)
set_energy_density_function() (cherab.core.laser.profile.LaserProfile method)
set_pointing_function() (cherab.core.laser.profile.LaserProfile method)
set_polarization_function() (cherab.core.laser.profile.LaserProfile method)
show_supported_transitions() (cherab.core.model.lineshape.ParametrisedZeemanTriplet method)
(cherab.core.model.lineshape.StarkBroadenedLine method)
SightLineGroup (class in cherab.tools.observers.group)
SingleRayAttenuator (class in cherab.core.model.attenuator.singleray)
Slice2D (class in cherab.core.math.slice)
Slice3D (class in cherab.core.math.slice)
sort() (cherab.core.utility.notify.NotifyingList method)
Species (class in cherab.core)
Spectrometer (class in cherab.tools.spectroscopy)
SpectroscopicFibreOptic (class in cherab.tools.observers.spectroscopy)
SpectroscopicInstrument (class in cherab.tools.spectroscopy)
SpectroscopicSightLine (class in cherab.tools.observers.spectroscopy)
StarkBroadenedLine (class in cherab.core.model.lineshape)
Swizzle2D (class in cherab.core.math.mappers)
Swizzle3D (class in cherab.core.math.mappers)
T
targets (cherab.tools.observers.group.TargettedPixelGroup property)
TargettedPixelGroup (class in cherab.tools.observers.group)
ThermalCXPEC (class in cherab.core.atomic.rates)
to() (cherab.core.utility.conversion.BaseFactorConversion class method)
(cherab.core.utility.conversion.EvAmuToMS class method)
(cherab.core.utility.conversion.PhotonToJ class method)
toroidal_mesh_from_polygon() (in module cherab.tools.primitives.toroidal_mesh)
ToroidalVoxelGrid (class in cherab.tools.inversions.voxels)
trace_sightline() (cherab.tools.observers.bolometry.BolometerFoil method)
trace_sightlines() (cherab.tools.observers.bolometry.BolometerIRVB method)
TrapezoidalFilter (class in cherab.tools.spectroscopy)
TrivariateGaussian (class in cherab.core.model.laser.profile)
U
UniformEnergyDensity (class in cherab.core.model.laser.profile)
unparent_all_voxels() (cherab.tools.inversions.voxels.VoxelCollection method)
update_laplacian_matrix() (cherab.tools.inversions.opencl.sart_opencl.SartOpencl method)
V
VectorAxisymmetricMapper (class in cherab.core.math.mappers)
VectorFunction2D (in module cherab.core.math.function)
VectorFunction3D (in module cherab.core.math.function)
Voxel (class in cherab.tools.inversions.voxels)
VoxelCollection (class in cherab.tools.inversions.voxels)
Z
z_effective() (cherab.core.Plasma method)
ZeemanLineShapeModel (class in cherab.core.model.lineshape)
ZeemanMultiplet (class in cherab.core.model.lineshape)
ZeemanStructure (class in cherab.core.atomic.zeeman)
ZeemanTriplet (class in cherab.core.model.lineshape)