From 4e3a0601c13a49fd4133fc3a310a036d53fdbf0a Mon Sep 17 00:00:00 2001 From: integrated_methane_inversion Continuous Integration Date: Tue, 22 Oct 2024 19:57:52 +0000 Subject: [PATCH 1/4] Continuous Integration Manifest Generation --- src/components/shell_variable_manifest.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/components/shell_variable_manifest.md b/src/components/shell_variable_manifest.md index 16b9ee1f..77129abc 100644 --- a/src/components/shell_variable_manifest.md +++ b/src/components/shell_variable_manifest.md @@ -26,13 +26,13 @@ Note: This does not include variables defined in python scripts. | channels | ['envs/Harvard-Cannon/imi_env.yml'] | ['envs/Harvard-Cannon/imi_env.yml'] | [] | [] | | ClusteringMethod | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | [] | | cmd | ['src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['setup_template', 'run_hemco_prior_emis'] | ['setup_template', 'run_hemco_prior_emis', 'run_hemco_sa', 'exclude_soil_sink'] | -| CondaEnv | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | [] | | condaEnv | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | [] | [] | +| CondaEnv | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | [] | | condaFile | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | [] | [] | | CondaFile | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | [] | | config_path | ['src/components/preview_component/preview.sh'] | ['src/components/preview_component/preview.sh'] | ['run_preview'] | ['run_preview'] | -| ConfigFile | ['run_imi.sh', 'src/components/inversion_component/inversion.sh', 'src/components/preview_component/preview.sh', 'src/utilities/cleanup_script.sh'] | ['run_imi.sh', 'src/utilities/cleanup_script.sh'] | [] | ['setup_inversion', 'run_preview'] | | configFile | ['src/inversion_scripts/run_inversion.sh'] | ['src/inversion_scripts/run_inversion.sh'] | [] | ['send_error'] | +| ConfigFile | ['run_imi.sh', 'src/components/inversion_component/inversion.sh', 'src/components/preview_component/preview.sh', 'src/utilities/cleanup_script.sh'] | ['run_imi.sh', 'src/utilities/cleanup_script.sh'] | [] | ['setup_inversion', 'run_preview'] | | ConfigPath | ['run_imi.sh', 'src/components/statevector_component/statevector.sh', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/preview_component/preview.sh'] | ['run_imi.sh'] | [] | ['create_statevector', 'reduce_dimension', 'setup_kf', 'run_period', 'run_posterior', 'run_jacobian', 'run_preview'] | | constYr | ['src/components/statevector_component/statevector.sh', 'src/components/setup_component/setup.sh'] | ['src/components/setup_component/setup.sh'] | ['setup_imi'] | ['create_statevector', 'setup_imi', 'activate_observations'] | | copied_config | ['src/components/inversion_component/inversion.sh'] | ['src/components/inversion_component/inversion.sh'] | ['run_notebooks'] | ['setup_inversion', 'run_inversion', 'run_notebooks'] | @@ -93,8 +93,8 @@ Note: This does not include variables defined in python scripts. | GCVizDir | ['src/inversion_scripts/run_inversion.sh'] | ['src/inversion_scripts/run_inversion.sh'] | [] | ['send_error'] | | GEOSCHEM_VERSION | ['run_imi.sh', 'src/components/setup_component/setup.sh'] | ['run_imi.sh'] | [] | ['setup_imi'] | | geosChemDataPath | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/write_BCs/config_boundary_conditions.yml'] | [] | [] | -| GEOSChemEnv | ['run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | ['envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | [] | | geosChemEnv | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/write_BCs/config_boundary_conditions.yml'] | [] | [] | +| GEOSChemEnv | ['run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | ['envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | [] | | GlobalDir | ['src/utilities/crop_met.sh'] | ['src/utilities/crop_met.sh'] | [] | [] | | GOSAT | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/setup_component/setup.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['activate_observations'] | | gridded_posterior_filename | ['src/components/posterior_component/posterior.sh'] | ['src/components/posterior_component/posterior.sh'] | ['setup_posterior'] | ['setup_posterior', 'run_posterior', 'generate_optimized_BC_values', 'generate_optimized_OH_value'] | @@ -174,8 +174,8 @@ Note: This does not include variables defined in python scripts. | Lons | ['src/components/template_component/template.sh'] | ['src/components/template_component/template.sh'] | ['setup_template'] | ['setup_template'] | | MakePeriodsCSV | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/kalman_component/kalman.sh', 'src/components/setup_component/setup.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['setup_kf', 'setup_imi'] | | MaxSimultaneousRuns | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/jacobian_component/jacobian.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['setup_jacobian'] | -| MET | ['src/utilities/find_corrupt_files.sh'] | ['src/utilities/find_corrupt_files.sh'] | [] | ['download_aws_files', 'report'] | | Met | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/statevector_component/statevector.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['create_statevector', 'setup_imi', 'setup_template', 'run_hemco_prior_emis'] | +| MET | ['src/utilities/find_corrupt_files.sh'] | ['src/utilities/find_corrupt_files.sh'] | [] | ['download_aws_files', 'report'] | | metDir | ['src/components/statevector_component/statevector.sh', 'src/components/setup_component/setup.sh'] | ['src/components/setup_component/setup.sh'] | ['setup_imi'] | ['create_statevector', 'setup_imi', 'activate_observations'] | | metNum | ['src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['setup_template', 'run_hemco_prior_emis'] | ['setup_template', 'run_hemco_prior_emis', 'run_hemco_sa', 'exclude_soil_sink'] | | MM | ['src/components/template_component/template.sh'] | [] | [] | ['setup_template'] | @@ -189,8 +189,8 @@ Note: This does not include variables defined in python scripts. | nElements | ['src/components/statevector_component/statevector.sh', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/inversion_scripts/run_inversion.sh'] | ['src/components/statevector_component/statevector.sh', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/inversion_scripts/run_inversion.sh'] | ['reduce_dimension', 'setup_kf', 'run_posterior', 'calculate_num_jacobian_runs', 'setup_imi'] | ['create_statevector', 'reduce_dimension', 'setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix', 'setup_posterior', 'run_posterior', 'generate_optimized_BC_values', 'generate_optimized_OH_value', 'setup_inversion', 'setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number', 'setup_imi', 'activate_observations', 'send_error'] | | NEW | ['src/components/setup_component/setup.sh', 'src/components/template_component/template.sh'] | ['src/components/setup_component/setup.sh', 'src/components/template_component/template.sh'] | ['activate_observations', 'setup_template'] | ['setup_imi', 'activate_observations', 'setup_template'] | | nPeriods | ['src/components/kalman_component/kalman.sh'] | ['src/components/kalman_component/kalman.sh'] | ['run_kf'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix'] | -| nRuns | ['src/components/jacobian_component/jacobian.sh'] | ['src/components/jacobian_component/jacobian.sh'] | ['setup_jacobian', 'calculate_num_jacobian_runs'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number'] | | nruns | ['src/components/kalman_component/kalman.sh'] | ['src/components/kalman_component/kalman.sh'] | ['get_last_rundir_suffix'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix'] | +| nRuns | ['src/components/jacobian_component/jacobian.sh'] | ['src/components/jacobian_component/jacobian.sh'] | ['setup_jacobian', 'calculate_num_jacobian_runs'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number'] | | nTracers | ['src/components/jacobian_component/jacobian.sh', 'src/inversion_scripts/run_inversion.sh'] | ['src/components/jacobian_component/jacobian.sh', 'src/inversion_scripts/run_inversion.sh'] | ['calculate_tracer_end', 'calculate_num_jacobian_runs'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number', 'send_error'] | | NudgeFactor | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/kalman_component/kalman.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['run_period'] | | NumberOfElements | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | [] | @@ -260,8 +260,8 @@ Note: This does not include variables defined in python scripts. | RequestedCPUs | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/geoschem_run_scripts/submit_jacobian_simulations_array.sh', 'src/components/statevector_component/statevector.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/components/preview_component/preview.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['reduce_dimension', 'run_posterior', 'run_inversion', 'run_jacobian', 'run_spinup', 'run_hemco_sa', 'run_preview'] | | RequestedMemory | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/geoschem_run_scripts/submit_jacobian_simulations_array.sh', 'src/components/statevector_component/statevector.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/components/preview_component/preview.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['reduce_dimension', 'run_posterior', 'run_inversion', 'run_jacobian', 'run_spinup', 'run_hemco_sa', 'run_preview'] | | RequestedTime | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/geoschem_run_scripts/submit_jacobian_simulations_array.sh', 'src/components/statevector_component/statevector.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/components/preview_component/preview.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['reduce_dimension', 'run_posterior', 'run_inversion', 'run_jacobian', 'run_spinup', 'run_hemco_sa', 'run_preview'] | -| RES | ['src/components/template_component/template.sh'] | [] | [] | ['setup_template'] | | Res | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/inversion_scripts/run_inversion.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/inversion_scripts/run_inversion.sh'] | [] | ['run_posterior', 'setup_inversion', 'setup_imi', 'setup_template', 'run_hemco_prior_emis', 'send_error'] | +| RES | ['src/components/template_component/template.sh'] | [] | [] | ['setup_template'] | | resnum | ['src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['run_hemco_prior_emis'] | ['run_hemco_prior_emis', 'run_hemco_sa', 'exclude_soil_sink'] | | RESOLUTION | ['src/utilities/find_corrupt_files.sh'] | ['src/utilities/find_corrupt_files.sh'] | [] | ['download_aws_files', 'report'] | | response | ['src/utilities/cleanup_script.sh'] | [] | [] | [] | @@ -275,8 +275,8 @@ Note: This does not include variables defined in python scripts. | rm_command | ['src/utilities/cleanup_script.sh'] | ['src/utilities/cleanup_script.sh'] | [] | [] | | ROOT | ['src/components/jacobian_component/jacobian.sh', 'src/components/template_component/template.sh'] | [] | [] | ['create_simulation_dir', 'setup_template'] | | run_dirs_pth | ['src/components/kalman_component/kalman.sh'] | ['src/components/kalman_component/kalman.sh'] | ['get_last_rundir_suffix'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix'] | -| runDir | ['src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/spinup_component/spinup.sh', 'src/components/preview_component/preview.sh', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/spinup_component/spinup.sh', 'src/components/preview_component/preview.sh', 'src/write_BCs/run_boundary_conditions.sh'] | ['setup_posterior', 'create_simulation_dir', 'setup_imi', 'setup_spinup', 'run_preview'] | ['setup_posterior', 'run_posterior', 'generate_optimized_BC_values', 'generate_optimized_OH_value', 'setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number', 'setup_imi', 'activate_observations', 'setup_template', 'setup_spinup', 'run_spinup', 'run_preview'] | | RunDir | ['src/utilities/cleanup_script.sh'] | ['src/utilities/cleanup_script.sh'] | [] | [] | +| runDir | ['src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/spinup_component/spinup.sh', 'src/components/preview_component/preview.sh', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/spinup_component/spinup.sh', 'src/components/preview_component/preview.sh', 'src/write_BCs/run_boundary_conditions.sh'] | ['setup_posterior', 'create_simulation_dir', 'setup_imi', 'setup_spinup', 'run_preview'] | ['setup_posterior', 'run_posterior', 'generate_optimized_BC_values', 'generate_optimized_OH_value', 'setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number', 'setup_imi', 'activate_observations', 'setup_template', 'setup_spinup', 'run_spinup', 'run_preview'] | | RUNDIR | ['src/geoschem_run_scripts/run_bkgd_simulation.sh', 'src/geoschem_run_scripts/run_prior_simulation.sh', 'src/geoschem_run_scripts/run_jacobian_simulations.sh'] | ['src/geoschem_run_scripts/run_bkgd_simulation.sh', 'src/geoschem_run_scripts/run_prior_simulation.sh', 'src/geoschem_run_scripts/run_jacobian_simulations.sh'] | [] | [] | | rundir_num | ['src/components/kalman_component/kalman.sh'] | ['src/components/kalman_component/kalman.sh'] | ['run_period'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix'] | | RunDirs | ['run_imi.sh', 'src/components/statevector_component/statevector.sh', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/components/preview_component/preview.sh'] | ['run_imi.sh', 'src/components/setup_component/setup.sh'] | ['setup_imi'] | ['create_statevector', 'reduce_dimension', 'setup_kf', 'run_kf', 'run_period', 'setup_posterior', 'run_posterior', 'setup_inversion', 'run_inversion', 'run_notebooks', 'setup_jacobian', 'create_simulation_dir', 'run_jacobian', 'setup_imi', 'activate_observations', 'setup_template', 'setup_spinup', 'run_spinup', 'run_hemco_prior_emis', 'run_hemco_sa', 'run_preview'] | @@ -325,8 +325,8 @@ Note: This does not include variables defined in python scripts. | start_elem | ['src/components/jacobian_component/jacobian.sh'] | ['src/components/jacobian_component/jacobian.sh'] | ['calculate_tracer_end'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number'] | | start_element | ['src/components/jacobian_component/jacobian.sh'] | ['src/components/jacobian_component/jacobian.sh'] | ['create_simulation_dir'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number'] | | start_time | ['run_imi.sh'] | ['run_imi.sh'] | [] | [] | -| StartDate | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/inversion_scripts/run_inversion.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['setup_kf', 'run_period', 'setup_posterior', 'run_posterior', 'setup_jacobian', 'create_simulation_dir', 'run_jacobian', 'setup_imi', 'setup_template', 'setup_spinup', 'run_hemco_prior_emis'] | | startDate | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/write_BCs/config_boundary_conditions.yml'] | [] | [] | +| StartDate | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/inversion_scripts/run_inversion.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['setup_kf', 'run_period', 'setup_posterior', 'run_posterior', 'setup_jacobian', 'create_simulation_dir', 'run_jacobian', 'setup_imi', 'setup_template', 'setup_spinup', 'run_hemco_prior_emis'] | | StartDate_i | ['src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh'] | ['src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh'] | ['run_period', 'run_posterior'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix', 'setup_posterior', 'run_posterior', 'generate_optimized_BC_values', 'generate_optimized_OH_value', 'run_inversion'] | | StartMonth | ['src/utilities/crop_met.sh'] | ['src/utilities/crop_met.sh'] | [] | [] | | state_vector_path | ['src/components/statevector_component/statevector.sh', 'src/components/preview_component/preview.sh'] | ['src/components/statevector_component/statevector.sh', 'src/components/preview_component/preview.sh'] | ['reduce_dimension', 'run_preview'] | ['create_statevector', 'reduce_dimension', 'run_preview'] | From 0adca196a61fc399b6cc1d4d707d20c778bfa921 Mon Sep 17 00:00:00 2001 From: Lucas A Estrada <63303345+laestrada@users.noreply.github.com> Date: Wed, 23 Oct 2024 13:59:36 -0400 Subject: [PATCH 2/4] update the readthedocs with faqs, glossary, and best practices (#284) --- docs/source/getting-started/IMI-glossary.rst | 27 ++++++++ .../source/getting-started/best-practices.rst | 50 ++++++++++++++ docs/source/getting-started/faqs.rst | 66 +++++++++++++++++++ docs/source/index.rst | 3 + 4 files changed, 146 insertions(+) create mode 100644 docs/source/getting-started/IMI-glossary.rst create mode 100644 docs/source/getting-started/best-practices.rst create mode 100644 docs/source/getting-started/faqs.rst diff --git a/docs/source/getting-started/IMI-glossary.rst b/docs/source/getting-started/IMI-glossary.rst new file mode 100644 index 00000000..c5ade9fc --- /dev/null +++ b/docs/source/getting-started/IMI-glossary.rst @@ -0,0 +1,27 @@ +IMI Glossary +============ +Glossary of commonly used terms in the Integrated Methane Inversion (IMI) workflow. + + +.. list-table:: + :widths: 30, 70 + :class: tight-table + + * - ``Period of interest`` + - The period for which the IMI will optimize mean emissions based on TROPOMI observations. Specified by start and end dates. Only observations made during the period are considered. The period of interest can be split into shorter sub-periods (to be optimized sequentially) through the IMI Kalman filter feature. + * - ``Region of interest`` + - The region over which the IMI will optimize mean emissions at up to 0.25°×0.3125° (≈25-km) resolution. Specified by rectilinear latitude/longitude bounds, shapefile, or interactively through the Integral Earth user interface. The region of interest can be rectilinear or irregular in shape. + * - ``Inversion domain`` + - The region of interest and a surrounding buffer region. The inversion domain is always rectilinear in shape. + * - ``Buffer emission elements`` + - The 2D emission elements that make the buffer region. Default number is 8. + * - ``Emission state vector`` + - The collection of 2D emission elements (up to 0.25°×0.3125° resolution) to be optimized in the inversion. Includes elements within the region of interest and buffer elements. + * - ``Prior emission estimate`` + - Best estimate of emissions before performing the inversion, based on a bottom-up inventory. + * - ``Posterior emission estimate`` + - Best estimate of emissions after performing the inversion. + * - ``Averaging kernel sensitivity`` + - Estimates how sensitive the posterior solution for a given state vector (emission) element is to observations as opposed to the prior estimate. An emission element with averaging kernel sensitivity 0 is not quantified by the observations at all, and the inversion returns the prior value for that element. An emission element with averaging kernel sensitivity 1 is fully quantified by the observations, and the inversion results for that element are independent of the prior estimate. + * - ``Degrees of freedom for signal (DOFS)`` + - The sum of the averaging kernel sensitivities for the region of interest. Measures the information content of the observations towards optimizing the state vector; represents the number of independent pieces of information on the state vector that the observations can quantify. diff --git a/docs/source/getting-started/best-practices.rst b/docs/source/getting-started/best-practices.rst new file mode 100644 index 00000000..2ad7beb9 --- /dev/null +++ b/docs/source/getting-started/best-practices.rst @@ -0,0 +1,50 @@ +IMI Best Practices +=================== + +Choosing an inversion time period +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* The IMI can be applied to any period of interest beginning 1 May 2018, when the TROPOMI methane record begins. +* Common choices for the length of the inversion period are one year, one season (~3-6 months), one month, or one week. +* We recommend choosing time periods of one week or more to ensure there are enough satellite observations for a successful inversion. +* The `IMI Preview feature <../getting-started/imi-preview.html>`_ can be used to refine the choice of inversion period. + +Defining a region of interest +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* The IMI can be applied to any region of interest, from the global scale down to small focus areas such as cities, oil and gas basins, and agricultural areas. +* The region of interest can be specified in several ways: +* Setting latitude/longitude bounds for a rectangular domain. +* Using a shapefile. +* Interactively in the Integral Earth web user interface. +* We recommend users select regions of interest larger than about 10,000 km2 (100x100 km2) to ensure there are enough satellite observations for a successful inversion. +* Larger regions of interest require more computational resources. This can be mitigated by optimally reducing the effective resolution of the inversion via `smart state vector clustering <../advanced/using-clustering-options.html>`_. + +Configuring the inversion domain +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* Regional inversions focus on a region of interest within a larger rectilinear inversion domain. +* The inversion domain includes both the region of interest and an external buffer region. +* The buffer region is broken into a collection of buffer emission elements representing emissions outside the region of interest. +* We recommend using ≥ 8 buffer elements to pad the region of interest by ≥ 2°. The default number is 8. + +Reducing the dimension of the state vector for large regions of interest +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* Inversions for large regions of interest at the IMI native 0.25°x0.3125° grid resolution can be computationally expensive. +* This can be mitigated by reducing the dimension of the state vector using the state vector clustering options. +* Smart state vector clustering combines 0.25°x0.3125° into coarser grid elements where the prior emission estimates are low and/or where TROPOMI provides few observations + +Interpreting the IMI Preview +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* Examine the expected information content for the region and period of interest. This includes the map of expected averaging kernel sensitivities and the expected degrees of freedom for signal (DOFS). + * The averaging kernel sensitivities should be higher where the prior emission estimates are higher and where more observations are available. + * DOFS > 0.5 is a bare minimum to achieve any solid information about emissions. + * DOFS < 2 is marginal for most applications. +* If the expected information content is low, consider: + * Increasing the inversion period to incorporate more observations. + * Increasing the prior error estimate. + +Choosing the TROPOMI data product for the inversion +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* The IMI supports inversions with two versions of the TROPOMI methane record: + * The operational TROPOMI retrieval product developed by the SRON Netherlands Institute for Space Research. + * The Blended TROPOMI+GOSAT retrieval product developed by `Balasus et al. (2023) `_ to mitigate retrieval artifacts in the operational product. +* Choosing a product depends on the application. The operational product is updated every few days. The blended product is updated intermittently and is currently available through 2023. +* We recommend using the blended product when available (currently until 2024-01-01) to mitigate retrieval artifacts. diff --git a/docs/source/getting-started/faqs.rst b/docs/source/getting-started/faqs.rst new file mode 100644 index 00000000..a4651e62 --- /dev/null +++ b/docs/source/getting-started/faqs.rst @@ -0,0 +1,66 @@ +IMI FAQs +======== + +This page documents frequently asked questions about the IMI. + +What is the IMI? +~~~~~~~~~~~~~~~~~ +* The IMI is an open-source software tool for quantifying methane emissions at up to 0.25°x0.3125° (≈25-km) and weekly resolution using satellite observations from the `TROPOspheric Monitoring Instrument `_ (TROPOMI), a prior estimate of emissions (e.g., a bottom-up emission inventory), and the `GEOS-Chem chemical transport model `_. +* It uses an analytical Bayesian inversion method that starts from the prior estimate of emissions and improves it with information from the satellite observations to produce a posterior estimate with full error characterization. +* It can be applied to any region and period of interest. + +How do I access the IMI? +~~~~~~~~~~~~~~~~~~~~~~~~~ +* There are several ways to access the IMI: + * Use the free IMI product on the `Amazon Web Services (AWS) Marketplace `_. + * Download the `IMI source code `_ and run it locally. + * Use the `Integral Earth web user interface `_ for the IMI. + +How do I cite the IMI? +~~~~~~~~~~~~~~~~~~~~~~~ +* You can cite the IMI with the corresponding research paper for your application: `IMI 1.0 paper `_ and/or `IMI 2.0 paper `_. + +How much does it cost to use the IMI? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* Running the IMI on AWS incurs fees for using AWS compute resources. +* The typical cost for a 500x500 km2 domain (e.g., the Permian Basin) for 1 month is about $20. +* Cost scales with duration and domain size. Costs for larger domains can be effectively mitigated using the smart clustering capability available through the IMI. + +Where is the IMI documented? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* The IMI is documented at `imi.readthedocs.io <../index.html>`_. + +What is the IMI Preview? +~~~~~~~~~~~~~~~~~~~~~~~~~ +* The `IMI Preview <../getting-started/imi-preview.html>`_ is a feature for evaluating an IMI configuration without actually running an inversion. With the IMI Preview you will: +* Visualize the TROPOMI observations, bottom-up emission inventories, and point source data to be used in the inversion. +* Estimate the information content (degrees of freedom for signal, called DOFS) of the inversion. +* Estimate the USD cost of running the inversion on AWS. +* The IMI Preview has no significant costs, and we strongly recommend using it to ensure that the proposed IMI configuration will lead to a successful inversion. + +Does the IMI support continuous emission monitoring? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* Yes. Users can continuously monitor emissions for a region of interest using the `IMI Kalman filter <../advanced/kalman-filter-mode.html>`_ feature. + +Does the IMI support use of custom prior emission inventories? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* Yes. Users can override the default IMI prior emission inventories with their own by following `these instructions <../advanced/custom-prior-emissions-hemco.html>`_. + +Can I get information on individual point sources from the IMI? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* No. The IMI gives you total emissions in 25x25 km2 grid cells, including all sources. However, it scrapes point source observations from other databases to improve the prior estimate (optional) and to put the total emission results in context. + +Can I get sectoral information from the IMI? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* Yes. The IMI uses prior sectoral information to allocate the posterior emission estimates to specific sectors. + +Can I detect offshore emissions with the IMI? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* Yes. Although the satellite observations are mainly over land, the IMI has the option to use glint observations over water. Offshore emissions can also be quantified from observations of the plume advected over land by onshore flow. + +What can I get from the IMI that's different from point source data providers (GHGSat, Carbon Mapper, Kayrros...)? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* The IMI is a completely different product. It provides total gridded continuous emissions, not snapshot emissions from specific point sources as from point source data providers. +* The two are complementary. The IMI information is most useful for emission reporting, for understanding contributions from different sectors, for monitoring emission trends, and for quantifying long-term averages. + + diff --git a/docs/source/index.rst b/docs/source/index.rst index c78e600b..4bc1c706 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -31,6 +31,9 @@ local compute cluster either manually building the environment or using a docker getting-started/imi-config-file.rst getting-started/imi-preview.rst getting-started/minimizing-cost-tips.rst + getting-started/best-practices.rst + getting-started/IMI-glossary.rst + getting-started/faqs.rst .. toctree:: :maxdepth: 1 From 9538ed7c746e6415d55ef8e357b5420ee0d2f118 Mon Sep 17 00:00:00 2001 From: integrated_methane_inversion Continuous Integration Date: Wed, 23 Oct 2024 17:59:59 +0000 Subject: [PATCH 3/4] Continuous Integration Manifest Generation --- src/components/shell_variable_manifest.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/components/shell_variable_manifest.md b/src/components/shell_variable_manifest.md index 77129abc..b6afe3a5 100644 --- a/src/components/shell_variable_manifest.md +++ b/src/components/shell_variable_manifest.md @@ -28,11 +28,11 @@ Note: This does not include variables defined in python scripts. | cmd | ['src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['setup_template', 'run_hemco_prior_emis'] | ['setup_template', 'run_hemco_prior_emis', 'run_hemco_sa', 'exclude_soil_sink'] | | condaEnv | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | [] | [] | | CondaEnv | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | [] | -| condaFile | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | [] | [] | | CondaFile | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | [] | +| condaFile | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | [] | [] | | config_path | ['src/components/preview_component/preview.sh'] | ['src/components/preview_component/preview.sh'] | ['run_preview'] | ['run_preview'] | -| configFile | ['src/inversion_scripts/run_inversion.sh'] | ['src/inversion_scripts/run_inversion.sh'] | [] | ['send_error'] | | ConfigFile | ['run_imi.sh', 'src/components/inversion_component/inversion.sh', 'src/components/preview_component/preview.sh', 'src/utilities/cleanup_script.sh'] | ['run_imi.sh', 'src/utilities/cleanup_script.sh'] | [] | ['setup_inversion', 'run_preview'] | +| configFile | ['src/inversion_scripts/run_inversion.sh'] | ['src/inversion_scripts/run_inversion.sh'] | [] | ['send_error'] | | ConfigPath | ['run_imi.sh', 'src/components/statevector_component/statevector.sh', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/preview_component/preview.sh'] | ['run_imi.sh'] | [] | ['create_statevector', 'reduce_dimension', 'setup_kf', 'run_period', 'run_posterior', 'run_jacobian', 'run_preview'] | | constYr | ['src/components/statevector_component/statevector.sh', 'src/components/setup_component/setup.sh'] | ['src/components/setup_component/setup.sh'] | ['setup_imi'] | ['create_statevector', 'setup_imi', 'activate_observations'] | | copied_config | ['src/components/inversion_component/inversion.sh'] | ['src/components/inversion_component/inversion.sh'] | ['run_notebooks'] | ['setup_inversion', 'run_inversion', 'run_notebooks'] | @@ -66,8 +66,8 @@ Note: This does not include variables defined in python scripts. | end_elem | ['src/components/jacobian_component/jacobian.sh'] | ['src/components/jacobian_component/jacobian.sh'] | ['calculate_tracer_end'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number'] | | end_element | ['src/components/jacobian_component/jacobian.sh'] | ['src/components/jacobian_component/jacobian.sh'] | ['create_simulation_dir'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number'] | | end_time | ['run_imi.sh'] | ['run_imi.sh'] | [] | [] | -| endDate | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/write_BCs/config_boundary_conditions.yml'] | [] | [] | | EndDate | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/inversion_scripts/run_inversion.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['setup_kf', 'run_posterior', 'run_jacobian', 'setup_imi', 'setup_template', 'setup_spinup', 'run_hemco_prior_emis'] | +| endDate | ['src/write_BCs/config_boundary_conditions.yml', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/write_BCs/config_boundary_conditions.yml'] | [] | [] | | EndDate_i | ['src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh'] | ['src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh'] | ['run_period', 'run_posterior'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix', 'setup_posterior', 'run_posterior', 'generate_optimized_BC_values', 'generate_optimized_OH_value', 'run_inversion'] | | EndMonth | ['src/utilities/crop_met.sh'] | ['src/utilities/crop_met.sh'] | [] | [] | | ErrorBCs | ['src/inversion_scripts/run_inversion.sh'] | ['src/inversion_scripts/run_inversion.sh'] | [] | ['send_error'] | @@ -174,12 +174,12 @@ Note: This does not include variables defined in python scripts. | Lons | ['src/components/template_component/template.sh'] | ['src/components/template_component/template.sh'] | ['setup_template'] | ['setup_template'] | | MakePeriodsCSV | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/kalman_component/kalman.sh', 'src/components/setup_component/setup.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['setup_kf', 'setup_imi'] | | MaxSimultaneousRuns | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/jacobian_component/jacobian.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['setup_jacobian'] | -| Met | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/statevector_component/statevector.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['create_statevector', 'setup_imi', 'setup_template', 'run_hemco_prior_emis'] | | MET | ['src/utilities/find_corrupt_files.sh'] | ['src/utilities/find_corrupt_files.sh'] | [] | ['download_aws_files', 'report'] | +| Met | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/statevector_component/statevector.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['create_statevector', 'setup_imi', 'setup_template', 'run_hemco_prior_emis'] | | metDir | ['src/components/statevector_component/statevector.sh', 'src/components/setup_component/setup.sh'] | ['src/components/setup_component/setup.sh'] | ['setup_imi'] | ['create_statevector', 'setup_imi', 'activate_observations'] | | metNum | ['src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['setup_template', 'run_hemco_prior_emis'] | ['setup_template', 'run_hemco_prior_emis', 'run_hemco_sa', 'exclude_soil_sink'] | -| MM | ['src/components/template_component/template.sh'] | [] | [] | ['setup_template'] | | mm | ['src/utilities/crop_met.sh'] | ['src/utilities/crop_met.sh'] | [] | [] | +| MM | ['src/components/template_component/template.sh'] | [] | [] | ['setup_template'] | | Month | ['src/utilities/crop_met.sh'] | [] | [] | [] | | n_elems | ['src/components/jacobian_component/jacobian.sh'] | ['src/components/jacobian_component/jacobian.sh'] | ['calculate_tracer_end'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number'] | | name | ['envs/Harvard-Cannon/imi_env.yml', 'src/components/jacobian_component/jacobian.sh'] | ['envs/Harvard-Cannon/imi_env.yml', 'src/components/jacobian_component/jacobian.sh'] | ['create_simulation_dir'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number'] | @@ -189,8 +189,8 @@ Note: This does not include variables defined in python scripts. | nElements | ['src/components/statevector_component/statevector.sh', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/inversion_scripts/run_inversion.sh'] | ['src/components/statevector_component/statevector.sh', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/inversion_scripts/run_inversion.sh'] | ['reduce_dimension', 'setup_kf', 'run_posterior', 'calculate_num_jacobian_runs', 'setup_imi'] | ['create_statevector', 'reduce_dimension', 'setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix', 'setup_posterior', 'run_posterior', 'generate_optimized_BC_values', 'generate_optimized_OH_value', 'setup_inversion', 'setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number', 'setup_imi', 'activate_observations', 'send_error'] | | NEW | ['src/components/setup_component/setup.sh', 'src/components/template_component/template.sh'] | ['src/components/setup_component/setup.sh', 'src/components/template_component/template.sh'] | ['activate_observations', 'setup_template'] | ['setup_imi', 'activate_observations', 'setup_template'] | | nPeriods | ['src/components/kalman_component/kalman.sh'] | ['src/components/kalman_component/kalman.sh'] | ['run_kf'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix'] | -| nruns | ['src/components/kalman_component/kalman.sh'] | ['src/components/kalman_component/kalman.sh'] | ['get_last_rundir_suffix'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix'] | | nRuns | ['src/components/jacobian_component/jacobian.sh'] | ['src/components/jacobian_component/jacobian.sh'] | ['setup_jacobian', 'calculate_num_jacobian_runs'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number'] | +| nruns | ['src/components/kalman_component/kalman.sh'] | ['src/components/kalman_component/kalman.sh'] | ['get_last_rundir_suffix'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix'] | | nTracers | ['src/components/jacobian_component/jacobian.sh', 'src/inversion_scripts/run_inversion.sh'] | ['src/components/jacobian_component/jacobian.sh', 'src/inversion_scripts/run_inversion.sh'] | ['calculate_tracer_end', 'calculate_num_jacobian_runs'] | ['setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number', 'send_error'] | | NudgeFactor | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/kalman_component/kalman.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['run_period'] | | NumberOfElements | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | [] | @@ -260,8 +260,8 @@ Note: This does not include variables defined in python scripts. | RequestedCPUs | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/geoschem_run_scripts/submit_jacobian_simulations_array.sh', 'src/components/statevector_component/statevector.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/components/preview_component/preview.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['reduce_dimension', 'run_posterior', 'run_inversion', 'run_jacobian', 'run_spinup', 'run_hemco_sa', 'run_preview'] | | RequestedMemory | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/geoschem_run_scripts/submit_jacobian_simulations_array.sh', 'src/components/statevector_component/statevector.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/components/preview_component/preview.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['reduce_dimension', 'run_posterior', 'run_inversion', 'run_jacobian', 'run_spinup', 'run_hemco_sa', 'run_preview'] | | RequestedTime | ['config.yml', 'run_imi.sh', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/geoschem_run_scripts/submit_jacobian_simulations_array.sh', 'src/components/statevector_component/statevector.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/components/preview_component/preview.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml'] | [] | ['reduce_dimension', 'run_posterior', 'run_inversion', 'run_jacobian', 'run_spinup', 'run_hemco_sa', 'run_preview'] | -| Res | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/inversion_scripts/run_inversion.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/inversion_scripts/run_inversion.sh'] | [] | ['run_posterior', 'setup_inversion', 'setup_imi', 'setup_template', 'run_hemco_prior_emis', 'send_error'] | | RES | ['src/components/template_component/template.sh'] | [] | [] | ['setup_template'] | +| Res | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/inversion_scripts/run_inversion.sh'] | ['config.yml', 'envs/Harvard-Cannon/config.harvard-cannon.yml', 'envs/Harvard-Cannon/config.harvard-cannon.global_inv.yml', 'src/inversion_scripts/run_inversion.sh'] | [] | ['run_posterior', 'setup_inversion', 'setup_imi', 'setup_template', 'run_hemco_prior_emis', 'send_error'] | | resnum | ['src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['src/components/hemco_prior_emis_component/hemco_prior_emis.sh'] | ['run_hemco_prior_emis'] | ['run_hemco_prior_emis', 'run_hemco_sa', 'exclude_soil_sink'] | | RESOLUTION | ['src/utilities/find_corrupt_files.sh'] | ['src/utilities/find_corrupt_files.sh'] | [] | ['download_aws_files', 'report'] | | response | ['src/utilities/cleanup_script.sh'] | [] | [] | [] | @@ -275,9 +275,9 @@ Note: This does not include variables defined in python scripts. | rm_command | ['src/utilities/cleanup_script.sh'] | ['src/utilities/cleanup_script.sh'] | [] | [] | | ROOT | ['src/components/jacobian_component/jacobian.sh', 'src/components/template_component/template.sh'] | [] | [] | ['create_simulation_dir', 'setup_template'] | | run_dirs_pth | ['src/components/kalman_component/kalman.sh'] | ['src/components/kalman_component/kalman.sh'] | ['get_last_rundir_suffix'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix'] | +| RUNDIR | ['src/geoschem_run_scripts/run_bkgd_simulation.sh', 'src/geoschem_run_scripts/run_prior_simulation.sh', 'src/geoschem_run_scripts/run_jacobian_simulations.sh'] | ['src/geoschem_run_scripts/run_bkgd_simulation.sh', 'src/geoschem_run_scripts/run_prior_simulation.sh', 'src/geoschem_run_scripts/run_jacobian_simulations.sh'] | [] | [] | | RunDir | ['src/utilities/cleanup_script.sh'] | ['src/utilities/cleanup_script.sh'] | [] | [] | | runDir | ['src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/spinup_component/spinup.sh', 'src/components/preview_component/preview.sh', 'src/write_BCs/run_boundary_conditions.sh'] | ['src/components/posterior_component/posterior.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/spinup_component/spinup.sh', 'src/components/preview_component/preview.sh', 'src/write_BCs/run_boundary_conditions.sh'] | ['setup_posterior', 'create_simulation_dir', 'setup_imi', 'setup_spinup', 'run_preview'] | ['setup_posterior', 'run_posterior', 'generate_optimized_BC_values', 'generate_optimized_OH_value', 'setup_jacobian', 'create_simulation_dir', 'add_new_tracer', 'run_jacobian', 'generate_BC_perturb_values', 'calculate_tracer_end', 'calculate_num_jacobian_runs', 'is_number', 'setup_imi', 'activate_observations', 'setup_template', 'setup_spinup', 'run_spinup', 'run_preview'] | -| RUNDIR | ['src/geoschem_run_scripts/run_bkgd_simulation.sh', 'src/geoschem_run_scripts/run_prior_simulation.sh', 'src/geoschem_run_scripts/run_jacobian_simulations.sh'] | ['src/geoschem_run_scripts/run_bkgd_simulation.sh', 'src/geoschem_run_scripts/run_prior_simulation.sh', 'src/geoschem_run_scripts/run_jacobian_simulations.sh'] | [] | [] | | rundir_num | ['src/components/kalman_component/kalman.sh'] | ['src/components/kalman_component/kalman.sh'] | ['run_period'] | ['setup_kf', 'run_kf', 'run_period', 'get_last_rundir_suffix'] | | RunDirs | ['run_imi.sh', 'src/components/statevector_component/statevector.sh', 'src/components/kalman_component/kalman.sh', 'src/components/posterior_component/posterior.sh', 'src/components/inversion_component/inversion.sh', 'src/components/jacobian_component/jacobian.sh', 'src/components/setup_component/setup.sh', 'src/components/template_component/template.sh', 'src/components/spinup_component/spinup.sh', 'src/components/hemco_prior_emis_component/hemco_prior_emis.sh', 'src/components/preview_component/preview.sh'] | ['run_imi.sh', 'src/components/setup_component/setup.sh'] | ['setup_imi'] | ['create_statevector', 'reduce_dimension', 'setup_kf', 'run_kf', 'run_period', 'setup_posterior', 'run_posterior', 'setup_inversion', 'run_inversion', 'run_notebooks', 'setup_jacobian', 'create_simulation_dir', 'run_jacobian', 'setup_imi', 'activate_observations', 'setup_template', 'setup_spinup', 'run_spinup', 'run_hemco_prior_emis', 'run_hemco_sa', 'run_preview'] | | RunFilesPath | ['src/components/setup_component/setup.sh'] | ['src/components/setup_component/setup.sh'] | ['setup_imi'] | ['setup_imi', 'activate_observations'] | From b8709cc2cfd42845ecf21f1aed0e471433f1e070 Mon Sep 17 00:00:00 2001 From: laestrada Date: Wed, 23 Oct 2024 14:18:35 -0400 Subject: [PATCH 4/4] fix km2 to use superscript in documentation --- docs/source/getting-started/best-practices.rst | 2 +- docs/source/getting-started/faqs.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/getting-started/best-practices.rst b/docs/source/getting-started/best-practices.rst index 2ad7beb9..dd9b17be 100644 --- a/docs/source/getting-started/best-practices.rst +++ b/docs/source/getting-started/best-practices.rst @@ -15,7 +15,7 @@ Defining a region of interest * Setting latitude/longitude bounds for a rectangular domain. * Using a shapefile. * Interactively in the Integral Earth web user interface. -* We recommend users select regions of interest larger than about 10,000 km2 (100x100 km2) to ensure there are enough satellite observations for a successful inversion. +* We recommend users select regions of interest larger than about 10,000 km\ :sup:`2` (100x100 km\ :sup:`2`) to ensure there are enough satellite observations for a successful inversion. * Larger regions of interest require more computational resources. This can be mitigated by optimally reducing the effective resolution of the inversion via `smart state vector clustering <../advanced/using-clustering-options.html>`_. Configuring the inversion domain diff --git a/docs/source/getting-started/faqs.rst b/docs/source/getting-started/faqs.rst index a4651e62..4f81e437 100644 --- a/docs/source/getting-started/faqs.rst +++ b/docs/source/getting-started/faqs.rst @@ -23,7 +23,7 @@ How do I cite the IMI? How much does it cost to use the IMI? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Running the IMI on AWS incurs fees for using AWS compute resources. -* The typical cost for a 500x500 km2 domain (e.g., the Permian Basin) for 1 month is about $20. +* The typical cost for a 500x500 km\ :sup:`2` domain (e.g., the Permian Basin) for 1 month is about $20. * Cost scales with duration and domain size. Costs for larger domains can be effectively mitigated using the smart clustering capability available through the IMI. Where is the IMI documented? @@ -48,7 +48,7 @@ Does the IMI support use of custom prior emission inventories? Can I get information on individual point sources from the IMI? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* No. The IMI gives you total emissions in 25x25 km2 grid cells, including all sources. However, it scrapes point source observations from other databases to improve the prior estimate (optional) and to put the total emission results in context. +* No. The IMI gives you total emissions in 25x25 km\ :sup:`2` grid cells, including all sources. However, it scrapes point source observations from other databases to improve the prior estimate (optional) and to put the total emission results in context. Can I get sectoral information from the IMI? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~