aerosoltools.loaders.cpc¶
Module Contents¶
- aerosoltools.loaders.cpc.load_cpc_file(file, extra_data=True)[source]¶
Load a TSI CPC (Condensation Particle Counter) export file, automatically detect its format, and return a time series of total particle number concentration as an
Aerosol1Dobject.- Parameters:
file (str) – Path to the CPC data file (typically
.txtor.csv) exported from the instrument software.extra_data (bool, optional) – If
Trueand the file is in full format, non-core diagnostic and operational parameters are stored in the returned object’s.extra_dataattribute. For focused format files, this flag has no effect because only minimal channels are available. Defaults toTrue— everything in the file is kept.
- Returns:
An
Aerosol1Dinstance containing:.datawith a datetime index and a"Total_conc"column holding particle number concentration incm⁻³..meta(metadata) populated with, e.g.:"instrument"— set to"CPC"."serial_number"— instrument serial number parsed from the header."unit"— set to"cm⁻³"."dtype"— set to"dN"(number concentration).
If
extra_data=Trueand the file is a full CPC export, additional diagnostic channels are provided in.extra_data.- Return type:
- Raises:
FileNotFoundError – If the specified
filepath does not exist or cannot be opened. Verify the path and that you have read permissions.UnicodeDecodeError – If the file cannot be decoded using the encodings tried by
sniff. Check that the file is a valid CPC export and not a binary or corrupted file.ValueError – If
sniffcannot reliably determine a delimiter from the sampled lines. This can happen for very short or malformed files.FileFormatError – If the detected column structure does not match any supported CPC format (currently focused with 4 columns or full with 14 columns). In this case, check that the file is an unmodified CPC export and that the header layout has not changed.
Notes
- Detailed description:
load_cpc_fileis the main entry point for reading CPC data. It is designed to handle at least two common export layouts:Focused format directly from the instrument (compact output):
Contains only a time column and total number concentration.
Identified by having 4 columns in the numeric data section.
Internally parsed by a specialized focused-format loader.
Full format via TSI AIM software (diagnostic-rich output):
Contains additional operational and diagnostic parameters (e.g. flow, temperature, status flags) in separate columns.
Identified by having 14 columns in the numeric data section.
Internally parsed by a specialized full-format loader, which also exposes optional diagnostics via
.extra_datawhen requested.
Examples
Typical usage is to load a single CPC file (regardless of its export format) and immediately access a clean time series:
import aerosoltools as at # Load a CPC export (focused or full format) cpc = at.load_cpc_file("data/CPC_2023-10-01.txt", extra_data=True) # Inspect the main total concentration time series print(cpc.data) # Plot the time series of total concentration fig, ax = cpc.plot_timeseries()