Welcome to the documentation of the 52°North Weather Routing Tool (WRT)!

Contents:

• Installation
• Getting started
• Configuration
  • Config file
  • Environment variables
  • Logging and Debugging
  • Input data
  • Output data
• Algorithms
  • Algorithm overview
  • Dijkstra Algorithm
    • General Concept
    • Useful References
  • GCR Slider Algorithm
    • General Concept
  • Genetic Algorithm
    • Different Run Modes
    • General Concept
      • 1. Initial Population Generation
      • 2. Reproduction
      • 3. Post-processing
      • 4. Fitness Evaluation
    • Route Patching
    • Multi-Criteria Decision-Making
    • Useful References
  • Isofuel Algorithm
    • General concept
    • Parameter and variable definitions
    • Pruning methods
    • The Definition of the Symmetry Axis
    • Grouping Route Segments
    • The Optimisation Criterion
• Constraints
  • The constraints module
  • The input parameters
  • Route Postprocessing
  • Useful links:
• Consumption models
  • mariPower
  • Direct Power Method
• Weather data
• Inheritance diagrams
  • Algorithm Classes
  • Ship and Boat Classes
  • Weather Classes
  • Constraint Classes
  • Configuration Classes
• Sequence diagrams
  • Genetic algorithm
  • IsoBased algorithms
• API documentation (still under construction!)
  • WeatherRoutingTool package
    • Subpackages
      • WeatherRoutingTool.algorithms package
        • Submodules
        • WeatherRoutingTool.algorithms.data_utils module
          • GridMixin
          • distance()
          • get_closest()
          • get_speed_from_arrival_time()
          • time_diffs()
        • WeatherRoutingTool.algorithms.genetic module
          • Genetic
        • WeatherRoutingTool.algorithms.genetic.crossover module
          • CrossoverBase
          • CrossoverFactory
          • OffspringRejectionCrossover
          • RandomizedCrossoversOrchestrator
          • SinglePointCrossover
          • SpeedCrossover
          • TwoPointCrossover
        • WeatherRoutingTool.algorithms.genetic.population module
          • FromGeojsonPopulation
          • GcrSliderPopulation
          • GridBasedPopulation
          • IsoFuelPopulation
          • Population
          • PopulationFactory
        • WeatherRoutingTool.algorithms.genetic.mutation module
          • GaussianSpeedMutation
          • MutationBase
          • MutationConstraintRejection
          • MutationFactory
          • NoMutation
          • RandomMutationsOrchestrator
          • RandomPercentageChangeSpeedMutation
          • RandomPlateauMutation
          • RandomWalkMutation
          • RouteBlendMutation
        • WeatherRoutingTool.algorithms.genetic.patcher module
          • GreatCircleRoutePatcher
          • GreatCircleRoutePatcherSingleton
          • IsofuelPatcher
          • IsofuelPatcherSingleton
          • PatchFactory
          • PatcherBase
          • SingletonBase
        • WeatherRoutingTool.algorithms.genetic.repair module
          • ChainedRepairsOrchestrator
          • ConstraintViolationRepair
          • RepairBase
          • RepairFactory
          • WaypointsInfillRepair
        • WeatherRoutingTool.algorithms.genetic.mcdm module
          • MCDM
          • RMethod
        • WeatherRoutingTool.algorithms.genetic.utils module
          • RouteDuplicateElimination
          • gcr_distance()
          • geojson_from_route()
          • get_constraints()
          • get_constraints_array()
          • great_circle_distance()
          • route_from_geojson()
          • route_from_geojson_file()
        • WeatherRoutingTool.algorithms.isobased module
          • IsoBased
          • IsoBasedStatus
          • RoutingStep
        • WeatherRoutingTool.algorithms.isochrone module
          • IsoChrone
        • WeatherRoutingTool.algorithms.isofuel module
          • IsoFuel
        • WeatherRoutingTool.algorithms.routingalg module
          • RoutingAlg
        • WeatherRoutingTool.algorithms.routingalg_factory module
          • RoutingAlgFactory
        • Module contents
      • WeatherRoutingTool.constraints package
        • Submodules
        • WeatherRoutingTool.constraints.constraints module
          • Constraint
          • ConstraintPars
          • ConstraintsList
          • ConstraintsListFactory
          • ContinuousCheck
          • LandCrossing
          • LandPolygonsCrossing
          • NegativeConstraintFromWeather
          • NegativeContraint
          • PositiveConstraint
          • PositiveConstraintPoint
          • RunTestContinuousChecks
          • SeamarkCrossing
          • StatusCodeError
          • StayOnMap
          • WaterDepth
          • WaveHeight
        • WeatherRoutingTool.constraints.route_postprocessing module
          • RoutePostprocessing
        • Module contents
      • WeatherRoutingTool.ship package
        • Submodules
        • WeatherRoutingTool.ship.ship module
          • Boat
          • ConstantFuelBoat
        • WeatherRoutingTool.ship.ship_factory module
          • ShipFactory
        • WeatherRoutingTool.ship.shipparams module
          • ShipParams
        • Module contents
      • WeatherRoutingTool.utils package
        • Submodules
        • WeatherRoutingTool.utils.formatting module
          • NumpyArrayEncoder
          • 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
        • 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
      • Config
        • Config.ALGORITHM_TYPE
        • Config.ARRIVAL_TIME
        • Config.BOAT_SPEED
        • Config.BOAT_SPEED_BOUNDARIES
        • 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.DIJKSTRA_MASK_FILE
        • Config.DIJKSTRA_NOF_NEIGHBORS
        • Config.DIJKSTRA_STEP
        • Config.GCR_SLIDER_ANGLE_STEP
        • Config.GCR_SLIDER_DISTANCE_MOVE
        • Config.GCR_SLIDER_DYNAMIC_PARAMETERS
        • Config.GCR_SLIDER_INTERPOLATE
        • Config.GCR_SLIDER_INTERP_DIST
        • Config.GCR_SLIDER_INTERP_NORMALIZED
        • Config.GCR_SLIDER_LAND_BUFFER
        • Config.GCR_SLIDER_MAX_POINTS
        • Config.GCR_SLIDER_THRESHOLD
        • Config.GENETIC_CROSSOVER_PATCHER
        • Config.GENETIC_CROSSOVER_TYPE
        • Config.GENETIC_FIX_RANDOM_SEED
        • Config.GENETIC_MUTATION_TYPE
        • Config.GENETIC_NUMBER_GENERATIONS
        • Config.GENETIC_NUMBER_OFFSPRINGS
        • Config.GENETIC_OBJECTIVES
        • 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_boat_speed()
        • 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.check_speed_determination()
        • 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.plot_speed_vs_dist()
        • RouteParams.print_route()
        • RouteParams.route_type
        • RouteParams.set_ship_params()
        • RouteParams.ship_params_per_step
        • RouteParams.start
        • RouteParams.starttime_per_step
        • RouteParams.time
        • RouteParams.write_to_file()
        • RouteParams.write_to_geojson()
    • 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
• Conventions
  • Coordinates
  • Units
  • Logging
• Guidelines
  • Contribution Guidelines
    • General remarks
  • Coding Guidelines
    • Style guide
    • Docstring
    • Important notes
  • Software profiling
    • Runtime monitoring
    • Memory monitoring
  • Tests
• References

Indices and tables

• Index

• Module Index

• Search Page