slv.inversion.priors.get_slv_prior#

slv.inversion.priors.get_slv_prior(prior, out_grid, flux_times, flux_freq=None, bbox=None, extent=None, **kwargs)[source]#

Build the prior flux for InversionConfig.prior.

Parameters:

  • prior (str) – "epa" (load_epa_prior()), "edgar" (load_edgar_prior()) or "constant" (build_constant_prior()); case-insensitive.

  • out_grid (xr.DataArray) – Target lon/lat grid (InversionConfig.grid).

  • flux_times (pd.DatetimeIndex) – Start of each flux interval.

  • flux_freq (str, optional) – Flux interval (e.g. "MS"); a coarser interval than the inventory’s is averaged to.

  • bbox (tuple, optional) – Clip the inventory before regridding.

  • extent (tuple, optional) – Clip the inventory before regridding.

  • **kwargs – Passed to the loader (e.g. express=True for EPA, value= for constant).

Returns:

Flux in umol/m2/s (the Jacobian’s units), indexed by (time, lat, lon) or (time, lon, lat).

Return type:

pd.Series