WeatherRoutingTool package

Subpackages

• WeatherRoutingTool.algorithms package
  • Submodules
  • WeatherRoutingTool.algorithms.data_utils module
    • distance()
    • get_closest()
    • get_speed_from_arrival_time()
    • time_diffs()
  • WeatherRoutingTool.algorithms.genetic module
  • WeatherRoutingTool.algorithms.genetic.crossover module
  • WeatherRoutingTool.algorithms.genetic.population module
  • WeatherRoutingTool.algorithms.genetic.mutation module
  • WeatherRoutingTool.algorithms.genetic.patcher module
  • WeatherRoutingTool.algorithms.genetic.repair module
  • WeatherRoutingTool.algorithms.genetic.mcdm module
  • WeatherRoutingTool.algorithms.genetic.utils module
  • WeatherRoutingTool.algorithms.isobased module
  • WeatherRoutingTool.algorithms.isochrone module
  • WeatherRoutingTool.algorithms.isofuel module
  • WeatherRoutingTool.algorithms.routingalg module
  • WeatherRoutingTool.algorithms.routingalg_factory module
  • Module contents
• WeatherRoutingTool.constraints package
  • Submodules
  • WeatherRoutingTool.constraints.constraints module
  • WeatherRoutingTool.constraints.route_postprocessing module
  • Module contents
• WeatherRoutingTool.ship package
  • Submodules
  • WeatherRoutingTool.ship.ship module
  • WeatherRoutingTool.ship.ship_factory module
  • WeatherRoutingTool.ship.shipparams module
    • ShipParams
      • ShipParams.air_temperature
      • ShipParams.define_courses()
      • ShipParams.expand_axis_for_intermediate()
      • ShipParams.flip()
      • ShipParams.fuel_rate
      • ShipParams.fuel_type
      • ShipParams.get_air_temperature()
      • ShipParams.get_element()
      • ShipParams.get_fuel_rate()
      • ShipParams.get_fuel_type()
      • ShipParams.get_message()
      • ShipParams.get_power()
      • ShipParams.get_pressure()
      • ShipParams.get_rcalm()
      • ShipParams.get_reduced_2D_object()
      • ShipParams.get_rpm()
      • ShipParams.get_rroughness()
      • ShipParams.get_rshallow()
      • ShipParams.get_rwaves()
      • ShipParams.get_rwind()
      • ShipParams.get_salinity()
      • ShipParams.get_single_object()
      • ShipParams.get_speed()
      • ShipParams.get_status()
      • ShipParams.get_u_currents()
      • ShipParams.get_u_wind_speed()
      • ShipParams.get_v_currents()
      • ShipParams.get_v_wind_speed()
      • ShipParams.get_water_temperature()
      • ShipParams.get_wave_direction()
      • ShipParams.get_wave_height()
      • ShipParams.get_wave_period()
      • ShipParams.message
      • ShipParams.power
      • ShipParams.pressure
      • ShipParams.print()
      • ShipParams.print_shape()
      • ShipParams.r_calm
      • ShipParams.r_roughness
      • ShipParams.r_shallow
      • ShipParams.r_waves
      • ShipParams.r_wind
      • ShipParams.rpm
      • ShipParams.salinity
      • ShipParams.select()
      • ShipParams.set_air_temperature()
      • ShipParams.set_default_array()
      • ShipParams.set_default_array_1D()
      • ShipParams.set_fuel_rate()
      • ShipParams.set_message()
      • ShipParams.set_power()
      • ShipParams.set_pressure()
      • ShipParams.set_rcalm()
      • ShipParams.set_rpm()
      • ShipParams.set_rroughness()
      • ShipParams.set_rshallow()
      • ShipParams.set_rwaves()
      • ShipParams.set_rwind()
      • ShipParams.set_salinity()
      • ShipParams.set_speed()
      • ShipParams.set_status()
      • ShipParams.set_u_currents()
      • ShipParams.set_u_wind_speed()
      • ShipParams.set_v_currents()
      • ShipParams.set_v_wind_speed()
      • ShipParams.set_water_temperature()
      • ShipParams.set_wave_direction()
      • ShipParams.set_wave_height()
      • ShipParams.set_wave_period()
      • ShipParams.speed
      • ShipParams.status
      • ShipParams.u_currents
      • ShipParams.u_wind_speed
      • ShipParams.v_currents
      • ShipParams.v_wind_speed
      • ShipParams.water_temperature
      • ShipParams.wave_direction
      • ShipParams.wave_height
      • ShipParams.wave_period
  • Module contents
