Plugin API Reference
====================

Function-level documentation for every plugin, organised by type.
Each page documents the public submodules of a plugin implementation.
For YAML configuration options and requirements, follow the links on
each page back to the plugin configuration reference.

.. toctree::
   :maxdepth: 2
   :titlesonly:

   chemistries/TM5
   chemistries/chimere
   chemistries/iconart
   chemistries/lmdz
   controlvects/standard
   datastreams/backgrounds/carboscope_bg
   datastreams/backgrounds/tm5_background
   datastreams/fields/bc_plugin_template
   datastreams/fields/chimere_icbc
   datastreams/fields/grib2_ecmwf
   datastreams/fields/gridded_NetCDF_inicond
   datastreams/fields/iconart_icbc
   datastreams/fields/lmdz_chemfield
   datastreams/fields/lmdz_chemfield_ico
   datastreams/fields/lmdz_chemfield_reg
   datastreams/fields/lmdz_ic
   datastreams/fields/lmdz_inicond_ico
   datastreams/fields/lmdz_inicond_reg
   datastreams/fields/lmdz_outfields_nc
   datastreams/fields/lmdz_prodloss3d
   datastreams/fields/netcdf_cams
   datastreams/fields/noaa_glob_avg
   datastreams/fields/oldlmdz_ic
   datastreams/fields/oldlmdz_photochem
   datastreams/fields/oldlmdz_prescrconcs
   datastreams/fields/tm5_ic
   datastreams/fields/wrfchem_icbc
   datastreams/fluxes/CAMSREG_nc
   datastreams/fluxes/CMEMS
   datastreams/fluxes/CarbonMonitor
   datastreams/fluxes/EDGARv8_EYECLIMA_nc
   datastreams/fluxes/GCP_1x1
   datastreams/fluxes/GCP_1x1_N2O
   datastreams/fluxes/GFEDv4
   datastreams/fluxes/GridFED
   datastreams/fluxes/TNO_nc
   datastreams/fluxes/VPRM1km_nc
   datastreams/fluxes/VPRM_nc
   datastreams/fluxes/becker_ocean
   datastreams/fluxes/chimere
   datastreams/fluxes/dummy_nc
   datastreams/fluxes/dummy_txt
   datastreams/fluxes/edgar_v5
   datastreams/fluxes/flexpart
   datastreams/fluxes/flux_plugin_template
   datastreams/fluxes/gridded_NetCDF
   datastreams/fluxes/iconart
   datastreams/fluxes/lmdz_bin
   datastreams/fluxes/lmdz_netcdf_ico
   datastreams/fluxes/lmdz_netcdf_reg
   datastreams/fluxes/lmdz_sflx
   datastreams/fluxes/orchidee
   datastreams/fluxes/point_sources
   datastreams/fluxes/tm5
   datastreams/fluxes/unstructured_NetCDF
   datastreams/fluxes/wrfchem
   datastreams/meteos/chimere_meteo
   datastreams/meteos/dummy_csv
   datastreams/meteos/lmdz_mass_fluxes
   datastreams/meteos/lmdz_massflx_old
   datastreams/meteos/tm5_meteo
   datavects/standard
   domains/chimere
   domains/dummy
   domains/dynamico
   domains/flexpart
   domains/grib_ecmwf
   domains/gridded_NetCDF
   domains/iconart
   domains/lmdz
   domains/lmdz_ico
   domains/lmdz_reg
   domains/unstructured_NetCDF
   domains/wrfchem
   minimizers/congrad
   minimizers/m1qn3
   minimizers/scipy
   minimizers/scipy_conjugate
   models/TM5
   models/chimere
   models/chimere_acc
   models/dummy
   models/iconart
   models/lagrangian
   models/lmdz_acc
   models/lmdz_ico
   models/lmdz_old
   models/satwetch4
   models/template
   models/wrfchem
   modes/adjtl_test
   modes/analytic
   modes/co2mvs
   modes/ensrf
   modes/footprint
   modes/forward
   modes/postproc
   modes/response_functions
   modes/variational
   obsoperators/fp
   obsoperators/random
   obsoperators/standard
   obsparsers/CO2M
   obsparsers/icos
   obsparsers/obspack
   obsparsers/tropomi_blended
   obsparsers/tropomi_official
   obsparsers/tropomi_rpro
   obsparsers/tropomi_sron
   obsparsers/tropomi_wfmd
   obsparsers/verify
   obsparsers/wdcgg
   obsvects/standard
   platforms/docker_cif
   platforms/docker_nvidia
   platforms/ecmwf_ecs
   platforms/empa_daint
   platforms/fmi_puhti
   platforms/jean_zay
   platforms/lsce_obelix
   platforms/lsce_obelix_nvidia
   platforms/tgcc_ccrt
   platforms/tgcc_ccrt_nvidia
   simulators/dummy
   simulators/gausscost
   simulators/gausscost_flexpart
   transforms/basic/background
   transforms/basic/clipcrop
   transforms/basic/exp
   transforms/basic/families
   transforms/basic/product
   transforms/basic/regrid
   transforms/basic/time_interpolation
   transforms/basic/unit_conversion
   transforms/basic/vertical_interpolation
   transforms/complex/conc2ratio
   transforms/complex/diagmet
   transforms/complex/isotopes
   transforms/complex/moist2dry
   transforms/complex/ratio2conc
   transforms/complex/satellites
   transforms/system/array2sampled
   transforms/system/dump2format
   transforms/system/dump2inputs
   transforms/system/fromcontrol
   transforms/system/loadfromoutputs
   transforms/system/run_model
   transforms/system/sparse2sample
   transforms/system/toobsvect