oceanarray 0.1.0__py3-none-any.whl

oceanarray/logsheet/data/column_defs.yaml

@@ -0,0 +1,686 @@
+# column_defs.yaml
+# Column definitions for each logsheet type x instrument type.
+# Read by sheet_builder.py.
+#
+# COLUMN LIBRARY (top section)
+# ─────────────────────────────
+# All named columns with their default header, width, input type and (where
+# appropriate) example value.  Each sheet type below references columns by
+# key.  Lists may contain:
+#   - plain string    : use library entry as-is
+#   - {key: {overrides}}: use library entry with field overrides (e.g. width,
+#                         example, header)
+#   - {header: ..., width: ..., input: ...}: inline full definition (bypasses
+#                         the library entirely; used only where a column is
+#                         unique to one sheet)
+#
+# width values are RELATIVE weights — sheet_builder.py normalises them to
+# fill A4 landscape text width.  Rough scale: 1.0 ≈ normal, 0.7 ≈ narrow
+# tick column, 2.0+ ≈ wide text/date column.
+
+# ===========================================================================
+# COLUMN LIBRARY
+# ===========================================================================
+
+column_library:
+
+  # ── Universal ─────────────────────────────────────────────────────────────
+  sn:
+    header: "SN"
+    width: 0.6
+    input: readonly
+  pc_used:
+    header: "PC used"
+    width: 0.8
+    input: free
+    example: "ifm23-w01"
+  transfer_to_server:
+    header: "Transfer to server?"
+    width: 0.7
+    input: tick
+    example: "\\checkmark"
+  date_time_ok:
+    header: "Date & time ok?"
+    width: 0.6
+    input: tick
+    example: "\\checkmark"
+  startlater:
+    header: "STARTLATER sent?"
+    width: 0.85
+    input: tick
+    example: "\\checkmark"
+
+  # ── Download shared ────────────────────────────────────────────────────────
+  visible_defects:
+    header: "Visible defects?"
+    width: 1.2
+    input: free
+    example: "--"
+  stopped_ok:
+    header: "Stopped ok?"
+    width: 0.7
+    input: tick
+    example: "\\checkmark"
+  last_sample_num:
+    header: "Last sample #"
+    width: 1.0
+    input: free
+  scan_range:
+    header: "Scan range (from-to)"
+    width: 1.2
+    input: free
+  download_complete:
+    header: "Download complete?"
+    width: 0.8
+    input: tick
+    example: "\\checkmark"
+  filename_convention:
+    header: "Filename ({download_convention})"
+    width: 1.5
+    input: free
+  convert_to_cnv:
+    header: "Convert to CNV?"
+    width: 0.7
+    input: tick
+    example: "\\checkmark"
+  convert_to_csv:
+    header: "Convert to CSV?"
+    width: 0.7
+    input: tick
+    example: "\\checkmark"
+  convert_hex_matlab:
+    header: "Convert hex to legacy Matlab (Ruskin)?"
+    width: 1.0
+    input: tick
+    example: "\\checkmark"
+  file_size_mb:
+    header: "File size (MB)"
+    width: 0.8
+    input: free
+
+  # ── Status/clock timing ───────────────────────────────────────────────────
+  computer_time_at_ds:
+    header: "Computer time at ds"
+    width: 0.7
+    input: free
+    example: "10:23:00"
+  instrument_time_at_ds:
+    header: "Instrument time at ds"
+    width: 0.7
+    input: free
+    example: "10:23:17"
+  computer_time_at_status:
+    header: "Computer time at status"
+    width: 0.7
+    input: free
+    example: "10:23:00"
+  instrument_time_at_status:
+    header: "Instrument time at status"
+    width: 0.7
+    input: free
+    example: "10:23:17"
+
+  # ── MicroCAT old_seaterm commands ─────────────────────────────────────────
+  interval_10s:
+    header: "INTERVAL= (10)"
+    width: .8
+    input: free
+  samplenum_no_reset:
+    header: "SAMPLENUM= (do NOT reset)"
+    width: 1.4
+    input: free
+  samplenum_reset_0:
+    header: "SAMPLENUM=0 sent?"
+    width: 1.0
+    input: tick
+    example: "\\checkmark"
+  storetime_y:
+    header: "STORETIME= (y)"
+    width: 0.85
+    input: free
+  navg_1:
+    header: "NAVG= (1)"
+    width: 0.8
+    input: free
+  start_ddmmyyyy:
+    header: "START [DDMMYYYY]"
+    width: 1.8
+    input: free
+  start_hhmmss:
+    header: "START [hhmmss]"
+    width: 1.8
+    input: free
+  start_datetime:
+    header: "Start date/time"
+    width: 2.0
+    input: free
+
+  # ── MicroCAT seaterm_v2 commands ──────────────────────────────────────────
+  sampleinterval_10s:
+    header: "SAMPLEINTERVAL =(10)"
+    width: 1.15
+    input: free
+  output_settings_v2:
+    header: "OutputExecutedTag=n Outputformat=3 BaudRate=38400"
+    width: 1.4
+    input: tick
+  txrealtime_Y:
+    header: "TXREALTIME = ?"
+    width: 0.85
+    input: free
+  txrealtime_N:
+    header: "TXREALTIME =(N)"
+    width: 0.7
+    input: free
+  samplenumber_no_reset:
+    header: "SAMPLENUMBER= (do NOT reset)"
+    width: 1.1
+    input: free
+  samplenumber_reset_0:
+    header: "SAMPLENUMBER =0 sent?"
+    width: 1.0
+    input: tick
+    example: "\\checkmark"
+  startdatetime:
+    header: "STARTDATETIME= [MMDDYYYY][hhmmss]"
+    width: 1.8
+    input: free
+
+  # ── MicroCAT seaterm_v2_odo extras ────────────────────────────────────────
+  oxntau_1:
+    header: "OXNTAU= (1)"
+    width: 0.7
+    input: free
+  oxntau_7:
+    header: "OXNTAU= (7)"
+    width: 0.7
+    input: free
+  oxtau20_55:
+    header: "OXTAU20= (5.5)"
+    width: 0.7
+    input: free
+  adaptivepump_N:
+    header: "ADAPTIVEPUMP CONTROL=N"
+    width: 0.8
+    input: free
+  adaptivepump_Y:
+    header: "ADAPTIVEPUMP CONTROL=Y"
+    width: 0.8
+    input: free
+
+  # ── Aquadopp ──────────────────────────────────────────────────────────────
+  sampling_interval:
+    header: "Sampling interval (s)"
+    width: .8
+    input: free
+  average_interval:
+    header: "Average interval (s)"
+    width: .8
+    input: free
+  blanking_dist:
+    header: "Blanking dist (m)"
+    width: 0.8
+    input: free
+  capture_file:
+    header: "Capture file"
+    width: .5
+    input: free
+  compass_update:
+    header: "Compass update (s)"
+    width: 0.8
+    input: free
+  coordinate_system:
+    header: "Coordinate system"
+    width: 0.8
+    input: free
+  diag_interval:
+    header: "Diag interval"
+    width: 0.5
+    input: free
+  diag_samples:
+    header: "Diag samples"
+    width: 0.7
+    input: free
+  start_datetime_aq:
+    header: "Start date/time [DDMMYYYY hhmmss]"
+    width: 2.0
+    input: free
+  screenshot_file:
+    header: "Screenshot file"
+    width: 1.5
+    input: free
+  sos_measured_or_fixed:
+    header: "Speed of sound: measured | fixed"
+    width: 1.0
+    input: free
+  sos_fixed:
+    header: "Speed of sound measured"
+    width: 1.0
+    input: free
+  sos_salinity:
+    header: "If measured, salinity"
+    width: 1.0
+    input: free
+
+  # ── RBR ───────────────────────────────────────────────────────────────────
+  rbr_model:
+    header: "Model"
+    width: 1.2
+    input: readonly
+  sample_interval:
+    header: "Sample interval (s)"
+    width: 0.8
+    input: free
+  enabled:
+    header: "Enabled?"
+    width: 0.7
+    input: tick
+
+# ===========================================================================
+# CALDIP SETUP
+# ===========================================================================
+
+microcat_setup_caldip:
+  data_path_note: |
+    Data path: {caldip_data}/cal_dip/{cast_label}/
+    Firmware < 3.0d: {default_filename}_cal_dip_data.asc
+    Firmware >= 3.0d: {default_filename}_cal_dip_data.xml -> Convert XML -> .cnv
+
+  columns_old_seaterm:
+    - sn
+    - date_time_ok
+    - interval_10s: {example: "10"}
+    - samplenum_no_reset: {example: "NO"}
+    - storetime_y: {example: "--"}
+    - navg_1: {example: "1"}
+    - start_ddmmyyyy
+    - start_hhmmss
+    - startlater
+    - transfer_to_server
+
+  columns_seaterm_v2:
+    - sn
+    - date_time_ok: {width: 0.55}
+    #- output_settings_v2: {example: "\\checkmark"}
+    - sampleinterval_10s: {example: "10"}
+    - txrealtime_Y: {example: "N"}
+    - samplenumber_no_reset: {example: "NO"}
+    - startdatetime
+    - startlater
+    - transfer_to_server
+
+  columns_seaterm_v2_odo:
+    - sn
+    - date_time_ok: {width: 0.7}
+    - sampleinterval_10s: {width: 1.0, example: "10"}
+    - oxntau_1
+    - oxtau20_55
+    - adaptivepump_N
+#    - output_settings_v2: {width: 1.2, example: "\\checkmark"}
+    - txrealtime_Y: {width: 0.7, example: "N"}
+    - samplenumber_no_reset: {width: 1.3, example: "--"}
+    - startdatetime: {width: 2.5}
+    - startlater
+    - transfer_to_server
+
+aquadopp_setup_caldip:
+  section_title: "Aquadopp Calibration Dip Setup"
+  columns:
+    - sn
+    - sampling_interval
+    - average_interval
+    - blanking_dist
+    - compass_update
+    - coordinate_system
+    - diag_interval
+    - start_datetime_aq
+    - transfer_to_server
+
+rbr_setup_caldip:
+  section_title: "RBR Thermistor Calibration Dip Setup"
+  columns:
+    - sn
+    - date_time_ok: {width: 0.7}
+    - sample_interval: {example: "1"}
+    - start_ddmmyyyy: {width: 1.6, header: "START [DD/MM/YYYY]", example: "10/07/2026"}
+    - start_hhmmss: {width: 1.4, header: "START [hh:mm:ss]"}
+    - enabled: {example: "\\checkmark"}
+    - screenshot_file: {header: "Screenshot?", width: 0.8, input: tick, example: "\\checkmark"}
+    - transfer_to_server
+
+# ===========================================================================
+# CALDIP DOWNLOAD
+# ===========================================================================
+
+microcat_download_caldip:
+  data_path_note: |
+    Data path: {caldip_data}/cal_dip/{cast_label}/
+    Firmware < 3.0d: {default_filename}_cal_dip_data.asc
+    Firmware >= 3.0d: {default_filename}_cal_dip_data.xml -> Convert XML -> .cnv
+
+  columns_old_seaterm:
+    - sn
+    - visible_defects
+    - pc_used
+    - date_time_ok
+    - stopped_ok
+    - last_sample_num
+    - filename_convention: {header: "Filename ({default_filename}_cal_dip_data.asc)", width: 2.0}
+    - scan_range: {width: 1.5}
+    - file_size_mb
+    - transfer_to_server
+
+  columns_seaterm_v2:
+    - sn
+    - visible_defects
+    - pc_used
+    - date_time_ok
+    - stopped_ok
+    - last_sample_num
+    - filename_convention: {header: "Filename ({default_filename}_cal_dip_data.xml)", width: 2.0}
+    - scan_range: {width: 1.5}
+    - file_size_mb
+    - transfer_to_server
+
+  columns_seaterm_v2_odo:
+    - sn
+    - visible_defects
+    - pc_used
+    - date_time_ok
+    - stopped_ok: {width: .5}
+    - last_sample_num
+    - filename_convention: {header: "Filename ({default_filename}_cal_dip_data.xml)", width: 2.5}
+    - scan_range: {width: 1.0}
+    - file_size_mb: {width: .5}
+    - transfer_to_server
+
+aquadopp_download_caldip:
+  section_title: "Aquadopp Calibration Dip Download"
+  data_path_note: |
+    Data path: {caldip_data}/cal_dip/{cast_label}/
+    Note: only Aquadopps with a .prf file need converting to csv; others can be transferred as-is.
+  columns:
+    - sn
+    - visible_defects
+    - pc_used
+    - stopped_ok
+    - filename_convention: {header: "Filename ({default_filename}_cal_dip_data)", width: 2.5}
+    - download_complete
+    - convert_to_csv
+    - file_size_mb
+    - transfer_to_server
+
+rbr_solot_download_caldip:
+  section_title: "RBR soloT Calibration Dip Download"
+  data_path_note: |
+    Data path: {caldip_data}/cal_dip/{cast_label}/
+  columns:
+    - sn: {example: "101645"}
+    - visible_defects: {example: "--"}
+    - pc_used
+    - stopped_ok
+    - download_complete
+    - filename_convention: {example: "_cal_dip_data.rsk"}
+    - file_size_mb
+    - transfer_to_server
+
+rbr_tr1050_download_caldip:
+  section_title: "RBR TR-1050 Calibration Dip Download"
+  data_path_note: |
+    Data path: {caldip_data}/cal_dip/{cast_label}/
+    Download .hex via Ruskin; convert hex to legacy Matlab before uploading.
+  columns:
+    - sn: {example: "15576"}
+    - visible_defects: {example: "bent thermistor"}
+    - pc_used
+    - stopped_ok
+    - filename_convention: {example: "_cal_dip_data.hex"}
+    - download_complete
+    - convert_hex_matlab
+    - file_size_mb
+    - transfer_to_server
+
+# ===========================================================================
+# MOORING DOWNLOAD (post-deployment, raw data)
+# ===========================================================================
+
+microcat_download_mooring:
+  data_path_note: |
+    Data path: {raw_data}/{instrument}/{mooring}/
+    Filename: {download_convention}
+
+  columns_old_seaterm:
+    - sn: {example: "2941"}
+    - visible_defects: {example: "missing cage"}
+    - pc_used
+    - stopped_ok: {width: 0.6}
+    - last_sample_num: {example: "23724"}
+    - computer_time_at_ds
+    - instrument_time_at_ds
+    - scan_range: {example: "0--23724"}
+    - filename_convention: {example: "_recovery.asc"}
+    - file_size_mb
+    - transfer_to_server
+
+  columns_seaterm_v2:
+    - sn: {example: "7507"}
+    - visible_defects: {example: "--"}
+    - pc_used
+    - stopped_ok
+    - computer_time_at_ds
+    - instrument_time_at_ds
+    - last_sample_num: {example: "23724"}
+    - filename_convention: {example: "_recovery.xml"}
+    - scan_range: {example: "0--23724", width: 1.5}
+    - convert_to_cnv
+    - file_size_mb
+    - transfer_to_server
+
+  columns_seaterm_v2_odo:
+    - sn: {example: "13995"}
+    - visible_defects: {example: "--"}
+    - pc_used
+    - computer_time_at_ds
+    - instrument_time_at_ds
+    - stopped_ok
+    - last_sample_num: {example: "23724"}
+    - scan_range: {example: "23000--23724", width: 1.0}
+    - filename_convention: {example: "_recovery.xml"}
+    - convert_to_cnv
+    - file_size_mb
+    - transfer_to_server
+
+aquadopp_download_mooring:
+  section_title: "Aquadopp Download"
+  data_path_note: |
+    Data path: {raw_data}/{instrument}/{mooring}/
+    Filename: {download_convention} (instrument-generated name; rename to this convention)
+  columns:
+    - sn: {example: "400125"}
+    - visible_defects: {example: "--"}
+    - pc_used
+    - computer_time_at_status
+    - instrument_time_at_status
+    - download_complete
+    - filename_convention: {example: "A400125002_400125_recovery.zip"}
+    - convert_to_csv
+    - file_size_mb
+    - transfer_to_server
+
+rbr_tr1050_download_mooring:
+  section_title: "RBR TR-1050 Download"
+  data_path_note: |
+    Data path: {raw_data}/{instrument}/{mooring}/
+    Download .hex via Ruskin; convert hex to legacy Matlab before uploading.
+  columns:
+    - sn: {example: "15576"}
+    - visible_defects: {example: "--"}
+    - pc_used
+    - computer_time_at_status
+    - instrument_time_at_status
+    - download_complete
+    - filename_convention: {example: "_recovery.hex"}
+    - convert_hex_matlab
+    - file_size_mb
+    - transfer_to_server
+
+rbr_solot_download_mooring:
+  section_title: "RBR soloT Download"
+  data_path_note: |
+    Data path: {raw_data}/{instrument}/{mooring}/
+    Filename: {download_convention}
+  columns:
+    - sn: {example: "101645"}
+    - visible_defects: {example: "--"}
+    - pc_used
+    - computer_time_at_status
+    - instrument_time_at_status
+    - download_complete
+    - filename_convention: {example: "_recovery.rsk"}
+    - file_size_mb
+    - transfer_to_server
+
+adcp_download_mooring:
+  section_title: "ADCP Download"
+  data_path_note: |
+    Data path: {raw_data}/{instrument}/{mooring}/
+    Download via TRDI software; confirm file size before disconnecting.
+  columns:
+    - sn: {example: "16430"}
+    - download_complete
+    - filename_convention: {header: "Filename", example: "16430_recovery.000"}
+    - file_size_mb: {example: "142"}
+    - pc_used
+    - transfer_to_server
+
+# ===========================================================================
+# DEPLOYMENT SETUP
+# ===========================================================================
+
+microcat_setup_deployment:
+  section_title: "SeaBird SBE37 Deployment Setup"
+  data_path_note: |
+    Capture files: {raw_data}/{instrument}/{mooring}/
+
+  columns_old_seaterm:
+    - sn: {example: "2941"}
+    - pc_used
+    - date_time_ok
+    - interval_10s: {header: "INTERVAL= {sint}", example: "30"}
+    - samplenum_reset_0
+    - storetime_y
+    - navg_1
+    - start_ddmmyyyy: {example: "07102026"}
+    - start_hhmmss: {example: "230000"}
+    - startlater
+    - transfer_to_server
+
+  columns_seaterm_v2:
+    - sn: {example: "7507"}
+    - pc_used
+    - date_time_ok: {width: .5}
+#    - output_settings_v2: {width: 1.2}
+    - sampleinterval_10s: {header: "SAMPLEINTERVAL= {sint}", example: "30"}
+    - txrealtime_N: {example: "N"}
+    - samplenumber_reset_0
+    - startdatetime: {width: 1.8, example: "07102026230000"}
+    - startlater: {width: .7}
+    - transfer_to_server
+
+  columns_seaterm_v2_odo:
+    - sn: {example: "13995"}
+    - pc_used
+    - date_time_ok
+    - sint_s
+    - sampleinterval_10s: {header: "SAMPLEINTERVAL= {sint}", example: "30"}
+    - oxntau_7
+    - oxtau20_55
+    - adaptivepump_Y
+    #- output_settings_v2: {width: 1.2}
+    - txrealtime_N: {example: "N"}
+    - samplenumber_reset_0
+    - startdatetime: {width: 2.5, example: "07102026230000"}
+    - startlater
+    - transfer_to_server
+
+aquadopp_setup_deployment:
+  section_title: "Aquadopp Deployment Setup"
+  data_path_note: |
+    Capture files: {raw_data}/{instrument}/{mooring}/
+  columns:
+    - sn: {example: "10145"}
+    - pc_used
+    - date_time_ok
+    - sampling_interval: {example: "120"}
+    - average_interval: {example: "3"}
+    - blanking_dist: {example: "0.5"}
+    - compass_update: {example: "5s"}
+    - sos_measured_or_fixed: {example: "measured"}
+    - sos_salinity: {example: "35.0"}
+    - coordinate_system: {example: "beam"}
+    - diag_interval: {example: "720"}
+    - diag_samples: {example: "enable"}
+    - start_datetime_aq
+    - capture_file
+    - transfer_to_server
+
+rbr_solot_setup_deployment:
+  section_title: "RBR soloT Deployment Setup"
+  data_path_note: |
+    Capture files: {raw_data}/{instrument}/{mooring}/
+  columns:
+    - sn: {example: "10145"}
+    - pc_used
+    - date_time_ok: {width: 0.7}
+    - sample_interval: {example: "1sec"}
+    - start_datetime
+    - enabled: {example: "\\checkmark"}
+    - screenshot_file: {header: "Screenshot?", width: 0.8, input: tick, example: "\\checkmark"}
+    - transfer_to_server
+
+# ===========================================================================
+# RECOVERY
+# ===========================================================================
+
+recovery:
+  section_title: "Mooring Recovery Log"
+  # Header block fields (not table columns -- rendered as form fields)
+  header_fields:
+  - label: "Mooring"
+    width: 2.5
+  - label: "Cruise"
+    width: 2.5
+  - label: "Date"
+    width: 2.5
+  - label: "Site arrival time"
+    width: 2.5
+  - label: "Time of first ranging"
+    width: 2.5
+
+  # Component table: inline defs (unique to this sheet)
+  columns_component:
+  - header: "ITEM"
+    width: 2.0
+    input: free
+    align: left
+  - header: "SER NO"
+    width: 1.5
+    input: free
+  - header: "COMMENT"
+    width: 5.0
+    input: free
+  - header: "TIME"
+    width: 1.5
+    input: free
+
+  # Ranging table: inline defs
+  columns_ranging:
+  - header: "Time"
+    width: 1.5
+    input: free
+  - header: "Range 1"
+    width: 1
+    input: free
+  - header: "Command / comment"
+    width: 9.0
+    input: free