Pen Bay Marine Data documentation¶

Add your content using reStructuredText syntax. See the reStructuredText documentation for details.

penbay¶

Command Line Interface for weather and buoy data.

penbay [OPTIONS] COMMAND [ARGS]...

buoys¶

Command line interface for working with buoy data and firmware.

penbay buoys [OPTIONS] COMMAND [ARGS]...

db¶

Commands that interact with the buoy database.

penbay buoys db [OPTIONS] COMMAND [ARGS]...

describe¶

penbay buoys db describe [OPTIONS] {wynken|blynken} {diagnostic|sonde}

Options

--host <host>¶: The InfluxDB server URL. Defaults to environment variable INFLUX_SERVER_URL

--measurement <measurement>¶: The InfluxDB measurement (table) name.

--token <token>¶: The InfluxDB API token. Defaults to environment variable INFLUX_API_TOKEN

Arguments

NAME¶: Required argument

TABLE¶: Required argument

Environment variables

INFLUX_SERVER_URL: Provide a default for --host

INFLUXDB_MEASUREMENT: Provide a default for --measurement

INFLUX_API_TOKEN: Provide a default for --token

upload¶

Upload buoy data to the database.

penbay buoys db upload [OPTIONS] {wynken|blynken} {diagnostic|sonde}

Options

--host <host>¶: The InfluxDB server URL. Defaults to environment variable INFLUX_SERVER_URL

--token <token>¶: The InfluxDB API token. Defaults to environment variable INFLUX_API_TOKEN

Arguments

NAME¶: Required argument

TABLE¶: Required argument

Environment variables

INFLUX_SERVER_URL: Provide a default for --host

INFLUX_API_TOKEN: Provide a default for --token

file¶

Commands that interact with the buoy data file system.

penbay buoys file [OPTIONS] COMMAND [ARGS]...

describe¶

Summarize available data for a station.

penbay buoys file describe [OPTIONS] {wynken|blynken} {diagnostic|sonde}

Arguments

NAME¶: Required argument

TABLE¶: Required argument

export¶

Export buoy data to a different format.

penbay buoys file export [OPTIONS] {wynken|blynken} {diagnostic|sonde}

Arguments

NAME¶: Required argument

TABLE¶: Required argument

gpx¶

Export buoy data to a different format.

penbay buoys file gpx [OPTIONS] {wynken|blynken}

Arguments

NAME¶: Required argument

list¶

List available stations from static data.

penbay buoys file list [OPTIONS]

firmware¶

Command line interface for working with buoy data and firmware.

penbay buoys firmware [OPTIONS] COMMAND [ARGS]...

lib¶

Fill in firmware template with options passed on the command line.

penbay buoys firmware lib [OPTIONS]

Options

--file <file>¶: Template file

template¶

Fill in firmware template with options passed on the command line.

penbay buoys firmware template [OPTIONS] {wynken|blynken}

Options

--address <address>¶: Required Pakbus address

--client <client>¶: Required Client ID

--file <file>¶: Template file

--latitude <latitude>¶: Required Latitude

--longitude <longitude>¶: Required Longitude

Arguments

NAME¶: Required argument

plot¶

Commands that generate plots using buoy data.

penbay buoys plot [OPTIONS] COMMAND [ARGS]...

daily¶

Plot a single DataStream aggregated by day.

penbay buoys plot daily [OPTIONS] {wynken|blynken} {diagnostic|sonde} {sea_wat
                        er_temperature|mass_concentration_of_oxygen_in_sea_wat
                        er|sea_water_salinity}

Options

--image-format <image_format>¶

The output format.

Options:: ImageFormat.PNG

Arguments

NAME¶: Required argument

TABLE¶: Required argument

SERIES¶: Required argument

tail¶

Plot the most recent data from a buoy for a single data stream.

penbay buoys plot tail [OPTIONS] {wynken|blynken} {diagnostic|sonde} {sea_wate
                       r_temperature|mass_concentration_of_oxygen_in_sea_water
                       |sea_water_salinity}

Options

--image-format <image_format>¶

The output format.

Options:: ImageFormat.PNG

Arguments

NAME¶: Required argument

TABLE¶: Required argument

SERIES¶: Required argument

weather¶

Weather station commands.

penbay weather [OPTIONS] COMMAND [ARGS]...

db¶

Commands that interact with the weather database.

penbay weather db [OPTIONS] COMMAND [ARGS]...

backfill¶

Backfill missing data from local to database.

penbay weather db backfill [OPTIONS] {apprenticeshop|dev}

Options

--host <host>¶: The InfluxDB server URL. Defaults to environment variable INFLUX_SERVER_URL

--measurement <measurement>¶: The InfluxDB measurement (table) name.

--token <token>¶: The InfluxDB API token. Defaults to environment variable INFLUX_API_TOKEN

Arguments

STATION¶: Required argument

Environment variables

INFLUX_SERVER_URL: Provide a default for --host

INFLUXDB_MEASUREMENT: Provide a default for --measurement

INFLUX_API_TOKEN: Provide a default for --token

describe¶

Show information about the data already stored in Influx database.

penbay weather db describe [OPTIONS]

Options

