smoke_dust package

Subpackages

• smoke_dust.core package
  • Subpackages
    • smoke_dust.core.regrid package
      • Submodules
      • smoke_dust.core.regrid.common module
      • smoke_dust.core.regrid.processor module
  • Submodules
  • smoke_dust.core.common module
    • create_descriptive_statistics()
    • create_sd_coordinate_variable()
    • create_sd_variable()
    • create_template_emissions_file()
    • open_nc()
  • smoke_dust.core.context module
    • EbbDCycle
      • EbbDCycle.ONE
      • EbbDCycle.TWO
    • EmissionVariable
      • EmissionVariable.FRE
      • EmissionVariable.FRP
      • EmissionVariable.rave_name()
      • EmissionVariable.smoke_dust_name()
    • LogLevel
      • LogLevel.DEBUG
      • LogLevel.INFO
    • PredefinedGrid
      • PredefinedGrid.RRFS_CONUS_13KM
      • PredefinedGrid.RRFS_CONUS_25KM
      • PredefinedGrid.RRFS_CONUS_3KM
      • PredefinedGrid.RRFS_NA_13KM
      • PredefinedGrid.RRFS_NA_3KM
    • RaveQaFilter
      • RaveQaFilter.HIGH
      • RaveQaFilter.NONE
    • SmokeDustContext
      • SmokeDustContext.allow_dummy_restart
      • SmokeDustContext.beta
      • SmokeDustContext.create_dummy_emissions_file()
      • SmokeDustContext.emissions_path
      • SmokeDustContext.esmpy_debug
      • SmokeDustContext.fcst_datetime
      • SmokeDustContext.fg_to_ug
      • SmokeDustContext.grid_in
      • SmokeDustContext.grid_out
      • SmokeDustContext.grid_out_shape
      • SmokeDustContext.hourly_hwpdir
      • SmokeDustContext.log()
      • SmokeDustContext.rave_to_intp
      • SmokeDustContext.should_calc_desc_stats
      • SmokeDustContext.to_s
      • SmokeDustContext.vars_emis
      • SmokeDustContext.veg_map
      • SmokeDustContext.weightfile
  • smoke_dust.core.cycle module
    • AbstractSmokeDustCycleProcessor
      • AbstractSmokeDustCycleProcessor.average_frp()
      • AbstractSmokeDustCycleProcessor.create_start_datetime()
      • AbstractSmokeDustCycleProcessor.cycle_dates
      • AbstractSmokeDustCycleProcessor.cycle_metadata
      • AbstractSmokeDustCycleProcessor.finalize()
      • AbstractSmokeDustCycleProcessor.flag()
      • AbstractSmokeDustCycleProcessor.log()
      • AbstractSmokeDustCycleProcessor.run()
    • AverageFrpOutput
      • AverageFrpOutput.data
      • AverageFrpOutput.model_config
    • SmokeDustCycleOne
      • SmokeDustCycleOne.average_frp()
      • SmokeDustCycleOne.create_start_datetime()
      • SmokeDustCycleOne.flag
      • SmokeDustCycleOne.run()
    • SmokeDustCycleTwo
      • SmokeDustCycleTwo.average_frp()
      • SmokeDustCycleTwo.create_start_datetime()
      • SmokeDustCycleTwo.expected_restart_varnames
      • SmokeDustCycleTwo.flag
      • SmokeDustCycleTwo.run()
    • create_cycle_processor()
  • smoke_dust.core.preprocessor module
    • SmokeDustPreprocessor
      • SmokeDustPreprocessor.cycle_dates
      • SmokeDustPreprocessor.cycle_metadata
      • SmokeDustPreprocessor.finalize()
      • SmokeDustPreprocessor.is_first_day
      • SmokeDustPreprocessor.log()
      • SmokeDustPreprocessor.run()
  • smoke_dust.core.variable module
    • SmokeDustVariable
    • SmokeDustVariables
      • SmokeDustVariables.get()

Submodules

smoke_dust.add_smoke module

Add smoke/dust tracers to ICs.

main() → None

The main function ;-).

smoke_dust.generate_emissions module

Python script for fire emissions preprocessing from RAVE FRP and FRE (Li et al.,2022) Author: johana.romero-alvarez@noaa.gov

class StringBool(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

Allow CLI to use boolean string arguments to avoid logic in shell scripts.

FALSE = 'False'

TRUE = 'True'

main(staticdir: Path = typer.Option, ravedir: Path = typer.Option, intp_dir: Path = typer.Option, predef_grid: PredefinedGrid = typer.Option, ebb_dcycle: EbbDCycle = typer.Option, restart_interval: str = typer.Option, persistence: StringBool = typer.Option, rave_qa_filter: RaveQaFilter = typer.Option, log_level: LogLevel = typer.Option, exit_on_error: StringBool = typer.Option, regrid_in_memory: StringBool = typer.Option)

Main entrypoint for generating ICs for smoke and dust.