Skip to content

Loader Setting Builders

Particula-beta Index / Particula Beta / Data / Loader Setting Builders

Auto-generated documentation for particula_beta.data.loader_setting_builders module.

DataChecksBuilder

Show source in loader_setting_builders.py:107

Builder class for constructing the data checks dictionary.

Signature

class DataChecksBuilder(
    BuilderABC,
    ChecksCharactersMixin,
    ChecksCharCountsMixin,
    ChecksReplaceCharsMixin,
    ChecksSkipRowsMixin,
    ChecksSkipEndMixin,
):
    def __init__(self): ...

See also

DataChecksBuilder().build

Show source in loader_setting_builders.py:132

Build and return the data checks dictionary.

Signature

def build(self) -> Dict[str, Any]: ...

DateLocationBuilder

Show source in loader_setting_builders.py:144

Builder class for non standard date location.

For example the there only one date, at the start of the file, and only time is in the rows.

Signature

class DateLocationBuilder(BuilderABC, DelimiterMixin):
    def __init__(self): ...

See also

DateLocationBuilder().build

Show source in loader_setting_builders.py:205

Build and return the non standard date location dictionary.

Signature

def build(self) -> Dict[str, Any]: ...

DateLocationBuilder().set_index

Show source in loader_setting_builders.py:191

Set the index for the date location.

Arguments

  • index - The index number where the date is located, after splitting based on the delimiter. "sampling, 02/01/2023, active" will be date at index 1.

Signature

def set_index(self, index: int): ...

DateLocationBuilder().set_method

Show source in loader_setting_builders.py:167

Set the method for the date location.

Agrs: method: The current methods are "file_header_block"

Signature

def set_method(self, method: str): ...

DateLocationBuilder().set_row

Show source in loader_setting_builders.py:179

Set the row for the date location.

Arguments

  • row - The row number where the date is located.

Signature

def set_row(self, row: int): ...

Loader1DSettingsBuilder

Show source in loader_setting_builders.py:36

Builder class for creating settings for loading data from NetCDF files.

Signature

class Loader1DSettingsBuilder(
    BuilderABC,
    RelativeFolderMixin,
    FilenameRegexMixin,
    FileMinSizeBytesMixin,
    HeaderRowMixin,
    DataChecksMixin,
    DataColumnMixin,
    DataHeaderMixin,
    TimeColumnMixin,
    TimeFormatMixin,
    DelimiterMixin,
    TimeShiftSecondsMixin,
    TimezoneIdentifierMixin,
    DateLocationMixin,
):
    def __init__(self): ...

See also

Loader1DSettingsBuilder().build

Show source in loader_setting_builders.py:84

Build and return the settings dictionary for NetCDF data loading.

Signature

def build(self) -> Dict[str, Any]: ...

LoaderSizerSettingsBuilder

Show source in loader_setting_builders.py:243

Builder class for creating settings for loading and checking sizer 1D and 2D data from CSV files.

Signature

class LoaderSizerSettingsBuilder(
    BuilderABC,
    RelativeFolderMixin,
    FilenameRegexMixin,
    FileMinSizeBytesMixin,
    HeaderRowMixin,
    DataChecksMixin,
    DataColumnMixin,
    DataHeaderMixin,
    TimeColumnMixin,
    TimeFormatMixin,
    DelimiterMixin,
    TimeShiftSecondsMixin,
    TimezoneIdentifierMixin,
    SizerDataReaderMixin,
    DateLocationMixin,
):
    def __init__(self): ...

See also

LoaderSizerSettingsBuilder().build

Show source in loader_setting_builders.py:296

Build and return the two dictionaries for 1D and 2D sizer data loading .

Signature

def build(self) -> Tuple[Dict[str, Any], Dict[str, Any]]: ...

NetcdfReader1dBuilder

Show source in loader_setting_builders.py:338

Builder class for constructing the NetCDF 1D reader dictionary.

Signature

class NetcdfReader1dBuilder(BuilderABC):
    def __init__(self): ...

NetcdfReader1dBuilder().build

Show source in loader_setting_builders.py:366

Build and return the NetCDF reader dictionary.

Signature

def build(self) -> Dict[str, Any]: ...

NetcdfReader1dBuilder().set_data_1d

Show source in loader_setting_builders.py:352

Set the data headers to read from the NetCDF file.

Signature

def set_data_1d(self, data_1d: list[str] | str): ...

NetcdfReader1dBuilder().set_header_1d

Show source in loader_setting_builders.py:359

Set the header for 1D data for the Stream file.

Signature

def set_header_1d(self, header_1d: list[str] | str): ...

NetcdfReader2dBuilder

Show source in loader_setting_builders.py:376

Builder class for constructing the NetCDF 2D reader dictionary.

Signature

class NetcdfReader2dBuilder(BuilderABC):
    def __init__(self): ...

NetcdfReader2dBuilder().build

Show source in loader_setting_builders.py:406

Build and return the NetCDF reader dictionary.

Signature

def build(self) -> Dict[str, Any]: ...

NetcdfReader2dBuilder().set_data_2d

Show source in loader_setting_builders.py:390

Set the data headers for 2D data in the NetCDF file.

Signature

def set_data_2d(self, data_2d: list[str] | str): ...

NetcdfReader2dBuilder().set_header_2d

Show source in loader_setting_builders.py:397

Set the header for 2D data for the Stream file. set to str("None") to used a 0-nth index for the header.

Signature

def set_header_2d(self, header_2d: list[str] | str): ...

NetcdfSettingsBuilder

Show source in loader_setting_builders.py:417

Builder class for creating settings for loading and checking data from ARM NetCDF files.

Signature

class NetcdfSettingsBuilder(
    BuilderABC,
    RelativeFolderMixin,
    FilenameRegexMixin,
    FileMinSizeBytesMixin,
    TimeColumnMixin,
    TimeFormatMixin,
    TimeShiftSecondsMixin,
    TimezoneIdentifierMixin,
):
    def __init__(self): ...

See also

NetcdfSettingsBuilder().build

Show source in loader_setting_builders.py:462

Build and return the settings dictionary for 1D data loading.

Signature

def build(self) -> Dict[str, Any]: ...

NetcdfSettingsBuilder().set_netcdf_reader

Show source in loader_setting_builders.py:452

Set the NetCDF reader settings.

Signature

def set_netcdf_reader(self, netcdf_reader: Dict[str, Any]): ...

SizerDataReaderBuilder

Show source in loader_setting_builders.py:215

Builder class for constructing the sizer data reader dictionary.

Signature

class SizerDataReaderBuilder(
    BuilderABC,
    SizerConcentrationConvertFromMixin,
    SizerStartKeywordMixin,
    SizerEndKeywordMixin,
):
    def __init__(self): ...

See also

SizerDataReaderBuilder().build

Show source in loader_setting_builders.py:233

Build and return the sizer data reader dictionary.

Signature

def build(self) -> Dict[str, Any]: ...