virtualship.make_realistic package

Conversion functions from zarr instrument results to realistic file formats with data adjusted to be more realistic.

virtualship.make_realistic.adcp_make_realistic(zarr_path, out_dir, prefix)

Take simulated ADCP data, add noise, then save in (an inconvenient educational) CSV format.

Parameters:

• zarr_path (str | Path) – Input simulated data.

• out_dir (str | Path) – Output directory for CSV file.

• prefix (str) – Prefix for CSV file.

Return type:

Path

Returns:

Path to created file.

virtualship.make_realistic.ctd_make_realistic(zarr_path, out_dir, prefix)

Take simulated CTD data, add noise, then save in CNV format (1 file per CTD).

Parameters:

• zarr_path (str | Path) – Input simulated data.

• out_dir (str | Path) – Output directory for CNV file.

• prefix (str) – Prefix for CNV files. Will be postfixed with ‘_{ctd_num}’.

Return type:

list[Path]

Returns:

Paths to created file.

Submodules

virtualship.make_realistic.adcp_make_realistic module

adcp_make_realistic function.

virtualship.make_realistic.adcp_make_realistic.adcp_make_realistic(zarr_path, out_dir, prefix)

Take simulated ADCP data, add noise, then save in (an inconvenient educational) CSV format.

Parameters:

• zarr_path (str | Path) – Input simulated data.

• out_dir (str | Path) – Output directory for CSV file.

• prefix (str) – Prefix for CSV file.

Return type:

Path

Returns:

Path to created file.

virtualship.make_realistic.ctd_make_realistic module

ctd_make_realistic function.

virtualship.make_realistic.ctd_make_realistic.ctd_make_realistic(zarr_path, out_dir, prefix)

Take simulated CTD data, add noise, then save in CNV format (1 file per CTD).

Parameters:

• zarr_path (str | Path) – Input simulated data.

• out_dir (str | Path) – Output directory for CNV file.

• prefix (str) – Prefix for CNV files. Will be postfixed with ‘_{ctd_num}’.

Return type:

list[Path]

Returns:

Paths to created file.