list_models

Context: models

Synopsis

List the available model types.

Syntax

list_models(show: str = 'all')

Returns: list[str]

Examples

Example 1

>>> models = list_models()
>>> models[0:5]
['absorptionedge',
 'absorptiongaussian',
 'absorptionlorentz',
 'absorptionvoigt',
 'accretiondisk']

Example 2

>>> list_models('2d')
['beta2d',
 'box2d',
 'const2d',
 'delta2d',
 'devaucouleurs2d',
 'disk2d',
 'gauss2d',
 'lorentz2d',
 'normgauss2d',
 'polynom2d',
 'scale2d',
 'sersic2d',
 'shell2d',
 'sigmagauss2d']

PARAMETERS

The parameter for this function is:

Parameter	Type information	Definition
show	{ 'all', '1d', '2d', 'xspec' }, optional	What type of model should be returned. The default is 'all'. An unrecognized value is treated as 'all'.

Return value

The return value from this function is:

models -- list of str

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.