epyr.fair.data_processing

Core data processing and metadata handling for FAIR format conversion.

This module contains functions for processing Bruker EPR parameters and preparing metadata for FAIR format export.

Functions

append_fair_metadata(data_dict, pars[, ...])	Append FAIR metadata to existing data dictionary.
extract_axis_info(pars)	Extract axis information from parameters.
get_experiment_summary(metadata)	Extract key experimental parameters for quick overview.
process_parameters(pars)	Split raw Bruker parameters into FAIR-mapped and unmapped buckets.
validate_fair_metadata(metadata)	Validate FAIR metadata for completeness and correctness.

epyr.fair.data_processing.process_parameters(pars)

Split raw Bruker parameters into FAIR-mapped and unmapped buckets.

Uses epyr.fair.BRUKER_PARAM_MAP to translate Bruker keys (DSC / SPL / DSL sections) into FAIR field names with explicit units and descriptions. Unit references ('refer to XUNI') are resolved against the source dictionary.

Parameters:

pars (dict) – Raw parameters from epyr.eprload().

Returns:

• fair_metadata (dict) – {fair_name: {'value', 'unit', 'description'}, ...}, including a conversion_info entry with timestamp and EPyR version.

• unmapped_parameters (dict) – Pass-through of keys not present in BRUKER_PARAM_MAP.

Return type:

Tuple[Dict[str, Any], Dict[str, Any]]

Examples

>>> from epyr import eprload
>>> from epyr.fair import process_parameters
>>> x, y, params, _ = eprload("examples/data/130406SB_CaWO4_Er_CW_5K_20.DSC")
>>> fair, unmapped = process_parameters(params)
>>> "microwave_frequency" in fair
True

epyr.fair.data_processing.append_fair_metadata(data_dict, pars, original_file='')

Append FAIR metadata to existing data dictionary.

Parameters:

• data_dict (Dict[str, Any]) – Existing data dictionary to append to

• pars (Dict[str, Any]) – Raw parameters from Bruker file

• original_file (str) – Original file path

Returns:

Updated data dictionary with FAIR metadata

Return type:

Dict[str, Any]

epyr.fair.data_processing.extract_axis_info(pars)

Extract axis information from parameters.

Parameters:

pars (Dict[str, Any]) – Raw parameters dictionary

Returns:

Dictionary with x, y, z axis information

Return type:

Dict[str, Dict[str, Any]]

epyr.fair.data_processing.validate_fair_metadata(metadata)

Validate FAIR metadata for completeness and correctness.

Parameters:

metadata (Dict[str, Any]) – FAIR metadata dictionary

Returns:

List of validation warnings/errors

Return type:

List[str]

epyr.fair.data_processing.get_experiment_summary(metadata)

Extract key experimental parameters for quick overview.

Parameters:

metadata (Dict[str, Any]) – FAIR metadata dictionary

Returns:

Dictionary with experiment summary

Return type:

Dict[str, Any]