--host <host>¶: The InfluxDB server URL. Defaults to environment variable INFLUX_SERVER_URL

--measurement <measurement>¶: The InfluxDB measurement (table) name.

--token <token>¶: The InfluxDB API token. Defaults to environment variable INFLUX_API_TOKEN

Environment variables

INFLUX_SERVER_URL: Provide a default for --host

INFLUXDB_MEASUREMENT: Provide a default for --measurement

INFLUX_API_TOKEN: Provide a default for --token

describe¶

Compare local and database data before merging or backfilling.

penbay weather describe [OPTIONS] {apprenticeshop|dev} {air_temperature|relati
                        ve_humidity|wind_speed|wind_from_direction|air_pressur
                        e|wind_speed_of_gust|wind_gust_from_direction|wind_chi
                        ll_of_air_temperature|solar_irradiance|ultraviolet_ind
                        ex|rainfall_amount|rainfall_rate|heat_index_of_air_tem
                        perature|dew_point_temperature|water_evapotranspiratio
                        n_flux}

Options

--host <host>¶: The InfluxDB server URL. Defaults to environment variable INFLUX_SERVER_URL

--measurement <measurement>¶: The InfluxDB measurement (table) name.

--token <token>¶: The InfluxDB API token. Defaults to environment variable INFLUX_API_TOKEN

Arguments

STATION¶: Required argument

SERIES¶: Required argument

Environment variables

INFLUX_SERVER_URL: Provide a default for --host

INFLUXDB_MEASUREMENT: Provide a default for --measurement

INFLUX_API_TOKEN: Provide a default for --token

file¶

Commands that interact with the weather file system.

penbay weather file [OPTIONS] COMMAND [ARGS]...

describe¶

Parse and normalize weather station data for display

penbay weather file describe [OPTIONS] {apprenticeshop|dev}

Arguments

STATION¶: Required argument

export¶

Export normalized weather station data to CSV.

penbay weather file export [OPTIONS] {apprenticeshop|dev}

Arguments

STATION¶: Required argument

plot¶

Commands that generate plots using weather data.

penbay weather plot [OPTIONS] COMMAND [ARGS]...

daily¶

Display a single DataStream aggregated by day.

penbay weather plot daily [OPTIONS] {apprenticeshop|dev} {air_temperature|rela
                          tive_humidity|wind_speed|wind_from_direction|air_pre
                          ssure|wind_speed_of_gust|wind_gust_from_direction|wi
                          nd_chill_of_air_temperature|solar_irradiance|ultravi
                          olet_index|rainfall_amount|rainfall_rate|heat_index_
                          of_air_temperature|dew_point_temperature|water_evapo
                          transpiration_flux}

Options

--host <host>¶: The InfluxDB server URL. Defaults to environment variable INFLUX_SERVER_URL

--measurement <measurement>¶: The InfluxDB measurement (table) name.

--token <token>¶: The InfluxDB API token. Defaults to environment variable INFLUX_API_TOKEN

--image-format <image_format>¶

The output format.

Options:: ImageFormat.PNG

Arguments

STATION¶: Required argument

SERIES¶: Required argument

Environment variables

INFLUX_SERVER_URL: Provide a default for --host

INFLUXDB_MEASUREMENT: Provide a default for --measurement

INFLUX_API_TOKEN: Provide a default for --token

tail¶

Plot a comparison of local and InfluxDB data for a specific series.

Keyword arguments are passed through to the rendering function

penbay weather plot tail [OPTIONS] {apprenticeshop|dev} {air_temperature|relat
                         ive_humidity|wind_speed|wind_from_direction|air_press
                         ure|wind_speed_of_gust|wind_gust_from_direction|wind_
                         chill_of_air_temperature|solar_irradiance|ultraviolet
                         _index|rainfall_amount|rainfall_rate|heat_index_of_ai
                         r_temperature|dew_point_temperature|water_evapotransp
                         iration_flux}

Options

--host <host>¶: The InfluxDB server URL. Defaults to environment variable INFLUX_SERVER_URL

--measurement <measurement>¶: The InfluxDB measurement (table) name.

--token <token>¶: The InfluxDB API token. Defaults to environment variable INFLUX_API_TOKEN

--image-format <image_format>¶

The output format.

Options:: ImageFormat.PNG

--days <days>¶: The time range to include in the plot (e.g., 7, 14).

--resample <resample>¶: How to resample the data (e.g., 1d, 1h).

--qartod <qartod>¶: Path to the QARTOD configuration file.

Arguments

STATION¶: Required argument

SERIES¶: Required argument

Environment variables

INFLUX_SERVER_URL: Provide a default for --host

INFLUXDB_MEASUREMENT: Provide a default for --measurement

INFLUX_API_TOKEN: Provide a default for --token

Pen Bay Marine Data documentation¶

penbay¶

buoys¶

db¶

describe¶

upload¶

file¶

describe¶

export¶

gpx¶

list¶

firmware¶

lib¶

template¶

plot¶

daily¶

tail¶

weather¶

db¶

backfill¶

describe¶

describe¶

file¶

describe¶

export¶

plot¶

daily¶

tail¶

Pen Bay Marine Data

Navigation

Related Topics