Welcome to ginput’s documentation!

Using ginput:

• Installation and first steps
  • Standard installation with conda, pixi, or pip
  • Standard installation from repo
  • Manual installation
  • First steps before running
• Ginput command line interface
  • Downloading met data
  • Generating model files
  • Generating VMR files
  • Generating .map files
  • Updating input NOAA data
• Downloading met files
  • Expected file structure
  • Downloading data for dates
  • Downloading data for a runlog
• Making model files
  • Creating .mod files for dates
  • Producing model files for a runlog
• Making VMR files
  • Creating .vmr files for dates
  • Producing .vmr files for a runlog
• Making .map and .map.nc files
  • Creating .map or .map.nc files
• Updating NOAA input data
  • Using more recent flask data
  • Rapid updates with hourly data
  • Other command line arguments
• Running tests
  • Large input data
  • Tests directory structure
  • Environmental variables

ginput code overview:

• Core priors code
  • Top level entry points
  • Gas-specific design
  • Implementing a new gas
• Satellite priors interface
  • Overview
  • Loading met data
  • Calculating equivalent latitudes
  • Calculating trace gas profiles
  • Saving trace gas profiles
  • Special considerations for reproducibility
  • Error handling
  • ACOS assumptions
• Mod maker
  • Equivalent latitude calculation
  • TCCON site locations

ginput API documentation:

• tccon_priors module
  • CH4TropicsRecord
  • CO2TropicsRecord
  • GasRecordDateError
  • GasRecordError
  • GasRecordExtrapolationError
  • GasRecordInconsistentDimsError
  • GasRecordInputMissingError
  • GasRecordInputVerificationError
  • HFTropicsRecord
  • MloSmoTraceGasRecord
  • N2OTropicsRecord
  • O2MeanMoleFractionRecord
  • add_strat_prior_standard()
  • add_trop_prior_standard()
  • generate_full_tccon_vmr_file()
  • generate_single_tccon_prior()
  • generate_tccon_priors_driver()
  • get_clams_age()
  • get_trop_eq_lat()
  • modify_strat_co()
• mlo_smo_prep module
  • InsituMonthlyAverager
  • InsituProcessingError
  • MloBackgroundMode
  • MloMonthlyAverager
  • MloPrelimMode
  • SmoMonthlyAverager
  • compute_wind_for_times()
  • get_smo_winds_from_file()
  • make_geos_2d_file_list()
  • merge_insitu_with_wind()
  • mlo_background_selection()
  • monthly_avg_rapid_data()
  • noaa_prelim_flagging()
  • read_hourly_insitu()
  • read_surface_file()
  • smo_wind_filter()
• acos_interface module

Indices and tables

• Index

• Module Index

• Search Page