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
          • 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
        • 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
    • WeatherRoutingTool.execute_routing module
    • WeatherRoutingTool.routeparams module
      • RouteParams
        • RouteParams.convert_to_dict()
        • RouteParams.count
        • RouteParams.course_per_step
        • RouteParams.dists_per_step
        • RouteParams.finish
        • RouteParams.from_csv_file()
        • 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_resistances()
        • 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
    • WeatherRoutingTool.weather_factory module
    • 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