Plugins in pyCIF

Plugin documentation

• Plugins: what are they?
  • CIF Classes
• Requirements and dependencies in pyCIF
  • Types of dependencies
  • Definition of dependencies
  • Behaviour with dependencies
  • Cheat sheet for checking plugins dependencies in yaml files

List of all plugins in pyCIF

• Chemistries chemistry
  • CHIMERE/gasJtab CHIMERE/gasJtab
  • ICON-ART/std ICON-ART/std
  • LMDZ/SACS LMDZ/SACS
  • TM5/SINK-TIPP TM5/SINK-TIPP
• Controlvects controlvect
  • Standard CIF control vector standard/std
• Datastreams datastream
  • Backgrounds datastream
    • TM5-4DVAR/rodenbeck TM5-4DVAR/rodenbeck
    • carboscope/std carboscope/std
  • Fields datastream
    • CAMS netcdf files CAMS/netcdf
    • CHIMERE INI_CONCS and BOUN_CONCS netcdf files CHIMERE/icbc
    • ECMWF grib2 data files ECMWF/grib2
    • Global averages from NOAA data NOAA/glob_avg
    • Gridded NetCDF initial conditions gridded_netcdf/std
    • ICON-ART initial and lateral boundary conditions ICON-ART/icbc
    • LMDz 4 72x96x19 grid photorates oldLMDZ/photochem
    • LMDz 4 72x96x19 grid prescribed concentrations oldLMDZ/prescrconcs
    • LMDz 4 72x96x19 grid restart oldLMDZ/ic
    • LMDz chemical field LMDZ/chemfield
    • LMDz chemical field on icosahedral grid LMDZ/chemfield-dynamico
    • LMDz chemical field on regular lat-lon grid LMDZ/chemfield-regular
    • LMDz initial condition for mixing ratio on icosahedral grid LMDZ/inicond-dynamico
    • LMDz initial condition for mixing ratio on regular lat-lon grid LMDZ/inicond-regular
    • LMDz photorates LMDZ/photochem
    • LMDz prescribed concentrations LMDZ/prescrconcs
    • LMDz production and loss fields LMDZ/prodloss3d
    • LMDz restart concentrations LMDZ/ic
    • LMDz trajq files LMDZ-trajq/netcdf
    • TM5 initial condition files TM5/ic
    • Template plugin for BCs BCs/template
    • wrfchem/icbc wrfchem/icbc
  • Fluxes datastream
    • EDGAR/v5 EDGAR/v5
    • Becker coastal fluxes becker/ocean
    • CAMSREG/netcdf CAMSREG/netcdf
    • CHIMERE AEMISSIONS and BEMISSIONS netcdf files CHIMERE/AEMISSIONS
    • CarbonMonitor/netcdf CarbonMonitor/netcdf
    • Copernicus Marine Service CO2 fluxes CMEMS/std
    • Dummy model - NetCDF dummy/nc
    • Dummy model - text dummy/txt
    • EDGARv8/time_profile EDGARv8/time_profile
    • FLEXPART/nc FLEXPART/nc
    • Fluxes from csv-formatted point sources point_sources/std
    • GCP at 1 degree x 1 degree GCP_N2O/1x1
    • Global Carbon Fluxes GCP/1x1
    • Global Fire Emission Database v4 GFED4/std
    • GridFED emission database GridFED/std
    • Gridded NetCDF surface flux gridded_netcdf/std
    • ICON-ART surface fluxes ICON-ART/sflx
    • INS/2012web INS/2012web
    • LMDZ/bin LMDZ/bin
    • LMDZ surface fluxes LMDZ/sflx
    • LMDZ surface fluxes on icosahedral grid LMDZ/netcdf-dynamico
    • LMDZ surface fluxes on regular lat-lon grid LMDZ/netcdf-regular
    • ORCHIDEE surface fluxes orchidee/std
    • TM5/std TM5/std
    • TNO/netcdf TNO/netcdf
    • Template plugin for fluxes flux/template
    • Unstructured grid NetCDF surface flux gridded_netcdf/unstructured
    • VPRM/netcdf VPRM/netcdf
    • VPRM1km/netcdf VPRM1km/netcdf
    • wrfchem/std wrfchem/std
  • Meteos datastream
    • CHIMERE/std CHIMERE/std
    • LMDZ/mass-fluxes LMDZ/mass-fluxes
    • TM5/std TM5/std
    • dummy/csv dummy/csv
• Datavects datavect
  • Standard CIF data vector standard/std
• Domains domain
  • CHIMERE HCOORD/VCOORD domain CHIMERE/std
  • Dynamico grid dynamico/std
  • FLEXPART/std FLEXPART/std
  • Gridded NetCDF domain gridded_netcdf/std
  • ICON-ART/std ICON-ART/std
  • LMDZ dynamico domain LMDZ/dynamico
  • LMDZ regular lat-lon domain LMDZ/regular
  • LMDz grid LMDZ/std
  • Unstructured grid NetCDF domain gridded_netcdf/unstructured
  • dummy/std dummy/std
  • wrfchem/std wrfchem/std
