Constants#

ctdfjorder.constants.constants.TIMESTAMP_LABEL#

Label for timestamp column.

Type:

str

ctdfjorder.constants.constants.YEAR_LABEL#

Label for year column.

Type:

str

ctdfjorder.constants.constants.MONTH_LABEL#

Label for month column.

Type:

str

ctdfjorder.constants.constants.FILENAME_LABEL#

Label for filename column.

Type:

str

ctdfjorder.constants.constants.CHLOROPHYLL_LABEL#

Label for chlorophyll column.

Type:

str

ctdfjorder.constants.constants.TEMPERATURE_LABEL#

Label for temperature column.

Type:

str

ctdfjorder.constants.constants.SEA_PRESSURE_LABEL#

Label for sea pressure column.

Type:

str

ctdfjorder.constants.constants.DEPTH_LABEL#

Label for depth column.

Type:

str

ctdfjorder.constants.constants.SALINITY_LABEL#

Label for salinity column.

Type:

str

ctdfjorder.constants.constants.SPEED_OF_SOUND_LABEL#

Label for speed of sound column.

Type:

str

ctdfjorder.constants.constants.SPECIFIC_CONDUCTIVITY_LABEL#

Label for specific conductivity column.

Type:

str

ctdfjorder.constants.constants.CONDUCTIVITY_LABEL#

Label for conductivity column.

Type:

str

ctdfjorder.constants.constants.PRESSURE_LABEL#

Label for pressure column.

Type:

str

ctdfjorder.constants.constants.SALINITY_ABS_LABEL#

Label for absolute salinity column.

Type:

str

ctdfjorder.constants.constants.SURFACE_SALINITY_LABEL#

Label for surface salinity column.

Type:

str

ctdfjorder.constants.constants.SURFACE_TEMPERATURE_LABEL#

Label for surface temperature column.

Type:

str

ctdfjorder.constants.constants.SURFACE_DENSITY_LABEL#

Label for surface density column.

Type:

str

ctdfjorder.constants.constants.MELTWATER_FRACTION_LABEL#

Label for meltwater fraction column.

Type:

str

ctdfjorder.constants.constants.DENSITY_LABEL#

Label for density column.

Type:

str

ctdfjorder.constants.constants.POTENTIAL_DENSITY_LABEL#

Label for potential density column.

Type:

str

ctdfjorder.constants.constants.BV_LABEL#

Label for Brunt-Väisälä frequency squared column.

Type:

str

ctdfjorder.constants.constants.P_MID_LABEL#

Label for mid pressure used for Brunt-Väisälä calculation column.

Type:

str

ctdfjorder.constants.constants.SECCHI_DEPTH_LABEL#

Label for Secchi depth column.

Type:

str

ctdfjorder.constants.constants.LATITUDE_LABEL#

Label for latitude column.

Type:

str

ctdfjorder.constants.constants.LONGITUDE_LABEL#

Label for longitude column.

Type:

str

ctdfjorder.constants.constants.UNIQUE_ID_LABEL#

Label for unique ID column.

Type:

str

ctdfjorder.constants.constants.PROFILE_ID_LABEL#

Label for profile ID column.

Type:

str

ctdfjorder.constants.constants.LIST_LABELS#

List of all internal column labels.

Type:

list[str]

ctdfjorder.constants.constants.EXPORT_TIMESTAMP_LABEL#

Export label for timestamp.

Type:

str

ctdfjorder.constants.constants.EXPORT_YEAR_LABEL#

Export label for year.

Type:

str

ctdfjorder.constants.constants.EXPORT_MONTH_LABEL#

Export label for month.

Type:

str

ctdfjorder.constants.constants.EXPORT_TEMPERATURE_LABEL#

Export label for temperature.

Type:

str

ctdfjorder.constants.constants.EXPORT_PRESSURE_LABEL#

Export label for pressure.

Type:

str

ctdfjorder.constants.constants.EXPORT_DEPTH_LABEL#

Export label for depth.

Type:

str

ctdfjorder.constants.constants.EXPORT_SEA_PRESSURE_LABEL#

Export label for sea pressure.

Type:

str

ctdfjorder.constants.constants.EXPORT_CHLOROPHYLL_LABEL#

Export label for chlorophyll-a.

Type:

str

ctdfjorder.constants.constants.EXPORT_SALINITY_LABEL#

Export label for salinity.

Type:

str

ctdfjorder.constants.constants.EXPORT_SPECIFIC_CONDUCTIVITY_LABEL#

Export label for specific conductivity.

Type:

str

ctdfjorder.constants.constants.EXPORT_CONDUCTIVITY_LABEL#

Export label for conductivity.

Type:

str

ctdfjorder.constants.constants.EXPORT_DENSITY_LABEL#

Export label for density.

Type:

str

ctdfjorder.constants.constants.EXPORT_POTENTIAL_DENSITY_LABEL#

Export label for potential density.

Type:

str

ctdfjorder.constants.constants.EXPORT_SALINITY_ABS_LABEL#

Export label for absolute salinity.

Type:

str

ctdfjorder.constants.constants.EXPORT_SURFACE_DENSITY_LABEL#

Export label for mean surface density.

Type:

str

ctdfjorder.constants.constants.EXPORT_SPEED_OF_SOUND_LABEL#

