neptoon.config

configuration_input

Classes:

• BaseConfig
• SensorInfo
• TimeSeriesColumns
• TimeSeriesData
• ParserKeywords
• RawDataParseConfig
• FlagRange
• PersistenceCheck
• SpikeUniLOF
• SpikeZScore
• SpikeOffset
• GreaterThanN0
• BelowN0Factor
• QAColumnConfig
• QAConfig
• SoilMoistureQA
• CalibrationColumnNames
• CalibrationConfig
• DataStorageConfig
• FiguresConfig
• NeutronQualityAssessment
• SensorConfig
• ReferenceNeutronMonitor
• AirHumidityCorrection
• AirPressureCorrection
• SoilMoistureEstimation
• IncomingRadiationCorrection
• BiomassCorrection
• CorrectionSteps
• SmoothingAlgorithmSettings
• DataSmoothingConfig
• Temporal
• ProcessConfig
• ConfigType
• ConfigurationManager

Functions:

• rich_validation
• calculate_rigidity_if_missing
• validate_range
• convert_list_to_tuple
• validate_poly_order
• load_configuration
• get_config
• create_sensor_config

BaseConfig

Bases: BaseModel

Base configuration class with flexible field allowance. All configuration models inherit from this to maintain consistency.

SensorInfo

Bases: BaseConfig

General site metadata section.

TimeSeriesColumns

Bases: BaseConfig

Defines the structure for column configurations while allowing extensions.

ParserKeywords

Bases: BaseModel

Configuration for specific parser keywords.

RawDataParseConfig

Bases: BaseModel

Configuration for parsing raw data files.

FlagRange

Bases: BaseConfig

Common pattern for min/max range checks.

validate_range

validate_range()

Validate min is less than max after both fields are set.

PersistenceCheck

Bases: BaseConfig

Configuration for persistence checking.

QAColumnConfig

Bases: BaseConfig

Base configuration for QA columns.

Includes all possible QA systems as optional.

QAConfig

Bases: BaseConfig

Quality assessment configuration section.

CalibrationColumnNames

Bases: BaseConfig

Column naming configuration for calibration data.

CalibrationConfig

Bases: BaseConfig

Configuration for calibration data.

NeutronQualityAssessment

Bases: BaseConfig

Quality assessment configuration for Neutrons

SensorConfig

Bases: BaseConfig

Top-level configuration.

ReferenceNeutronMonitor

Bases: BaseModel

Configuration for reference neutron monitor settings.

AirHumidityCorrection

Bases: BaseModel

Configuration for air humidity correction parameters.

AirPressureCorrection

Bases: BaseModel

Configuration for air pressure correction parameters.

SoilMoistureEstimation

Bases: BaseModel

Configuration for the conversion of neutrons to soil moisture

IncomingRadiationCorrection

Bases: BaseModel

Configuration for incoming radiation correction parameters.

BiomassCorrection

Bases: BaseModel

Configuration for above ground biomass correction parameters.

CorrectionSteps

Bases: BaseModel

Main configuration for all correction steps.

SmoothingAlgorithmSettings

Bases: BaseModel

Configuration settings for data smoothing algorithms.

Validates and enforces constraints specific to different smoothing methods: - Window size must be positive - For Savitzky-Golay: - Window size should be odd - Polynomial order must be less than window size

validate_poly_order

validate_poly_order()

Validate polynomial order relative to window size.

DataSmoothingConfig

Bases: BaseModel

Main configuration for data smoothing operations.

Controls which data series should be smoothed and defines the smoothing parameters to be applied.

ConfigurationManager

ConfigurationManager(running_in_docker=False)

Manages loading and access of nested configurations.

Init

Parameters:

Name	Type	Description	Default
running_in_docker	bool	Whether neptoon is being run in docker (automatically applied when true in CLI process), by default False	False

load_configuration

load_configuration(file_path)

Load and validate nested configuration.

Parameters:

Name	Type	Description	Default
file_path	str	Path to YAML configuration file	required

get_config

get_config(name)

Return the specific config

Parameters:

Name	Type	Description	Default
name	str	Either sensor or process	required

Returns:

Type	Description
BaseConfig	The requested config

rich_validation

rich_validation(config_file, verbose=False)

Simple context manager for Pydantic validation errors.

Args: style: "table" or "list" format verbose: If False, shows minimal error info without input values