openghg_inversions#
OpenGHG inversions.
- openghg_inversions.basis
BasisFunctionsNativeCovarianceProductsNativeCovarianceProducts.effective_observation_operatorNativeCovarianceProducts.native_observation_covarianceNativeCovarianceProducts.observation_covariance_viewNativeCovarianceProducts.observation_state_cross_covarianceNativeCovarianceProducts.prolongationNativeCovarianceProducts.restrictionNativeCovarianceProducts.state_covarianceNativeCovarianceProducts.strategy
PreserveBucketProlongationRetainedProjectionRetainedProjectionStrategybasis_functions_from_fp_all_flat_basis()basis_functions_wrapper()basis_weights_from_fp_all()bucket_basis_from_weights()bucket_basis_function()bucketbasisfunction()calibrate_basis_prior_stdev()fixed_outer_regions_basis()load_basis_functions()load_country_region_classes()load_intem_outer_regions()make_basis_functions()paired_abs_response_weights()project_basis_prior_stdev()project_native_covariance()quadtree_basis_from_weights()quadtree_basis_function()quadtreebasisfunction()region_constrained_basis_from_weights()region_constrained_basis_function()region_constrained_fixed_outer_basis_from_weights()- openghg_inversions.basis.algorithms
AllSplitAcceptancePoliciesAxisAlignedWeightedSplitStrategyAxisParallelSplitStepComponentConsolidationPolicyConnectedBinaryPartitionStepConnectedComponentPartitionStepConnectedComponentSplitStrategyContrastProximityComponentConsolidationContrastProximityComponentConsolidation.cell_weightContrastProximityComponentConsolidation.connectivityContrastProximityComponentConsolidation.contrast_s_diagContrastProximityComponentConsolidation.contrast_sigma_designContrastProximityComponentConsolidation.contrast_tauContrastProximityComponentConsolidation.contributionContrastProximityComponentConsolidation.diagnosticsContrastProximityComponentConsolidation.geometryContrastProximityComponentConsolidation.inactive_component_policyContrastProximityComponentConsolidation.max_merge_delta_eigContrastProximityComponentConsolidation.max_merge_distance_kmContrastProximityComponentConsolidation.max_merge_lambdaContrastProximityComponentConsolidation.min_regionsContrastProximityComponentConsolidation.source_classesContrastProximityComponentConsolidation.spatial_dims
ContrastScoreSplitAcceptanceContrastScoreSplitAcceptance.accepts()ContrastScoreSplitAcceptance.cell_weightContrastScoreSplitAcceptance.contrast_s_diagContrastScoreSplitAcceptance.contrast_sigma_designContrastScoreSplitAcceptance.contrast_tauContrastScoreSplitAcceptance.contributionContrastScoreSplitAcceptance.min_contrast_delta_eigContrastScoreSplitAcceptance.min_contrast_lambdaContrastScoreSplitAcceptance.score_split()ContrastScoreSplitAcceptance.spatial_dims
GreedySplitStrategyInertialSplitStepLatLonGridGeometryMaxChildPCAEccentricityMinChildTargetWeightShareMinChildWeightSharePartitionStepSplitAcceptancePolicySplitContrastScoreSplitGeometrySplitStrategyTargetSplitAcceptancePolicyallocate_nbasis_by_class()combine_inner_outer_region_classes()contrast_tau_from_multiplier_cv()greedy_partitioning()intersect_region_class_layers()normalize_spatial_grid()quadtree_algorithm()region_class_mask()region_constrained_basis()split_contrast_score()weighted_algorithm()
- openghg_inversions.basis.basis_functions
BasisFunctionsFluxWeightedBasisFluxWeightedBasis.basis_artifact_pathFluxWeightedBasis.basis_artifact_sourceFluxWeightedBasis.flat_basis()FluxWeightedBasis.fluxFluxWeightedBasis.for_source()FluxWeightedBasis.from_datatree()FluxWeightedBasis.from_flat_basis()FluxWeightedBasis.from_multi_source_flat_basis()FluxWeightedBasis.interpolate()FluxWeightedBasis.load()FluxWeightedBasis.metadataFluxWeightedBasis.operatorFluxWeightedBasis.plot()FluxWeightedBasis.save()FluxWeightedBasis.select_sources()FluxWeightedBasis.sensitivity()FluxWeightedBasis.source_labelsFluxWeightedBasis.to_datatree()FluxWeightedBasis.validated()FluxWeightedBasis.with_flux()FluxWeightedBasis.with_metadata()
basis_functions_from_fp_all_flat_basis()flux_from_fp_all()
- openghg_inversions.basis.covariance_products
NativeCovarianceProductsNativeCovarianceProducts.effective_observation_operatorNativeCovarianceProducts.native_observation_covarianceNativeCovarianceProducts.observation_covariance_viewNativeCovarianceProducts.observation_state_cross_covarianceNativeCovarianceProducts.prolongationNativeCovarianceProducts.restrictionNativeCovarianceProducts.state_covarianceNativeCovarianceProducts.strategy
PreserveBucketProlongationRetainedProjectionRetainedProjectionStrategyproject_native_covariance()
- openghg_inversions.basis.layout
- openghg_inversions.basis.operators
BasisMetaBasisOperatorBucketBasisOperatorMultiSourceBucketBasisOperatorMultiSourceBucketBasisOperator.basis_matrixMultiSourceBucketBasisOperator.from_datatree()MultiSourceBucketBasisOperator.interpolate()MultiSourceBucketBasisOperator.kindMultiSourceBucketBasisOperator.metaMultiSourceBucketBasisOperator.native_prolongation()MultiSourceBucketBasisOperator.operator_for_source()MultiSourceBucketBasisOperator.sensitivity()MultiSourceBucketBasisOperator.source_labelsMultiSourceBucketBasisOperator.to_datatree()
drop_singleton_time()get_basis_operator_class()register_basis_operator()
- openghg_inversions.basis.prior_uncertainty
- openghg_inversions.config
- openghg_inversions.experimental
- openghg_inversions.hbmcmc
- openghg_inversions.hbmcmc.components
- openghg_inversions.hbmcmc.hbmcmc
- openghg_inversions.hbmcmc.hbmcmc_output
- openghg_inversions.hbmcmc.hbmcmc_post_process
- Functions
calculate_DIC()check_missing_dates()check_platform()country_emissions()country_emissions_mult()define_stations()extract_hbmcmc_files()open_ds()plot_abs_map()plot_country_timeseries()plot_diff_map()plot_map()plot_map_mult()plot_multi_country_timeseries()plot_scale_map()plot_timeseries()set_clevels()subplot_fmt()unbiasedDivergingCmap()
- openghg_inversions.hbmcmc.inversion_pymc
- openghg_inversions.hbmcmc.inversionsetup
- openghg_inversions.hbmcmc.post_process_inputs
- openghg_inversions.hbmcmc.preparation
FixedBasisPreparedDataFixedBasisPreparedData.averaging_periodFixedBasisPreparedData.basis_artifact_pathFixedBasisPreparedData.basis_artifact_sourceFixedBasisPreparedData.basis_objectsFixedBasisPreparedData.fp_allFixedBasisPreparedData.fp_dataFixedBasisPreparedData.inv_inputsFixedBasisPreparedData.is_columnFixedBasisPreparedData.sites
prepare_fixedbasis_inversion_data()
- openghg_inversions.hbmcmc.run_hbmcmc
- openghg_inversions.inversion_data
RhimeMergedDataRhimePreparedInputsRhimePreparedInputs.averaging_periodRhimePreparedInputs.basis_artifact_pathRhimePreparedInputs.basis_artifact_sourceRhimePreparedInputs.basis_functionsRhimePreparedInputs.from_datatree()RhimePreparedInputs.from_legacy_inputs()RhimePreparedInputs.inv_inputsRhimePreparedInputs.load()RhimePreparedInputs.save()RhimePreparedInputs.site_metadataRhimePreparedInputs.sitesRhimePreparedInputs.to_datatree()RhimePreparedInputs.validated()
data_processing_surface_notracer()load_merged_data()prepare_rhime_inputs()prepare_rhime_inputs_from_xarray()- openghg_inversions.inversion_data.get_data
- openghg_inversions.inversion_data.getters
- openghg_inversions.inversion_data.preparation
RhimeMergedDataRhimePreparedInputsRhimePreparedInputs.averaging_periodRhimePreparedInputs.basis_artifact_pathRhimePreparedInputs.basis_artifact_sourceRhimePreparedInputs.basis_functionsRhimePreparedInputs.from_datatree()RhimePreparedInputs.from_legacy_inputs()RhimePreparedInputs.inv_inputsRhimePreparedInputs.load()RhimePreparedInputs.save()RhimePreparedInputs.site_metadataRhimePreparedInputs.sitesRhimePreparedInputs.to_datatree()RhimePreparedInputs.validated()
prepare_rhime_inputs()
- openghg_inversions.inversion_data.scenario
- openghg_inversions.inversion_data.serialise
clear_datatree_encoding()clear_datatree_time_attrs()combine_scenario_attrs()dataset_to_bc_data()dataset_to_flux_data()datatree_compression_encoding()datatree_to_flux_dict()datatree_to_fp_all()flux_dict_to_datatree()fp_all_from_dataset()fp_all_to_datatree()load_merged_data()make_combined_scenario()openghg_data_to_dataset()
- openghg_inversions.inversion_data.xarray_adapter
- openghg_inversions.models
CoordRegistryCorrelatedLognormalPriorCorrelatedLognormalPrior.arithmetic_covarianceCorrelatedLognormalPrior.covariance_dimCorrelatedLognormalPrior.from_dataset()CorrelatedLognormalPrior.latent_choleskyCorrelatedLognormalPrior.latent_covarianceCorrelatedLognormalPrior.latent_meanCorrelatedLognormalPrior.meanCorrelatedLognormalPrior.state_dimCorrelatedLognormalPrior.to_dataset()
CorrelatedStateResultLinearComponentResultPreparedLinearSensitivityResolvedStateActivityStateActivityactive_prior_args()add_coherent_affine_component()add_coords()add_correlated_lognormal_state()add_correlated_lognormal_state_with_activity()add_inferpymc_likelihood_component()add_linear_component()add_linked_linear_component()add_model_data()add_offset_component()add_sigma_component()apply_linear_sensitivity()attach_coord_registry()detect_zero_sensitivity()get_coord_registry()parse_prior()prepare_linear_sensitivity()registered_model()resolve_state_activity()restore_inferencedata_coords()- openghg_inversions.models.additive_sigma
- openghg_inversions.models.components
CorrelatedStateResultLinearComponentResultStateVectorResultadd_coherent_affine_component()add_correlated_lognormal_state()add_correlated_lognormal_state_with_activity()add_inferpymc_likelihood_component()add_linear_component()add_linked_linear_component()add_model_data()add_offset_component()add_sigma_component()add_state_vector()apply_linear_sensitivity()get_model_latent()resolve_model_variable()
- openghg_inversions.models.coords
- openghg_inversions.models.fixed_error
- openghg_inversions.models.pollution_event
- openghg_inversions.models.priors
- openghg_inversions.models.state_activity
- openghg_inversions.postprocessing
- openghg_inversions.postprocessing.countries
- openghg_inversions.postprocessing.diagnostics
- openghg_inversions.postprocessing.inversion_output
InversionOutputInversionOutput.basis_functionsInversionOutput.domainInversionOutput.end_dateInversionOutput.end_timeInversionOutput.fluxInversionOutput.from_datatree()InversionOutput.input_dataset()InversionOutput.inv_inputsInversionOutput.is_multisectorInversionOutput.load()InversionOutput.model_data()InversionOutput.model_metadataInversionOutput.output_metadataInversionOutput.period_midpointInversionOutput.provenanceInversionOutput.run_metadataInversionOutput.save()InversionOutput.site_namesInversionOutput.speciesInversionOutput.start_dateInversionOutput.start_timeInversionOutput.to_datatree()InversionOutput.traceInversionOutput.trace_dataset()InversionOutput.variable_name()InversionOutput.variable_roles
convert_idata_to_dataset()filter_data_vars_by_prefix()
- openghg_inversions.postprocessing.legacy_outputs
- openghg_inversions.postprocessing.make_outputs
OutputSectorbasic_output()convert_suffixes_to_dim()flat_basis_for_output()flatten_post_prior()make_concentration_outputs()make_country_outputs()make_flux_outputs()make_multisector_country_trace_outputs()make_multisector_flux_trace_outputs()make_sector_flux_outputs()model_error_output()observation_and_error_outputs()observation_inputs_for_outputs()sort_data_vars()total_error_output()
- openghg_inversions.postprocessing.make_paris_outputs
ParisTemplateFilesadd_variable_attrs()convert_time_to_unix_epoch()get_data_var_attrs()get_data_var_dtypes()infer_flux_frequency()make_global_attrs()make_paris_outputs()paris_concentration_outputs()paris_concentration_outputs_latest()paris_flux_output()paris_flux_output_latest()paris_template_files()shift_measurement_time_to_midpoint()
- openghg_inversions.postprocessing.merge_paris_outputs
- openghg_inversions.postprocessing.sigma
- openghg_inversions.postprocessing.stats
- openghg_inversions.postprocessing.utils
- openghg_inversions.rhime
AdditiveSigmaSettingsFixedErrorSettingsPollutionEventSettingsRhimeModelBuildResultRhimeModelBuilderRhimeModelBuilderContextRhimeModelSpecRhimeModelSpec.add_offsetRhimeModelSpec.aggregation_error_modeRhimeModelSpec.bc_priorRhimeModelSpec.bc_state_activityRhimeModelSpec.domainRhimeModelSpec.likelihoodRhimeModelSpec.offset_argsRhimeModelSpec.offset_priorRhimeModelSpec.sectorsRhimeModelSpec.speciesRhimeModelSpec.state_activityRhimeModelSpec.use_bc
RhimeOutputSpecRhimeResultRhimeRunSpecRhimeSamplerSectorSpecassemble_rhime_inputs()build_co2_model()build_multisector_rhime_model()build_multisector_rhime_model_result()build_rhime_basis()build_rhime_sensitivities()build_standard_rhime_model()build_standard_rhime_model_result()co2_model_input_names()filter_rhime_observations()make_multisector_rhime_outputs()make_multisector_rhime_result()make_standard_rhime_outputs()make_standard_rhime_result()materialize_pymc_inputs()multisector_model_input_names()params_from_config()resolve_flux_sources()resolve_rhime_options()retrieve_or_reload_rhime_data()run_rhime()run_rhime_co2()run_rhime_from_prepared_inputs()run_rhime_multisector()sample_rhime_model()standard_model_input_names()with_prepared_rhime_sites()- openghg_inversions.rhime.co2
Co2O2PreparedInputsCo2O2PreparedInputs.aggregation_errorCo2O2PreparedInputs.co2_sensitivityCo2O2PreparedInputs.fixed_prior_contributionCo2O2PreparedInputs.o2_co2_flux_ratioCo2O2PreparedInputs.o2_co2_flux_ratio_unavailable_reasonCo2O2PreparedInputs.o2_sensitivityCo2O2PreparedInputs.observationsCo2O2PreparedInputs.provenanceCo2O2PreparedInputs.retained_prior
build_co2_model()build_co2_o2_model()co2_model_input_names()evaluate_co2_o2_prior_forward_mean()prepare_co2_o2_inputs()run_rhime_co2()run_rhime_co2_o2_from_prepared_inputs()- openghg_inversions.rhime.co2.co2_model
- openghg_inversions.rhime.co2.co2_o2_model
- openghg_inversions.rhime.co2.co2_o2_preparation
- openghg_inversions.rhime.co2.co2_o2_runner
- openghg_inversions.rhime.co2.co2_runner
- openghg_inversions.rhime.builders
- openghg_inversions.rhime.materialization
- openghg_inversions.rhime.multisector
- openghg_inversions.rhime.outputs
- openghg_inversions.rhime.params
RhimeRunnerSetupas_list()coerce_simple_param_types()is_missing_required_value()make_rhime_runner_setup()normalise_optional_mapping()normalise_output_format_alias()normalise_param_aliases()normalise_rhime_params()normalise_sector_priors()normalise_sector_sources()params_from_config()required_run_params()resolve_flux_sources()resolve_rhime_options()validate_multisector_x_prior()validate_required_params()validate_rhime_param_types()validate_supported_params()
- openghg_inversions.rhime.preparation
- openghg_inversions.rhime.prepared
- openghg_inversions.rhime.sampling
- openghg_inversions.rhime.specs
AdditiveSigmaSettingsFixedErrorSettingsPollutionEventSettingsRhimeModelSpecRhimeModelSpec.add_offsetRhimeModelSpec.aggregation_error_modeRhimeModelSpec.bc_priorRhimeModelSpec.bc_state_activityRhimeModelSpec.domainRhimeModelSpec.likelihoodRhimeModelSpec.offset_argsRhimeModelSpec.offset_priorRhimeModelSpec.sectorsRhimeModelSpec.speciesRhimeModelSpec.state_activityRhimeModelSpec.use_bc
RhimeOutputSpecRhimeRunSpecSectorSpecmake_output_spec()validate_output_filename_convention()validate_output_format()validate_output_path_settings()
- openghg_inversions.rhime.standard
- openghg_inversions.array_ops
- Functions
- Coordinate Alignment Policy
align_sparse_lat_lon()align_to_multi_index_level_values()concat_data_arrays()concat_gather_data_arrays()concat_gather_datasets()concat_gather_datatree()force_align()get_xr_dummies()iter_multi_index_level_slices()select_gathered_data_array()sparse_xr_dot()to_dense()validate_covariance_coordinates()
- openghg_inversions.borrowed
- openghg_inversions.boundary_sensitivity
- openghg_inversions.cli
- openghg_inversions.coherent_reduction
CoherentGaussianReductionCoherentGaussianReduction.effective_observation_operatorCoherentGaussianReduction.native_observation_meanCoherentGaussianReduction.observation_interceptCoherentGaussianReduction.projection_strategyCoherentGaussianReduction.retained_covarianceCoherentGaussianReduction.retained_meanCoherentGaussianReduction.unresolved_observation_covariance
reduce_native_gaussian()
- openghg_inversions.convert
- openghg_inversions.correlated_state
CorrelatedLognormalPriorCorrelatedLognormalPrior.arithmetic_covarianceCorrelatedLognormalPrior.covariance_dimCorrelatedLognormalPrior.from_dataset()CorrelatedLognormalPrior.latent_choleskyCorrelatedLognormalPrior.latent_covarianceCorrelatedLognormalPrior.latent_meanCorrelatedLognormalPrior.meanCorrelatedLognormalPrior.state_dimCorrelatedLognormalPrior.to_dataset()
- openghg_inversions.filters
- openghg_inversions.flux_sanitization
FluxNonFiniteMetadataFluxNonFiniteMetadata.checkedFluxNonFiniteMetadata.contextFluxNonFiniteMetadata.countFluxNonFiniteMetadata.declares_zero_fill()FluxNonFiniteMetadata.fill_valueFluxNonFiniteMetadata.fractionFluxNonFiniteMetadata.from_attrs()FluxNonFiniteMetadata.from_json()FluxNonFiniteMetadata.policyFluxNonFiniteMetadata.schema_versionFluxNonFiniteMetadata.sourceFluxNonFiniteMetadata.to_json()FluxNonFiniteMetadata.to_json_dict()FluxNonFiniteMetadata.total
NonFiniteFluxWarningcopy_flux_nonfinite_attrs()sanitize_flux_nonfinite()
- openghg_inversions.inversion_inputs
- openghg_inversions.model_error
- openghg_inversions.native_covariance
InvertibleNativeCovarianceActionNativeCovarianceActionSeparableExponentialCovarianceSeparableExponentialCovariance.apply()SeparableExponentialCovariance.class_labelsSeparableExponentialCovariance.correlation_lengthSeparableExponentialCovariance.from_dataset()SeparableExponentialCovariance.latitudeSeparableExponentialCovariance.latitude_correlation_lengthSeparableExponentialCovariance.latitude_correlation_length_explicitSeparableExponentialCovariance.longitudeSeparableExponentialCovariance.longitude_correlation_lengthSeparableExponentialCovariance.longitude_correlation_length_explicitSeparableExponentialCovariance.native_dimsSeparableExponentialCovariance.schemaSeparableExponentialCovariance.schema_versionSeparableExponentialCovariance.sigmaSeparableExponentialCovariance.solve()SeparableExponentialCovariance.to_dataset()
- openghg_inversions.observation_error
- openghg_inversions.serialization
decode_cf_multiindexes()encode_cf_multiindexes()encode_multiindexes_for_storage()inferencedata_from_datatree()inferencedata_to_datatree()load_inferencedata()normalise_declared_multiindex()open_datatree_loaded()reset_serialisation_multiindexes()restore_declared_multiindexes()restore_serialisation_multiindexes()save_datatree()save_inferencedata()
- openghg_inversions.sigma
- openghg_inversions.source_covariance
IndependentSourceCovarianceIndependentSourceCovariance.apply()IndependentSourceCovariance.from_dataset()IndependentSourceCovariance.native_dimsIndependentSourceCovariance.schemaIndependentSourceCovariance.schema_versionIndependentSourceCovariance.solve()IndependentSourceCovariance.source_covariancesIndependentSourceCovariance.source_dimIndependentSourceCovariance.source_labelsIndependentSourceCovariance.to_dataset()
- openghg_inversions.utils