config.yml

## IMI configuration file
## Documentation @ https://imi.readthedocs.io/en/latest/getting-started/imi-config-file.html

## General
RunName: "Test_Permian_1week"
Species: "CH4"
isAWS: true
SchedulerType: "slurm"
SafeMode: true
S3Upload: false

## Period of interest
StartDate: 20180501
EndDate: 20180508
SpinupMonths: 1

## What satellite data product should be used? Current options are: 
##     "BlendedTROPOMI"  : The dataset generated by Balasus et al. in which
##                         the TROPOMI data are fit to GOSAT data using ML
##     "TROPOMI"         : The operational TROPOMI data
##     "Other"           : Any other dataset
## Currently, only "BlendedTROPOMI" and "TROPOMI" are supported on AWS. If 
## "Other" is selected, the user must specify the path where observations are
## located under "Advanced settings" in this file.
SatelliteProduct: "Other"
# BlendedTROPOMI: false

## Is this a regional inversion? Set to false for global inversion
isRegional: true

## Select two character region ID (for using pre-cropped meteorological fields)
##   Current options are listed below with ([lat],[lon]) bounds:
##     "AF" : Africa ([-37,40], [-20,53])
##     "AS" : Asia ([-11,55],[60,150]) 
##     "EU" : Europe ([33,61],[-30,70])
##     "ME" : Middle East ([12,50], [-20,70])
##     "NA" : North America ([10,70],[-140,-40])
##     "OC" : Oceania ([-50,5], [110,180])
##     "RU" : Russia ([41,83], [19,180])
##     "SA" : South America ([-59,16], [-88,-31])
##     ""   : Use for global global simulation or custom regions
##   For example, if the region of interest is in Europe ([33,61],[-30,70]), select "EU".
RegionID: "NA"

## Region of interest
##   These lat/lon bounds are only used if CreateAutomaticRectilinearStateVectorFile: true
##   Otherwise lat/lon bounds are determined from StateVectorFile
LonMin: -105
LonMax: -103
LatMin: 31
LatMax: 33

## Kalman filter options
KalmanMode: false
UpdateFreqDays: 7
NudgeFactor: 0.1

## State vector
CreateAutomaticRectilinearStateVectorFile: true
nBufferClusters: 8
BufferDeg: 5
LandThreshold: 0.25
OffshoreEmisThreshold: 0
OptimizeBCs: false
OptimizeOH: false

## Point source datasets
## Used for visualizations and state vector clustering
PointSourceDatasets: ["SRON"]

## Clustering Options
ReducedDimensionStateVector: false
DynamicKFClustering: false
ClusteringMethod: "kmeans"
NumberOfElements: 45
ForcedNativeResolutionElements: 
  - [31.5, -104]

## Custom state vector
StateVectorFile: "/home/ubuntu/integrated_methane_inversion/resources/statevectors/StateVector.nc"
ShapeFile: "/home/ubuntu/integrated_methane_inversion/resources/shapefiles/PermianBasin_Extent_201712.shp"

## Inversion
## Note PriorError and PriorErrorOH are relative fractions (e.g. 0.5 = 50%)
##  and PriorErrorBCs is in ppb
PriorError: 0.5
PriorErrorBCs: 10.0
PriorErrorOH: 0.5
ObsError: 15
Gamma: 1.0
PrecomputedJacobian: false

## Grid
##   Options are 0.25x0.3125 (GEOSFP only), 0.5x0.625, 2.0x2.5, or 4.0x5.0
Res: "0.25x0.3125"

## Meteorology
##   Options are GEOSFP or MERRA2
Met: "GEOSFP"

## Setup modules
##   Turn on/off different steps in setting up the inversion 
SetupTemplateRundir: true
SetupSpinupRun: false
SetupJacobianRuns: false
SetupInversion: false
SetupPosteriorRun: false

## Run modules
##   Turn on/off different steps in performing the inversion
RunSetup: true
DoSpinup: false
DoJacobian: false
DoInversion: false
DoPosterior: false

## IMI preview
##   NOTE: RunSetup must be true to run preview
DoPreview: true
DOFSThreshold: 0

## Resource allocation settings for slurm jobs
SimulationCPUs: 32
SimulationMemory: "32gb"
JacobianCPUs: 1
JacobianMemory: 2000
RequestedTime: "24:00:00"
SchedulerPartition: "debug"

## Max number of simultaneous Jacobian runs from the job array (-1: no limit)
MaxSimultaneousRuns: -1

##====================================================================
##
## Advanced Settings (optional)
##
##====================================================================

## These settings are intended for advanced users who wish to:
##   a. modify additional GEOS-Chem options, or
##   b. run the IMI on a local cluster.
## They can be ignored for any standard cloud application of the IMI.

##--------------------------------------------------------------------
## Additional settings for GEOS-Chem simulations
##--------------------------------------------------------------------

## Jacobian settings
## Note PerturbValue and PerturbValueOH are relative scale factors and 
## PerturbValueBCs is in ppb
PerturbValue: 1.5
PerturbValueOH: 1.5
PerturbValueBCs: 10.0

## Apply scale factors from a previous inversion?
UseEmisSF: false
UseOHSF: false

## Save out hourly diagnostics from GEOS-Chem?
## For use in satellite operators via post-processing -- required for TROPOMI
## inversions
HourlySpecies: true

## Turn on planeflight diagnostic in GEOS-Chem?
## For use in comparing GEOS-Chem against planeflight data. The path
## to those data must be specified in input.geos.
PLANEFLIGHT: false

## Turn on old observation operators in GEOS-Chem?
## These will save out text files comparing GEOS-Chem to observations, but have
## to be manually incorporated into the IMI
GOSAT: false
TCCON: false
AIRS: false

## Use global boundary condition files for initial conditions
UseBCsForRestart: False

##------------------------------------------------------------------
## Settings for running on local cluster
##------------------------------------------------------------------

## Path for IMI runs and output
OutputPath: "/home/ubuntu/imi_output_dir"

## Path to GEOS-Chem input data
DataPath: "/home/ubuntu/ExtData"

## Conda environment file
PythonEnv: "/home/ubuntu/integrated_methane_inversion/envs/aws/python.env"

## Download initial restart file from AWS S3?
##  NOTE: Must have AWS CLI enabled
RestartDownload: true

## Path to initial GEOS-Chem restart file + prefix
##   ("YYYYMMDD_0000z.nc4" will be appended)
RestartFilePrefix: "/home/ubuntu/ExtData/BoundaryConditions/GEOSChem.BoundaryConditions."
RestartFilePreviewPrefix: "/home/ubuntu/ExtData/BoundaryConditions/GEOSChem.BoundaryConditions."

## Path to GEOS-Chem boundary condition files (for regional simulations)
## BCversion will be appended to the end of this path. ${BCpath}/${BCversion}
BCpath: "/home/ubuntu/ExtData/BoundaryConditions"
BCversion: "v2023-06"

## Options to download missing GEOS-Chem input data from AWS S3
##   NOTE: You will be charged if your ec2 instance is not in the
##         us-east-1 region.
PreviewDryRun: true
SpinupDryrun: true
ProductionDryRun: true
PosteriorDryRun: true
BCdryrun: true