seaplan 0.4.4

Overview

Reads in a parameter file (YAML format) containing variables and a list of actions to perform.

The parameter file can also specify a “station file” containing the names, latitudes and longitudes of the stations. All of these stations will be plotted on the map and if an action has the same name and no specified latitude and longitude, this station’s position will be used.

Outputs a table of actions with predicted (or specified) times. The table is in MultiMarkdown format, it can be printed as is or converted to HTML, LaTeX etc for pretty printing.

Parameter file

Variables that can be provided in the parameter files are (default in [braces]):

• station_file: A CSV file containing station information. Its first line is a header that specifies the field order using the names "Name", "Lat", "Lon", "Type" and "Comment"

  • name: Name of CSV file

  • field_separator: [';']

• printout:

  • show_comments : Show comments in output [False]

  • print_past : Print out past events [False]

• timing:

  • ignore_depart_arrive_times: Ignore 'arrive_time' and 'depart_time' in events (allows you to test time predictions) [False]

  • ship_speed.kn_i: Cruising speed of the ship in knots [10.]

  • ship_latency.h: Hours lost getting to speed from stopped [0.5]

  • action_times.h: Default hours for each action/station type:

    action_times.h:
        "{action_type1}":
            "{station_type1}": *float*
            "{station_type2}": *float*
            default: *float*
        "{action_type2}":
            default: *float*

• map:

  • grid: grid spacing in decimal degrees [x:1; y:1]

  • bounds: plot bounds in Decimal degrees (MANDATORY if plot_map==True)

  • bathy_map: Map background image [False]. Three possibilities:

    • {string}: Name of a netCDF file to plot as background image on the map

    • True: Plot an etopo image as background

    • False: No background map

  • plot_past_tracks: Plot past ship tracks [True]

  • show_plot: Plot the the screen as well as a file [False]

• events: Sequential list of “events” [MANDATORY].

  If the “station” key corresponds to a “Name” in the station file, then the station position, type and comments are taken from that file. If not, you must specify at least the lat and lon the first time you name the station. The keys are:

  • station (str): station name [MANDATORY]

  • lat (float): station latitude [station.lat or 0.]

  • lon (float): station longitude [station.lat or 0.]

  • arrive_time (ISO): [previous depart_time+transit+latency]

  • depart_time (ISO): [arrive_time + hours]

  • hours (float): hours expected for operation [action_time.h['{action_type}']['{station_type}'], action_time.h['{action_type}']['default'], or 0.]

  • comment (str): comments

  • speed (float): speed between previous and given site [ship_speed_knots]

Other subdirectories

seaplan/_examples/

Example files and scripts:

Use reStructuredText to modify this file.