extract-vprofile v3.2.3

Mercurial revision 5770:c90c3015e72d | 2026-05-22

Description

extract-vprofile is a tool designed to extract a vertical profile from an unstructured model grid in NetCDF format. It specifically targets the following variables:

  • a_u3D

  • G_u3D

  • a_v3D

  • G_v3D

  • Kv3D

Note: If you need support for additional variables or implementations, please contact the developers.

Usage

extract-vprofile -f FILE -p "lon lat" [-o OUTPUT_FILE] [-m MOORING_NAME]

Options

Option

Description

-h, --help

Print this help message and exit.

-f <file>

Required. Input file in NetCDF format.

-p <lon> <lat>

Required. Longitude and latitude of the profile location for extraction.

-o <file>

Output file name. If not specified, the output will be written to a default file.

-m <name>

Mooring name (optional metadata for the output file).

Examples

Basic Extraction

Extract a vertical profile at longitude 2.3522 and latitude 48.8566 from a NetCDF file:

extract-vprofile -f input.nc -p 2.3522 48.8566

Extract and Save to a Custom Output File

Extract a vertical profile and save it to profile_output.txt:

extract-vprofile -f input.nc -p 2.3522 48.8566 -o profile_output.txt

Extract with Mooring Name

Extract a vertical profile and include a mooring name in the output:

extract-vprofile -f input.nc -p 2.3522 48.8566 -o profile_output.txt -m "Mooring_01"

Environment Variables

This tool does not use any specific environment variables.

Notes

  1. Input File Requirements:

  • The input file must be in NetCDF format.

  • The tool only processes the variables a_u3D, G_u3D, a_v3D, G_v3D, and Kv3D.

  1. Output Format:

  • The output file contains the vertical profile data for the specified location.

  • The first line includes the mooring name (if provided), longitude, and latitude.

  • Subsequent lines contain the depth levels and corresponding values for each variable.

  1. Coordinate System:

  • Longitude (lon) and latitude (lat) must be provided in decimal degrees.

  1. Deprecated Options:

  • The -v option (previously used to list variables to extract) is no longer supported.

See Also