API documentation (still under construction!)

Contents:

• WeatherRoutingTool package
  • Subpackages
    • WeatherRoutingTool.algorithms package
      • Submodules
      • WeatherRoutingTool.algorithms.data_utils module
      • 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.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
      • Module contents
    • WeatherRoutingTool.utils package
      • Submodules
      • WeatherRoutingTool.utils.formatting module
      • WeatherRoutingTool.utils.graphics module
      • WeatherRoutingTool.utils.maps module
      • WeatherRoutingTool.utils.unit_conversion module
      • Module contents
  • Submodules
  • WeatherRoutingTool.config module
    • Config
      • Config.ALGORITHM_TYPE
      • Config.BOAT_TYPE
      • Config.CONFIG_PATH
      • Config.CONSTRAINTS_LIST
      • Config.COURSES_FILE
      • Config.DEFAULT_MAP
      • Config.DEFAULT_ROUTE
      • Config.DELTA_FUEL
      • Config.DELTA_TIME_FORECAST
      • Config.DEPARTURE_TIME
      • Config.DEPTH_DATA
      • Config.GENETIC_CROSSOVER_PATCHER
      • Config.GENETIC_FIX_RANDOM_SEED
      • Config.GENETIC_MUTATION_TYPE
      • Config.GENETIC_NUMBER_GENERATIONS
      • Config.GENETIC_NUMBER_OFFSPRINGS
      • Config.GENETIC_POPULATION_PATH
      • Config.GENETIC_POPULATION_SIZE
      • Config.GENETIC_POPULATION_TYPE
      • Config.GENETIC_REPAIR_TYPE
      • Config.INTERMEDIATE_WAYPOINTS
      • Config.ISOCHRONE_MAX_ROUTING_STEPS
      • Config.ISOCHRONE_MINIMISATION_CRITERION
      • Config.ISOCHRONE_NUMBER_OF_ROUTES
      • Config.ISOCHRONE_PRUNE_GROUPS
      • Config.ISOCHRONE_PRUNE_SECTOR_DEG_HALF
      • Config.ISOCHRONE_PRUNE_SEGMENTS
      • Config.ISOCHRONE_PRUNE_SYMMETRY_AXIS
      • Config.ROUTER_HDGS_INCREMENTS_DEG
      • Config.ROUTER_HDGS_SEGMENTS
      • Config.ROUTE_PATH
      • Config.ROUTE_POSTPROCESSING
      • Config.ROUTING_STEPS
      • Config.TIME_FORECAST
      • Config.WEATHER_DATA
      • Config.assign_config()
      • Config.check_boat_algorithm_compatibility()
      • Config.check_constraint_list()
      • Config.check_genetic_repair_type()
      • Config.check_numeric_values_positivity()
      • Config.check_route_depth_data_compatibility()
      • Config.check_route_on_map()
      • Config.check_route_weather_data_compatibility()
      • Config.check_router_hdgs_segments_positive_and_even()
      • Config.model_config
      • Config.model_post_init()
      • Config.parse_and_validate_datetime()
      • Config.validate_config()
      • Config.validate_map_coordinates()
      • Config.validate_path_exists()
      • Config.validate_route_coordinates()
    • set_up_logging()
  • WeatherRoutingTool.execute_routing module
    • execute_routing()
    • merge_figures_to_gif()
  • WeatherRoutingTool.routeparams module
    • RouteParams
      • RouteParams.convert_to_dict()
      • RouteParams.count
      • RouteParams.course_per_step
      • RouteParams.dists_per_step
      • RouteParams.finish
      • RouteParams.from_file()
      • RouteParams.from_gzip_file()
      • RouteParams.gcr
      • RouteParams.get_dist_from_coords()
      • RouteParams.get_fuel_per_dist()
      • RouteParams.get_full_dist()
      • RouteParams.get_full_fuel()
      • RouteParams.get_full_travel_time()
      • RouteParams.get_mean_power()
      • RouteParams.get_per_waypoint_coords()
      • RouteParams.get_power_type()
      • RouteParams.lats_per_step
      • RouteParams.lons_per_step
      • RouteParams.plot_acc_power_vs_dist()
      • RouteParams.plot_power_vs_coord()
      • RouteParams.plot_power_vs_dist()
      • RouteParams.plot_power_vs_dist_ratios()
      • RouteParams.plot_power_vs_dist_with_weather()
      • RouteParams.plot_route()
      • RouteParams.print_route()
      • RouteParams.return_route_to_API()
      • RouteParams.route_type
      • RouteParams.set_ship_params()
      • RouteParams.ship_params_per_step
      • RouteParams.start
      • RouteParams.starttime_per_step
      • RouteParams.time
      • RouteParams.write_to_file()
  • WeatherRoutingTool.test_maripower_settings_for_different_courses module
  • WeatherRoutingTool.test_maripower_settings_for_specific_route module
  • WeatherRoutingTool.weather module
    • FakeWeather
      • FakeWeather.add_gauß_to_wind()
      • FakeWeather.combine_var_dicts()
      • FakeWeather.get_index()
      • FakeWeather.read_dataset()
      • FakeWeather.write_data()
    • WeatherCond
      • WeatherCond.check_units()
      • WeatherCond.ds
      • WeatherCond.get_map_size()
      • WeatherCond.get_theta_from_uv()
      • WeatherCond.get_u()
      • WeatherCond.get_v()
      • WeatherCond.map_size
      • WeatherCond.plot_wind_weather()
      • WeatherCond.print_init()
      • WeatherCond.read_dataset()
      • WeatherCond.set_map_size()
      • WeatherCond.time_end
      • WeatherCond.time_res
      • WeatherCond.time_start
      • WeatherCond.time_steps
    • WeatherCondEnvAutomatic
      • WeatherCondEnvAutomatic.check_data_consistency()
      • WeatherCondEnvAutomatic.read_dataset()
      • WeatherCondEnvAutomatic.write_data()
    • WeatherCondFromFile
      • WeatherCondFromFile.add_depth_to_EnvData()
      • WeatherCondFromFile.adjust_depth_format()
      • WeatherCondFromFile.calculate_wind_function()
      • WeatherCondFromFile.close_env_file()
      • WeatherCondFromFile.get_time_step_index()
      • WeatherCondFromFile.get_twatws_from_uv()
      • WeatherCondFromFile.get_wind_vector()
      • WeatherCondFromFile.init_wind_vectors()
      • WeatherCondFromFile.manipulate_dataset()
      • WeatherCondFromFile.plot_weather_map()
      • WeatherCondFromFile.read_dataset()
      • WeatherCondFromFile.read_wind_functions()
      • WeatherCondFromFile.read_wind_vectors()
      • WeatherCondFromFile.wind_functions
      • WeatherCondFromFile.wind_vectors
    • WeatherCondODC
      • WeatherCondODC.load_odc_product()
      • WeatherCondODC.read_dataset()
      • WeatherCondODC.write_data()
  • WeatherRoutingTool.weather_factory module
    • WeatherFactory
      • WeatherFactory.get_weather()
  • Module contents