WeatherRoutingTool.ship package

Submodules

WeatherRoutingTool.ship.ship module

class WeatherRoutingTool.ship.ship.Boat(ship_config: ShipConfig)[source]

Bases: object

approx_weather(var, lats, lons, time, height=None, depth=None)[source]
check_data_meaningful()[source]

This is an optional method to check if default boat variables have been changed into meaningful values. It can be implemented in Child classes.

evaluate_weather(ship_params, lats, lons, time)[source]
get_required_water_depth()[source]
get_ship_parameters(courses, lats, lons, time, speed, unique_coords=False)[source]
load_data()[source]
print_init()[source]
weather_path: str
class WeatherRoutingTool.ship.ship.ConstantFuelBoat(ship_config: ShipConfig)[source]

Bases: Boat

fuel_rate: float
get_ship_parameters(courses, lats, lons, time, speed, unique_coords=False)[source]
print_init()[source]

WeatherRoutingTool.ship.ship_factory module

class WeatherRoutingTool.ship.ship_factory.ShipFactory[source]

Bases: object

static get_ship(boat_type: str, ship_config)[source]

WeatherRoutingTool.ship.shipparams module

class WeatherRoutingTool.ship.shipparams.ShipParams(fuel_rate, power, rpm, speed, r_calm, r_wind, r_waves, r_shallow, r_roughness, wave_height, wave_direction, wave_period, u_currents, v_currents, u_wind_speed, v_wind_speed, pressure, air_temperature, salinity, water_temperature, status, message)[source]

Bases: object

air_temperature: Quantity
define_courses(courses_segments)[source]
expand_axis_for_intermediate()[source]
flip()[source]
fuel_rate: Quantity
fuel_type: str
get_air_temperature()[source]
get_element(idx)[source]
get_fuel_rate()[source]
get_fuel_type()[source]
get_message()[source]
get_power()[source]
get_pressure()[source]
get_rcalm()[source]
get_reduced_2D_object(row_start=None, row_end=None, col_start=None, col_end=None, idxs=None)[source]
get_rpm()[source]
get_rroughness()[source]
get_rshallow()[source]
get_rwaves()[source]
get_rwind()[source]
get_salinity()[source]
get_single_object(idx)[source]
get_speed()[source]
get_status()[source]
get_u_currents()[source]
get_u_wind_speed()[source]
get_v_currents()[source]
get_v_wind_speed()[source]
get_water_temperature()[source]
get_wave_direction()[source]
get_wave_height()[source]
get_wave_period()[source]
message: ndarray
power: Quantity
pressure: Quantity
print()[source]
print_shape()[source]
r_calm: Quantity
r_roughness: Quantity
r_shallow: Quantity
r_waves: Quantity
r_wind: Quantity
rpm: Quantity
salinity: Quantity
select(idxs)[source]
set_air_temperature(new_air_temperature)[source]
classmethod set_default_array()[source]
classmethod set_default_array_1D(ncoorinate_points)[source]
set_fuel_rate(new_fuel)[source]
set_message(new_message)[source]
set_power(new_power)[source]
set_pressure(new_pressure)[source]
set_rcalm(new_rcalm)[source]
set_rpm(new_rpm)[source]
set_rroughness(new_rroughnes)[source]
set_rshallow(new_rshallow)[source]
set_rwaves(new_rwaves)[source]
set_rwind(new_rwind)[source]
set_salinity(new_salinity)[source]
set_speed(new_speed)[source]
set_status(new_status)[source]
set_u_currents(new_u_currents)[source]
set_u_wind_speed(new_u_wind_speed)[source]
set_v_currents(new_v_currents)[source]
set_v_wind_speed(new_v_wind_speed)[source]
set_water_temperature(new_water_temperature)[source]
set_wave_direction(new_wave_direction)[source]
set_wave_height(new_wave_height)[source]
set_wave_period(new_wave_period)[source]
speed: Quantity
status: array
u_currents: Quantity
u_wind_speed: Quantity
v_currents: Quantity
v_wind_speed: Quantity
water_temperature: Quantity
wave_direction: Quantity
wave_height: Quantity
wave_period: Quantity

Module contents