Export label for speed of sound.

Type:

str

ctdfjorder.constants.constants.EXPORT_SURFACE_SALINITY_LABEL#

Export label for surface salinity.

Type:

str

ctdfjorder.constants.constants.EXPORT_SURFACE_TEMPERATURE_LABEL#

Export label for surface temperature.

Type:

str

ctdfjorder.constants.constants.EXPORT_MELTWATER_FRACTION_LABEL#

Export label for meltwater fraction.

Type:

str

ctdfjorder.constants.constants.EXPORT_LONGITUDE_LABEL#

Export label for longitude.

Type:

str

ctdfjorder.constants.constants.EXPORT_LATITUDE_LABEL#

Export label for latitude.

Type:

str

ctdfjorder.constants.constants.EXPORT_FILENAME_LABEL#

Export label for filename.

Type:

str

ctdfjorder.constants.constants.EXPORT_PROFILE_ID_LABEL#

Export label for profile ID.

Type:

str

ctdfjorder.constants.constants.EXPORT_UNIQUE_ID_LABEL#

Export label for unique ID.

Type:

str

ctdfjorder.constants.constants.EXPORT_BV_LABEL#

Export label for Brunt-Väisälä frequency squared.

Type:

str

ctdfjorder.constants.constants.EXPORT_P_MID_LABEL#

Export label for mid pressure used for Brunt-Väisälä calculation.

Type:

str

ctdfjorder.constants.constants.EXPORT_SECCHI_DEPTH_LABEL#

Export label for Secchi depth.

Type:

str

ctdfjorder.constants.constants.TIME_ZONE#

Time zone used for timestamps.

Type:

str

ctdfjorder.constants.constants.TIME_UNIT#

Time unit for timestamps.

Type:

Literal[“ns”, “us”, “ms”]

ctdfjorder.constants.constants.TIME_FORMAT#

Format for timestamps.

Type:

str

ctdfjorder.constants.constants.ERROR_NO_SAMPLES#

Error message for no samples in file.

Type:

str

ctdfjorder.constants.constants.ERROR_NO_LOCATION#

Error message for no location found.

Type:

str

ctdfjorder.constants.constants.ERROR_DENSITY_CALCULATION#

Error message for density calculation failure.

Type:

str

ctdfjorder.constants.constants.ERROR_SALINITY_ABS#

Error message for salinity absolute calculation failure.

Type:

str

ctdfjorder.constants.constants.ERROR_NO_MASTER_SHEET#

Error message for missing master sheet.

Type:

str

ctdfjorder.constants.constants.ERROR_RSK_CORRUPT#

Error message for corrupted Ruskin file.

Type:

str

ctdfjorder.constants.constants.ERROR_LOCATION_DATA_INVALID#

Error message for invalid location data.

Type:

str

ctdfjorder.constants.constants.ERROR_NO_TIMESTAMP_IN_FILE#

Error message for missing timestamp in file.

Type:

str

ctdfjorder.constants.constants.ERROR_NO_TIMESTAMP_IN_MASTER_SHEET#

Error message for missing timestamp in master sheet.

Type:

str

ctdfjorder.constants.constants.ERROR_MLD_DEPTH_RANGE#

Error message for insufficient depth range to calculate MLD.

Type:

str

ctdfjorder.constants.constants.ERROR_GRU_INSUFFICIENT_DATA#

Error message for insufficient data to run the GRU.

Type:

str

ctdfjorder.constants.constants.ERROR_CASTAWAY_START_TIME#

Error message for missing time data in Castaway file.

Type:

str

ctdfjorder.constants.constants.ERROR_CTD_FILENAME_ENDING#

Error message for invalid CTD filename ending.

Type:

str

ctdfjorder.constants.constants.WARNING_DROPPED_PROFILE#

Warning message for dropped profile due to no samples.

Type:

str

ctdfjorder.constants.constants.WARNING_CTD_SURFACE_MEASUREMENT#

Warning message for invalid surface measurement.

Type:

str

ctdfjorder.constants.constants.WARNING_FILE_LACKS_LOCATION#

Warning message for file lacking native location data.

Type:

str

ctdfjorder.constants.constants.FILENAME_GPS_ENDING#

Suffix for GPS filename.

Type:

str

ctdfjorder.constants.constants.FILENAME_CM_ENDING#

Suffix for CM filename.

Type:

str

ctdfjorder.constants.constants.RSK_FILE_MARKER#

Marker for RSK file.

Type:

str

ctdfjorder.constants.constants.CASTAWAY_FILE_MARKER#

Marker for Castaway file.

Type:

str

ctdfjorder.constants.constants.CASTAWAY_DATETIME_LABEL#

Column label for datetime in Castaway files.

Type:

str

ctdfjorder.constants.constants.CASTAWAY_FILE_ID_LABEL#

Column label for file ID in Castaway files.

Type:

str

ctdfjorder.constants.constants.CONCAT_HOW#

Concatenation method for merging data.

Type:

Literal[“diagonal_relaxed”]

ctdfjorder.constants.constants.SEA_PRESSURE_TO_PRESSURE_DIFF#

Conversion factor from sea pressure to pressure difference.

Type:

float

ctdfjorder.constants.constants.LIB_LOGGER_NAME#

Logger name for the CTDFjorder library.

Type:

str