lair.pollutants.Pollutant.label#

Pollutant.label(units=True, latex=True)[source]#

Build an axis label, e.g. '$\mathrm{CH_4}$ [ppm]'.

Parameters:
  • units (bool) – Append the units in brackets. Default True.

  • latex (bool) – Use the mathtext forms. Default True; False gives 'CH4 [ppm]'.

Returns:

str – The label.

Return type:

str

See also

get_pollutant

Look one up by name.

Examples

>>> from lair.pollutants import get_pollutant
>>> pm = get_pollutant("pm25")
>>> pm.label(latex=False)
'PM2.5 [ug/m3]'
>>> pm.label(units=False, latex=False)
'PM2.5'