nos-utils

Contents

  • Installation
    • Requirements
    • Install from source
    • On WCOSS2
    • External tools
    • Precomputed interpolation weights
      • Generating the weight files
  • Usage
    • Quick start: PrepOrchestrator
      • Switching OFS
    • Configuration
    • Individual processors
      • RTOFS with precomputed weights and ADT blending
      • NWM river forcing
      • Interior nudging
    • NCO / ecFlow integration
    • CLI
  • Notebooks
    • SECOFS prep walkthrough
  • API Reference
    • Configuration
      • ForcingConfig
        • ForcingConfig.lon_min
        • ForcingConfig.lon_max
        • ForcingConfig.lat_min
        • ForcingConfig.lat_max
        • ForcingConfig.pdy
        • ForcingConfig.cyc
        • ForcingConfig.nowcast_hours
        • ForcingConfig.forecast_hours
        • ForcingConfig.igrd_met
        • ForcingConfig.met_num
        • ForcingConfig.gfs_resolution
        • ForcingConfig.scale_hflux
        • ForcingConfig.grid_file
        • ForcingConfig.nws
        • ForcingConfig.variables
        • ForcingConfig.hrrr_lon_min
        • ForcingConfig.hrrr_lon_max
        • ForcingConfig.hrrr_lat_min
        • ForcingConfig.hrrr_lat_max
        • ForcingConfig.obc_roi_2d
        • ForcingConfig.obc_roi_3d
        • ForcingConfig.nudge_roi_3d
        • ForcingConfig.obc_ssh_offset
        • ForcingConfig.adt_enabled
        • ForcingConfig.nudging_enabled
        • ForcingConfig.nudging_timescale_seconds
        • ForcingConfig.n_levels
        • ForcingConfig.river_config_file
        • ForcingConfig.river_clim_file
        • ForcingConfig.river_default_temp
        • ForcingConfig.river_default_salt
        • ForcingConfig.nwm_product
        • ForcingConfig.nwm_n_list_target
        • ForcingConfig.nwm_n_list_min
        • ForcingConfig.tidal_constituents
        • ForcingConfig.bctides_template
        • ForcingConfig.domain
        • ForcingConfig.hrrr_domain
        • ForcingConfig.for_secofs()
        • ForcingConfig.for_secofs_ufs()
        • ForcingConfig.for_stofs_3d_atl()
        • ForcingConfig.for_stofs_3d_atl_ufs()
        • ForcingConfig.for_ensemble()
        • ForcingConfig.from_yaml()
    • Forcing Processors
      • ForcingProcessor
        • ForcingProcessor.SOURCE_NAME
        • ForcingProcessor.MIN_FILE_SIZE
        • ForcingProcessor.process()
        • ForcingProcessor.find_input_files()
        • ForcingProcessor.validate_file_size()
        • ForcingProcessor.create_output_dir()
        • ForcingProcessor.write_files_used()
      • ForcingResult
        • ForcingResult.success
        • ForcingResult.source
        • ForcingResult.output_files
        • ForcingResult.errors
        • ForcingResult.warnings
        • ForcingResult.metadata
      • GFSProcessor
        • GFSProcessor.SOURCE_NAME
        • GFSProcessor.MIN_FILE_SIZE_BY_RES
        • GFSProcessor.GRIB2_VARIABLES
        • GFSProcessor.DEFAULT_VARIABLES
        • GFSProcessor.MIN_FILE_SIZE
        • GFSProcessor.extractor
        • GFSProcessor.process()
        • GFSProcessor.find_input_files()
      • HRRRProcessor
        • HRRRProcessor.SOURCE_NAME
        • HRRRProcessor.MIN_FILE_SIZE
        • HRRRProcessor.MAX_FORECAST_HOURS
        • HRRRProcessor.GRIB2_VARIABLES
        • HRRRProcessor.DEFAULT_VARIABLES
        • HRRRProcessor.extractor
        • HRRRProcessor.process()
        • HRRRProcessor.find_input_files()
      • GEFSProcessor
        • GEFSProcessor.SOURCE_NAME
        • GEFSProcessor.MIN_FILE_SIZE
        • GEFSProcessor.GRIB2_VARIABLES
        • GEFSProcessor.EXTRACT_VARIABLES
        • GEFSProcessor.OUTPUT_VARIABLES
        • GEFSProcessor.extractor
        • GEFSProcessor.process()
        • GEFSProcessor.find_input_files()
        • GEFSProcessor.convert_rh_to_spfh()
        • GEFSProcessor.convert_apcp_to_prate()
      • RTOFSProcessor
        • RTOFSProcessor.SOURCE_NAME
        • RTOFSProcessor.MIN_FILE_SIZE_2D
        • RTOFSProcessor.MIN_FILE_SIZE_3D
        • RTOFSProcessor.is_stofs_mode
        • RTOFSProcessor.process()
        • RTOFSProcessor.find_input_files()
        • RTOFSProcessor.find_input_files_by_type()
      • NWMProcessor
        • NWMProcessor.SOURCE_NAME
        • NWMProcessor.MIN_FILE_SIZE
        • NWMProcessor.PRODUCTS
        • NWMProcessor.river_config
        • NWMProcessor.is_stofs_mode
        • NWMProcessor.process()
        • NWMProcessor.find_input_files()
      • RiverConfig
        • RiverConfig.from_text()
        • RiverConfig.from_json()
        • RiverConfig.from_sources_json()
      • RiverClimProcessor
        • RiverClimProcessor.SOURCE_NAME
        • RiverClimProcessor.find_input_files()
        • RiverClimProcessor.process()
      • TidalProcessor
        • TidalProcessor.SOURCE_NAME
        • TidalProcessor.process()
        • TidalProcessor.find_input_files()
      • compute_nodal_corrections()
      • NudgingProcessor
        • NudgingProcessor.SOURCE_NAME
        • NudgingProcessor.is_stofs_mode
        • NudgingProcessor.process()
        • NudgingProcessor.find_input_files()
      • ParamNmlProcessor
        • ParamNmlProcessor.SOURCE_NAME
        • ParamNmlProcessor.process()
        • ParamNmlProcessor.find_input_files()
        • ParamNmlProcessor.patch_param()
      • HotstartProcessor
        • HotstartProcessor.SOURCE_NAME
        • HotstartProcessor.MIN_HOTSTART_SIZE
        • HotstartProcessor.HOTSTART_PATTERNS
        • HotstartProcessor.process()
        • HotstartProcessor.find_input_files()
      • HotstartInfo
        • HotstartInfo.time_days
      • PartitionProcessor
        • PartitionProcessor.SOURCE_NAME
        • PartitionProcessor.process()
        • PartitionProcessor.find_input_files()
      • ESMFMeshProcessor
        • ESMFMeshProcessor.SOURCE_NAME
        • ESMFMeshProcessor.process()
        • ESMFMeshProcessor.find_input_files()
      • BlenderProcessor
        • BlenderProcessor.SOURCE_NAME
        • BlenderProcessor.process()
        • BlenderProcessor.find_input_files()
      • SfluxWriter
        • SfluxWriter.write_all()
        • SfluxWriter.write_day()
        • SfluxWriter.write_sflux_inputs()
      • DATMWriter
        • DATMWriter.write()
        • DATMWriter.write_blended()
        • DATMWriter.get_grid_dims()
      • Base classes
        • ForcingResult
        • ForcingProcessor
      • Atmospheric
        • GFS
        • HRRR
        • GEFS
      • Ocean boundary
        • RTOFS
        • ADT satellite SSH blending
      • River
        • NWM
        • River climatology
      • Tidal
        • TidalProcessor
        • compute_nodal_corrections()
      • Nudging
        • NudgingProcessor
      • Model configuration
        • param.nml
        • Hotstart
        • Partition
      • UFS-Coastal
        • ESMF mesh
        • Blender
      • Writers
        • Sflux writer
        • DATM writer
    • Interpolation
      • StructuredGridInterpolator
        • StructuredGridInterpolator.interpolate()
      • Overview
      • Precomputed weight workflow
        • Example
      • Structured bilinear interpolator
        • StructuredGridInterpolator
      • Precomputed REMESH weights
        • load_remesh_export()
        • build_npz()
        • validate_grid()
        • apply_precomputed_ssh()
        • build_nudge_npz()
        • build_3d_npz()
        • apply_precomputed_nudge()
    • I/O Utilities
      • GRIBExtractor
        • GRIBExtractor.extract()
        • GRIBExtractor.get_grid()
        • GRIBExtractor.regrid_to_latlon()
      • Wgrib2Extractor
        • Wgrib2Extractor.WGRIB2_SEARCH_PATHS
        • Wgrib2Extractor.extract()
        • Wgrib2Extractor.get_grid()
        • Wgrib2Extractor.regrid_to_latlon()
      • CfgribExtractor
        • CfgribExtractor.extract()
        • CfgribExtractor.get_grid()
      • get_extractor()
      • SchismGrid
        • SchismGrid.filepath
        • SchismGrid.n_nodes
        • SchismGrid.n_elements
        • SchismGrid.node_lons
        • SchismGrid.node_lats
        • SchismGrid.node_depths
        • SchismGrid.open_boundaries
        • SchismGrid.n_open_boundary_nodes
        • SchismGrid.read()
        • SchismGrid.open_boundary_nodes()
        • SchismGrid.obc_nodes_from_ctl()
        • SchismGrid.read_gr3_values()
      • OpenBoundary
        • OpenBoundary.index
        • OpenBoundary.node_ids
        • OpenBoundary.lons
        • OpenBoundary.lats
        • OpenBoundary.depths
        • OpenBoundary.n_nodes
      • GRIB2 extraction
        • GRIBExtractor
        • Wgrib2Extractor
        • CfgribExtractor
        • get_extractor()
      • NetCDF utilities
        • read_time_axis()
        • validate_monotonic()
        • replace_fill_values()
        • get_grid_dims()
        • subset_domain()
        • copy_variable()
      • SCHISM grid reader
        • OpenBoundary
        • SchismGrid
      • SCHISM vertical grid reader
        • SchismVgrid
    • Orchestrator
      • PrepResult
        • PrepResult.success
        • PrepResult.phase
        • PrepResult.results
        • PrepResult.elapsed_seconds
        • PrepResult.all_output_files
        • PrepResult.all_errors
        • PrepResult.all_warnings
        • PrepResult.summary()
      • PrepOrchestrator
        • PrepOrchestrator.PYTHON_STEPS
        • PrepOrchestrator.LEGACY_STEPS
        • PrepOrchestrator.is_stofs
        • PrepOrchestrator.run()
        • PrepOrchestrator.archive_to_comout()
    • CLI
      • cmd_prep()
      • cmd_list()
      • main()
    • NCO Bridge
      • config_from_env()
      • run_prep()
  • Contributing
    • Development setup
    • Running tests
    • Code style
    • Adding a new processor
    • PR workflow
nos-utils
  • Search

© Copyright 2026, NOAA NOS.

Built with Sphinx using a theme provided by Read the Docs.