API Reference

This section provides function- and class-level documentation extracted automatically from the pyCIF source code. It is split into two parts:

• Base classes — the abstract plugin types defined in pycif.utils.classes. These are the building blocks every concrete plugin must implement.

• Plugin implementations — public submodules and functions of each registered plugin (execute.py, dump.py, etc.). For YAML configuration options and inter-plugin requirements, follow the back-link on each page to the plugin configuration reference.

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