API

• uwtools.api.cdeps
  • CDEPS
    • CDEPS.atm()
    • CDEPS.atm_nml()
    • CDEPS.atm_stream()
    • CDEPS.config
    • CDEPS.config_full
    • CDEPS.cycle
    • CDEPS.driver_name
    • CDEPS.ocn()
    • CDEPS.ocn_nml()
    • CDEPS.ocn_stream()
    • CDEPS.rundir
    • CDEPS.taskname()
    • CDEPS.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.chgres_cube
  • ChgresCube
    • ChgresCube.config
    • ChgresCube.config_full
    • ChgresCube.cycle
    • ChgresCube.driver_name
    • ChgresCube.namelist_file()
    • ChgresCube.provisioned_rundir()
    • ChgresCube.run()
    • ChgresCube.rundir
    • ChgresCube.runscript()
    • ChgresCube.taskname()
    • ChgresCube.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.config
  • compare()
  • get_fieldtable_config()
  • get_ini_config()
  • get_nml_config()
  • get_sh_config()
  • get_yaml_config()
  • realize()
  • realize_to_dict()
  • validate()
• uwtools.api.driver
  • Assets
    • Assets.config
    • Assets.config_full
    • Assets.driver_name
    • Assets.rundir
    • Assets.taskname()
    • Assets.validate()
  • AssetsCycleBased
    • AssetsCycleBased.config
    • AssetsCycleBased.config_full
    • AssetsCycleBased.cycle
    • AssetsCycleBased.driver_name
    • AssetsCycleBased.rundir
    • AssetsCycleBased.taskname()
    • AssetsCycleBased.validate()
  • AssetsCycleLeadtimeBased
    • AssetsCycleLeadtimeBased.config
    • AssetsCycleLeadtimeBased.config_full
    • AssetsCycleLeadtimeBased.cycle
    • AssetsCycleLeadtimeBased.driver_name
    • AssetsCycleLeadtimeBased.leadtime
    • AssetsCycleLeadtimeBased.rundir
    • AssetsCycleLeadtimeBased.taskname()
    • AssetsCycleLeadtimeBased.validate()
  • AssetsTimeInvariant
    • AssetsTimeInvariant.config
    • AssetsTimeInvariant.config_full
    • AssetsTimeInvariant.driver_name
    • AssetsTimeInvariant.rundir
    • AssetsTimeInvariant.taskname()
    • AssetsTimeInvariant.validate()
  • Driver
    • Driver.config
    • Driver.config_full
    • Driver.driver_name
    • Driver.provisioned_rundir()
    • Driver.run()
    • Driver.rundir
    • Driver.runscript()
    • Driver.taskname()
    • Driver.validate()
  • DriverCycleBased
    • DriverCycleBased.config
    • DriverCycleBased.config_full
    • DriverCycleBased.cycle
    • DriverCycleBased.driver_name
    • DriverCycleBased.provisioned_rundir()
    • DriverCycleBased.run()
    • DriverCycleBased.rundir
    • DriverCycleBased.runscript()
    • DriverCycleBased.taskname()
    • DriverCycleBased.validate()
  • DriverCycleLeadtimeBased
    • DriverCycleLeadtimeBased.config
    • DriverCycleLeadtimeBased.config_full
    • DriverCycleLeadtimeBased.cycle
    • DriverCycleLeadtimeBased.driver_name
    • DriverCycleLeadtimeBased.leadtime
    • DriverCycleLeadtimeBased.provisioned_rundir()
    • DriverCycleLeadtimeBased.run()
    • DriverCycleLeadtimeBased.rundir
    • DriverCycleLeadtimeBased.runscript()
    • DriverCycleLeadtimeBased.taskname()
    • DriverCycleLeadtimeBased.validate()
  • DriverTimeInvariant
    • DriverTimeInvariant.config
    • DriverTimeInvariant.config_full
    • DriverTimeInvariant.driver_name
    • DriverTimeInvariant.provisioned_rundir()
    • DriverTimeInvariant.run()
    • DriverTimeInvariant.rundir
    • DriverTimeInvariant.runscript()
    • DriverTimeInvariant.taskname()
    • DriverTimeInvariant.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.esg_grid
  • ESGGrid
    • ESGGrid.config
    • ESGGrid.config_full
    • ESGGrid.driver_name
    • ESGGrid.namelist_file()
    • ESGGrid.provisioned_rundir()
    • ESGGrid.run()
    • ESGGrid.rundir
    • ESGGrid.runscript()
    • ESGGrid.taskname()
    • ESGGrid.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.file
  • Copier
    • Copier.go()
  • Linker
    • Linker.go()
  • copy()
  • link()