• Measurements measurements
  • Concatenation of observations from parsers standard/std
  • Random generation of observations random/param
• Minimizers minimizer
  • M1QN3/std M1QN3/std
  • congrad/std congrad/std
  • scipy/std scipy/std
  • scipy/conjugate scipy/conjugate
• Models model
  • CHIMERE/std CHIMERE/std
  • CHIMERE with OpenACC annotations CHIMERE/acc
  • ICOsahedral Nonhydrostatic weather- and climate model with Aerosols and Reactive Trace gases ICON-ART/std
  • LMDZ/std LMDZ/std
  • LMDZ with regular and dynamico grids LMDZ/reg-ico
  • LMDz with OpenACC annotations LMDZ/acc
  • Lagrangian/std Lagrangian/std
  • SatWetCH4 v.1 Juliette Bernard et al., 2024 satwetch4/std
  • TM5/std TM5/std
  • Template for model implementation template/std
  • dummy/std dummy/std
  • wrfchem/std wrfchem/std
• Modes mode
  • 4DVAR variational inversions 4dvar/std
  • Analytical inversions analytic/std
  • Ensemble Square-Root Filter EnSRF/std
  • Footprints or backward mode footprint/std
  • Forward run forward/std
  • Response functions response-functions/std
  • Test of the adjoint adj-tl_test/std
  • post-proc/std post-proc/std
• Obsoperators obsoperator
  • FLEXINVERT/std FLEXINVERT/std
  • Main CIF observation operator standard/std
  • Random observation operator for testing random/std
• Obsparsers obsparser
  • CO2M pseudo_data CO2M/pseudo_data
  • Integrated Carbon Observing System (ICOS) data ICOS/std
  • NOAA-ESRL Observation Package (ObsPack) Data Products obspack/std
  • TROPOMI XCH4 retrievals – Official RPRO product TROPOMI/CH4-RPRO
  • TROPOMI XCH4 retrievals – Official product TROPOMI/CH4-official
  • TROPOMI XCH4 retrievals from SRON TROPOMI/CH4-SRON
  • TROPOMI XCH4 retrievals from the University of Bremen TROPOMI/CH4-WFMD
  • TROPOMI-GOSAT XCH4 retrievals from Balasus TROPOMI/CH4-BLENDED
  • Template plugin for observation parsers template/std
  • VERIFY/std VERIFY/std
  • WDCGG/std WDCGG/std
• Obsvects obsvect
  • standard/std standard/std
• Platforms platform
  • Bologna’s ECMWF cluster ECMWF/ecs
  • CSC-Puhti’s FMI cluster FMI/Puhti
  • CSCS - Swiss National Supercomputing Centre EMPA/daint
  • Centre de Calcul Recherche et Technologie (AMD/rome) TGCC-CCRT/AMD
  • Centre de Calcul Recherche et Technologie (skylake) TGCC-CCRT/std
  • Centre de Calcul Recherche et Technologie with NVIDIA environnement TGCC-CCRT/nvidia
  • Docker container for pycif docker/cif
  • Docker container for pycif with nvidia HPC environment docker/nvidia
  • ESPRI Spirit/SpiritX cluster with NVIDIA environment ESPRI/spirit-nvidia
  • LAERO’s cluster LAERO/nuwa
  • LSCE’s cluster LSCE/obelix
  • LSCE’s cluster with NVIDIA environnement LSCE/obelix-nvidia
• Simulators simulator
  • dummy_txt/std dummy_txt/std
  • gausscost/std gausscost/std
  • gausscost/FLEXPART gausscost/FLEXPART
• Transforms transform
  • Basic transform
    • Adding background to simulations background/std
    • Clip & crop clipcrop/std
    • Element-wise product product/std
    • Horizontal re-gridding regrid/std
    • Temporal interpolation and re-indexing time_interpolation/std
    • Tracer families or addition families/std
    • Unit conversion unit_conversion/std
    • Vertical interpolation and re-mapping vertical_interpolation/std
    • exponential exp/std
  • Complex transform
    • DIAGMET meteorological processing for CHIMERE diagmet/std
    • Processing of satellite observations satellites/std
    • conc2ratio/std conc2ratio/std
    • isotopes/std isotopes/std
    • moist2dry/std moist2dry/std
    • ratio2conc/std ratio2conc/std
  • System transform
    • Computing a transport model run_model/std
    • Data initialization from the control vector fromcontrol/std
    • Dump to specific format dump2format/std
    • Dump to transform inputs dump2inputs/std
    • Process data to the observation vector toobsvect/std
    • Read model output to data loadfromoutputs/std
    • array2sampled/std array2sampled/std
    • sparse2sample/std sparse2sample/std