• WeatherRoutingTool.utils package
  • Submodules
  • WeatherRoutingTool.utils.formatting module
    • NumpyArrayEncoder
      • NumpyArrayEncoder.default()
    • get_bbox_from_string()
    • get_current_time()
    • get_line_string()
    • get_log_step()
    • get_point_from_string()
    • print_current_time()
    • print_line()
    • print_step()
  • WeatherRoutingTool.utils.graphics module
    • create_map()
    • create_maps()
    • generate_basemap()
    • get_accumulated_dist()
    • get_colour()
    • get_figure_path()
    • get_gcr_points()
    • get_hist_values_from_boundaries()
    • get_hist_values_from_widths()
    • get_linestyle()
    • get_marker()
    • get_route_lc()
    • get_standard()
    • get_standard_fig()
    • merge_figs()
    • plot_barbs()
    • plot_gcr()
    • plot_genetic_algorithm_initial_population()
    • plot_legend()
    • rebin()
    • set_graphics_standards()
    • write_graph_to_csv()
  • WeatherRoutingTool.utils.maps module
    • Map
      • Map.extend_variable()
      • Map.get_var_tuple()
      • Map.get_widened_map()
      • Map.lat1
      • Map.lat2
      • Map.lon1
      • Map.lon2
  • WeatherRoutingTool.utils.unit_conversion module
    • check_dataset_spacetime_consistency()
    • compare_times()
    • convert_npdt64_to_datetime()
    • convert_nptd64_to_h()
    • convert_nptd64_to_ints()
    • convert_pandatime_to_datetime()
    • cut_angles()
    • degree_to_pmpi()
    • downsample_dataframe()
    • get_angle_bins()
    • get_coord_index()
    • knots_to_mps()
    • mps_to_knots()
    • round_time()
  • Module contents

Submodules

WeatherRoutingTool.config module

WeatherRoutingTool.execute_routing module

WeatherRoutingTool.routeparams module

class WeatherRoutingTool.routeparams.RouteParams(count, start, finish, gcr, route_type, time, lats_per_step, lons_per_step, course_per_step, dists_per_step, starttime_per_step, ship_params_per_step)

Bases: object

This is a Container class for route parameters. Parameters are assumed to be constant for every route segment (= distance from one coordinate pair to the following). The parameters for each routing step are tied to the start point of each route segment. Since the number of routing steps is by one smaller than the number of coordinate pairs, the arrays of this container class exhibit different lengths:

• Type 1: count + 1: dists_per_step, ship_params_per_step, courses_per_step

• Type 2: count + 2: lats_per_step, lons_per_step, starttime_per_step

When the RouteParams object is written to json file, the full arrays of type 2 are written. The corresponding values from the arrays of type 1 are set to -99 for the last coordinate pair.

convert_to_dict()

count: int

course_per_step: tuple

dists_per_step: tuple

finish: tuple

static from_csv_file(filename)

classmethod from_file(filename)

static from_gzip_file(filename)

gcr: tuple

get_dist_from_coords(lats, lons)

get_fuel_per_dist()

get_full_dist()

get_full_fuel()

get_full_travel_time()

get_mean_power()

static get_per_waypoint_coords(route_lons: ndarray, route_lats: ndarray, start_time: datetime, bs: Quantity)

get_power_type(power_type, norm=1.0)

lats_per_step: tuple

lons_per_step: tuple

plot_acc_power_vs_dist(color, label, power_type)

plot_power_vs_coord(ax, color, label, coordstring, power_type)

plot_power_vs_dist(color, label, power_type, ax, norm=1.0)

plot_power_vs_dist_ratios(denominator, color, label, power_type)

plot_power_vs_dist_resistances(color, label, power_type, ax1, ax2, ax3, ax4)

plot_power_vs_dist_with_weather(data_array, label_array, n_datasets)

plot_route(ax, colour, label, linestyle=False)

plot_speed_vs_dist(color, label, ax)

print_route()

route_type: str

set_ship_params(ship_params)

ship_params_per_step: ShipParams

start: tuple

starttime_per_step: tuple

time: timedelta

write_to_file(filename)

write_to_geojson(filename)

WeatherRoutingTool.test_maripower_settings_for_different_courses module

WeatherRoutingTool.test_maripower_settings_for_specific_route module

WeatherRoutingTool.weather module

WeatherRoutingTool.weather_factory module

Module contents