• uwtools.api.filter_topo
  • FilterTopo
    • FilterTopo.config
    • FilterTopo.config_full
    • FilterTopo.driver_name
    • FilterTopo.input_grid_file()
    • FilterTopo.namelist_file()
    • FilterTopo.provisioned_rundir()
    • FilterTopo.run()
    • FilterTopo.rundir
    • FilterTopo.runscript()
    • FilterTopo.taskname()
    • FilterTopo.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.fv3
  • FV3
    • FV3.boundary_files()
    • FV3.config
    • FV3.config_full
    • FV3.cycle
    • FV3.diag_table()
    • FV3.driver_name
    • FV3.field_table()
    • FV3.files_copied()
    • FV3.files_linked()
    • FV3.model_configure()
    • FV3.namelist_file()
    • FV3.provisioned_rundir()
    • FV3.restart_directory()
    • FV3.run()
    • FV3.rundir
    • FV3.runscript()
    • FV3.taskname()
    • FV3.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.global_equiv_resol
  • GlobalEquivResol
    • GlobalEquivResol.config
    • GlobalEquivResol.config_full
    • GlobalEquivResol.driver_name
    • GlobalEquivResol.input_file()
    • GlobalEquivResol.provisioned_rundir()
    • GlobalEquivResol.run()
    • GlobalEquivResol.rundir
    • GlobalEquivResol.runscript()
    • GlobalEquivResol.taskname()
    • GlobalEquivResol.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.ioda
  • IODA
    • IODA.config
    • IODA.config_full
    • IODA.configuration_file()
    • IODA.cycle
    • IODA.driver_name
    • IODA.files_copied()
    • IODA.files_linked()
    • IODA.provisioned_rundir()
    • IODA.run()
    • IODA.rundir
    • IODA.runscript()
    • IODA.taskname()
    • IODA.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.jedi
  • JEDI
    • JEDI.config
    • JEDI.config_full
    • JEDI.configuration_file()
    • JEDI.cycle
    • JEDI.driver_name
    • JEDI.files_copied()
    • JEDI.files_linked()
    • JEDI.provisioned_rundir()
    • JEDI.run()
    • JEDI.rundir
    • JEDI.runscript()
    • JEDI.taskname()
    • JEDI.validate()
    • JEDI.validate_only()
  • execute()
  • graph()
  • tasks()
• uwtools.api.logging
  • use_custom_logger()
  • use_uwtools_logger()
