% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ingest_sensors.R
\name{read_nortek_aquadopp}
\alias{read_nortek_aquadopp}
\title{Read a Nortek Aquadopp Profiler ASCII export}
\usage{
read_nortek_aquadopp(
  file,
  beam_files = NULL,
  lat = NULL,
  lon = NULL,
  spatial_res = 4L,
  min_obs = 5L,
  max_plausible_speed = 2.5,
  rho = 1025,
  Cd = 0.002,
  verbose = TRUE
)
}
\arguments{
\item{file}{Character. Path to the AquaPro ENU CSV export, or path to the
\code{.sen} file when using separate beam files.}

\item{beam_files}{Character vector. Paths to \code{.v1}, \code{.v2}, \code{.v3} beam
velocity files (optional). If \code{NULL} (default) the function reads velocity
from named columns in \code{file}.}

\item{lat}{Numeric. Fixed latitude for moored deployments (decimal degrees).
Required when GPS columns are absent from the export.}

\item{lon}{Numeric. Fixed longitude for moored deployments (decimal degrees).
Required when GPS columns are absent from the export.}

\item{spatial_res}{Integer. Decimal places for lat/lon binning (default \code{4}).
For moored deployments all ensembles share one position and this parameter
has no practical effect.}

\item{min_obs}{Integer. Minimum ensembles per grid cell (default \code{5}).}

\item{max_plausible_speed}{Numeric. Upper speed threshold for outlier
removal in m/s (default \code{2.5}; Aquadopp profilers can measure stronger
tidal flows than vessel-mounted ADCPs).}

\item{rho}{Numeric. Water density in kg/m^3 (default \code{1025}).}

\item{Cd}{Numeric. Drag coefficient for bed shear stress (default \code{0.002}).}

\item{verbose}{Logical. Print progress messages (default \code{TRUE}).}
}
\value{
A dataframe with columns \code{lat}, \code{lon}, \code{current_speed},
\code{bed_shear_stress}, \code{shear_stress_quality}, and optionally \code{temperature},
\code{pressure_dbar}, and \code{date} -- ready for \code{\link[=merge_sensor_data]{merge_sensor_data()}}.
}
\description{
Reads the ASCII velocity export produced by Nortek's \strong{AquaPro} software
from an Aquadopp Profiler deployment. The function accepts two common export
layouts:
\itemize{
\item \strong{ENU CSV} -- a single file with named columns for east, north, and up
velocity per depth bin (e.g. \code{East_1}, \code{North_1}, \code{East_2}, ...) plus
optional time, temperature, and pressure columns.
\item \strong{Separate beam files} -- the companion \code{.sen} (sensor) file providing
time, temperature, and pressure, and the \code{.v1}/\code{.v2} files providing
beam velocities. Supply the \code{.sen} path to \code{file} and set
\code{beam_files = c("survey.v1", "survey.v2", "survey.v3")}.
}

Because Aquadopp instruments are often moored at a single location rather
than vessel-mounted, GPS coordinates may not be embedded in the export. In
that case supply \code{lat} and \code{lon} directly; all output rows receive that
fixed position.
}
\examples{
\donttest{
# Moored deployment (fixed position)
adcp <- read_nortek_aquadopp(
  "harbour_mouth_aqd.csv",
  lat = 56.512, lon = -5.403
)

# Vessel-mounted with GPS columns in the file
adcp <- read_nortek_aquadopp("transect_enu.csv")

survey <- merge_sensor_data(adcp = adcp, bathy = bathy)
}
}