• uwtools.api.make_hgrid
  • MakeHgrid
    • MakeHgrid.config
    • MakeHgrid.config_full
    • MakeHgrid.driver_name
    • MakeHgrid.provisioned_rundir()
    • MakeHgrid.run()
    • MakeHgrid.rundir
    • MakeHgrid.runscript()
    • MakeHgrid.taskname()
    • MakeHgrid.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.make_solo_mosaic
  • MakeSoloMosaic
    • MakeSoloMosaic.config
    • MakeSoloMosaic.config_full
    • MakeSoloMosaic.driver_name
    • MakeSoloMosaic.provisioned_rundir()
    • MakeSoloMosaic.run()
    • MakeSoloMosaic.rundir
    • MakeSoloMosaic.runscript()
    • MakeSoloMosaic.taskname()
    • MakeSoloMosaic.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.mpas
  • MPAS
    • MPAS.boundary_files()
    • MPAS.config
    • MPAS.config_full
    • MPAS.cycle
    • MPAS.driver_name
    • MPAS.files_copied()
    • MPAS.files_linked()
    • MPAS.namelist_file()
    • MPAS.provisioned_rundir()
    • MPAS.run()
    • MPAS.rundir
    • MPAS.runscript()
    • MPAS.streams_file()
    • MPAS.taskname()
    • MPAS.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.mpas_init
  • MPASInit
    • MPASInit.boundary_files()
    • MPASInit.config
    • MPASInit.config_full
    • MPASInit.cycle
    • MPASInit.driver_name
    • MPASInit.files_copied()
    • MPASInit.files_linked()
    • MPASInit.namelist_file()
    • MPASInit.provisioned_rundir()
    • MPASInit.run()
    • MPASInit.rundir
    • MPASInit.runscript()
    • MPASInit.streams_file()
    • MPASInit.taskname()
    • MPASInit.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.orog_gsl
  • OrogGSL
    • OrogGSL.config
    • OrogGSL.config_full
    • OrogGSL.driver_name
    • OrogGSL.input_grid_file()
    • OrogGSL.provisioned_rundir()
    • OrogGSL.run()
    • OrogGSL.rundir
    • OrogGSL.runscript()
    • OrogGSL.taskname()
    • OrogGSL.topo_data_2p5m()
    • OrogGSL.topo_data_30s()
    • OrogGSL.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.rocoto
  • realize()
  • validate()
• uwtools.api.schism
  • SCHISM
    • SCHISM.config
    • SCHISM.config_full
    • SCHISM.cycle
    • SCHISM.driver_name
    • SCHISM.namelist_file()
    • SCHISM.provisioned_rundir()
    • SCHISM.rundir
    • SCHISM.taskname()
    • SCHISM.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.sfc_climo_gen
  • SfcClimoGen
    • SfcClimoGen.config
    • SfcClimoGen.config_full
    • SfcClimoGen.driver_name
    • SfcClimoGen.namelist_file()
    • SfcClimoGen.provisioned_rundir()
    • SfcClimoGen.run()
    • SfcClimoGen.rundir
    • SfcClimoGen.runscript()
    • SfcClimoGen.taskname()
    • SfcClimoGen.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.shave
  • Shave
    • Shave.config
    • Shave.config_full
    • Shave.driver_name
    • Shave.provisioned_rundir()
    • Shave.run()
    • Shave.rundir
    • Shave.runscript()
    • Shave.taskname()
    • Shave.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.template
  • render()
  • render_to_str()
  • translate()
• uwtools.api.ungrib
  • Ungrib
    • Ungrib.config
    • Ungrib.config_full
    • Ungrib.cycle
    • Ungrib.driver_name
    • Ungrib.gribfiles()
    • Ungrib.namelist_file()
    • Ungrib.provisioned_rundir()
    • Ungrib.run()
    • Ungrib.rundir
    • Ungrib.runscript()
    • Ungrib.taskname()
    • Ungrib.validate()
    • Ungrib.vtable()
  • execute()
  • graph()
  • tasks()
• uwtools.api.upp
  • UPP
    • UPP.config
    • UPP.config_full
    • UPP.cycle
    • UPP.driver_name
    • UPP.files_copied()
    • UPP.files_linked()
    • UPP.leadtime
    • UPP.namelist_file()
    • UPP.provisioned_rundir()
    • UPP.run()
    • UPP.rundir
    • UPP.runscript()
    • UPP.taskname()
    • UPP.validate()
  • execute()
  • graph()
  • tasks()
• uwtools.api.ww3
  • WaveWatchIII
    • WaveWatchIII.config
    • WaveWatchIII.config_full
    • WaveWatchIII.cycle
    • WaveWatchIII.driver_name
    • WaveWatchIII.namelist_file()
    • WaveWatchIII.provisioned_rundir()
    • WaveWatchIII.restart_directory()
    • WaveWatchIII.rundir
    • WaveWatchIII.taskname()
    • WaveWatchIII.validate()
  • execute()
  • graph()
  • tasks()