diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/.buildinfo b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/.buildinfo new file mode 100644 index 0000000..aefb607 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: fe6e78131ef79695ff429e53298be037 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_downloads/3f0d4d1fea704d8ffdd7fa89c1edb3ed/ICMASS23_verfying_caga_systems.pdf b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_downloads/3f0d4d1fea704d8ffdd7fa89c1edb3ed/ICMASS23_verfying_caga_systems.pdf new file mode 100644 index 0000000..547c468 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_downloads/3f0d4d1fea704d8ffdd7fa89c1edb3ed/ICMASS23_verfying_caga_systems.pdf differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/index.rst.txt new file mode 100644 index 0000000..390cba7 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/index.rst.txt @@ -0,0 +1,11 @@ +API Reference +============= + +This page contains auto-generated API reference documentation [#f1]_. + +.. toctree:: + :titlesonly: + + /api/trafficgen/index + +.. [#f1] Created with `sphinx-autoapi `_ \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/check_land_crossing/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/check_land_crossing/index.rst.txt new file mode 100644 index 0000000..6c97771 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/check_land_crossing/index.rst.txt @@ -0,0 +1,39 @@ +:py:mod:`trafficgen.check_land_crossing` +======================================== + +.. py:module:: trafficgen.check_land_crossing + +.. autoapi-nested-parse:: + + This module finds if the generated path is crossing land. + + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.check_land_crossing.path_crosses_land + + + +.. py:function:: path_crosses_land(position_1, speed, course, lat_lon_0, time_interval=50) + + Find if path is crossing land. + + Params: + position_1: Ship position in (north, east) [m]. + speed: Ship speed [knots]. + course: Ship course [degree]. + lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree]. + time_interval: The time interval the vessel should travel without crossing land [minutes] + + :returns: True if parts of the path crosses land. + :rtype: is_on_land + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/cli/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/cli/index.rst.txt new file mode 100644 index 0000000..42cdf6e --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/cli/index.rst.txt @@ -0,0 +1,78 @@ +:py:mod:`trafficgen.cli` +======================== + +.. py:module:: trafficgen.cli + +.. autoapi-nested-parse:: + + CLI for trafficgen package. + + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.cli.main + trafficgen.cli.gen_situation + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.cli.logger + trafficgen.cli.default_data_path + trafficgen.cli.sit_folder + trafficgen.cli.own_ship_file + trafficgen.cli.target_ship_folder + trafficgen.cli.settings_file + trafficgen.cli.output_folder + + +.. py:data:: logger + + + +.. py:data:: default_data_path + + + +.. py:data:: sit_folder + + + +.. py:data:: own_ship_file + + + +.. py:data:: target_ship_folder + + + +.. py:data:: settings_file + + + +.. py:data:: output_folder + + + +.. py:function:: main(args=None) + + +.. py:function:: gen_situation(situations, own_ship, targets, settings, visualize, col, row, visualize_situation, output) + + Console script for trafficgen. Example: + + trafficgen gen-situation -s ./data/example_situations_input + -o ./data/test_output_1 + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/encounter/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/encounter/index.rst.txt new file mode 100644 index 0000000..5852204 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/encounter/index.rst.txt @@ -0,0 +1,246 @@ +:py:mod:`trafficgen.encounter` +============================== + +.. py:module:: trafficgen.encounter + +.. autoapi-nested-parse:: + + This module generates encounters consisting of one own ship and one to many target ships. + The generated encounters may be of type head-on, overtaking give-way and stand-on and + crossing give-way and stand-on. + + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.encounter.generate_encounter + trafficgen.encounter.check_encounter_evolvement + trafficgen.encounter.calculate_min_vector_length_target_ship + trafficgen.encounter.find_start_position_target_ship + trafficgen.encounter.assign_future_position_to_target_ship + trafficgen.encounter.determine_colreg + trafficgen.encounter.calculate_relative_bearing + trafficgen.encounter.calculate_ship_course + trafficgen.encounter.assign_vector_time + trafficgen.encounter.assign_speed_to_target_ship + trafficgen.encounter.assign_beta + trafficgen.encounter.update_position_data_target_ship + trafficgen.encounter.update_position_data_own_ship + trafficgen.encounter.decide_target_ship + + + +.. py:function:: generate_encounter(desired_encounter_type, own_ship, target_ships, target_ship_id, beta_default, relative_speed_default, vector_time_default, settings) + + Generates an encounter. + + Params: + * desired_encounter_type: Desired encounter to be generated + * own_ship: Dict, information about own ship that will encounter a target ship + * target_ships: List of target ships that may be used in an encounter + * target_ship_id: ID which should be used on target ship + * beta_default: User defined beta. If not set, this is None. + * relative_speed_default: User defined relative speed between own ship and + target ship. If not set, this is None. + * vector_time_default: User defined vector time. If not set, this is None. + * settings: Encounter settings + + :returns: target ship information, such as initial position, speed and course + encounter_found: 0=encounter not found, 1=encounter found + :rtype: target_ship + + +.. py:function:: check_encounter_evolvement(own_ship, own_ship_position_future, target_ship, target_ship_position_future, desired_encounter_type, settings) + + Checks encounter evolvement. The generated encounter should be the same type of + encounter (head-on, crossing, give-way) also some time before the encounter is started. + + Params: + * own_ship: Own ship information such as initial position, speed and course + * target_ship: Target ship information such as initial position, speed and course + * desired_encounter_type: Desired type of encounter to be generated + * settings: Encounter settings + + :returns: + + * returns 0 if encounter not ok, 1 if encounter ok + + +.. py:function:: calculate_min_vector_length_target_ship(own_ship_position, own_ship_course, target_ship_position_future, desired_beta) + + Calculates minimum vector length (target ship speed x vector). This will + ensure that ship speed is high enough to find proper situation. + + Params: + * own_ship_position: Own ship initial position, speed and course + * own_ship_course: Own ship initial course + * target_ship_position_future: Target ship future position + * desired_beta: Desired relative bearing between + + Returns: min_vector_length: Minimum vector length (target ship speed x vector) + + +.. py:function:: find_start_position_target_ship(own_ship_position, own_ship_course, target_ship_position_future, target_ship_vector_length, desired_beta, desired_encounter_type, settings) + + Find start position of target ship using desired beta and vector length. + + Params: + * own_ship_position: Own ship initial position, speed and course + * own_ship_course: Own ship initial course + * target_ship_position_future: Target ship future position + * target_ship_vector_length: vector length (target ship speed x vector) + * desired_beta: Desired bearing between own ship and target ship seen from own ship + * desired_encounter_type: Desired type of encounter to be generated + * settings: Encounter settings + + :returns: Dict, initial position of target ship {north, east} [m] + * start_position_found: 0=position not found, 1=position found + :rtype: * start_position_target_ship + + +.. py:function:: assign_future_position_to_target_ship(own_ship_position_future, max_meeting_distance) + + Randomly assign future position of target ship. If drawing a circle with radius + max_meeting_distance around future position of own ship, future position of + target ship shall be somewhere inside this circle. + + Params: + * own_ship_position_future: Dict, own ship position at a given time in the + future, {north, east} + * max_meeting_distance: Maximum distance between own ship and target ship at + a given time in the future [nm] + + :returns: Dict, future position of target ship {north, east} [m] + :rtype: future_position_target_ship + + +.. py:function:: determine_colreg(alpha, beta, theta13_criteria, theta14_criteria, theta15_criteria, theta15) + + Determines the colreg type based on alpha, relative bearing between target ship and own + ship seen from target ship, and beta, relative bearing between own ship and target ship + seen from own ship. + + Params: + * alpha: relative bearing between target ship and own ship seen from target ship + * beta: relative bearing between own ship and target ship seen from own ship + * theta13_criteria: Tolerance for "coming up with" relative bearing + * theta14_criteria: Tolerance for "reciprocal or nearly reciprocal courses", + "when in any doubt... assume... [head-on]" + * theta15_criteria: Crossing aspect limit, used for classifying a crossing encounter + * theta15: 22.5 deg aft of the beam, used for classifying a crossing and an overtaking + encounter + + :returns: + + * encounter classification + + +.. py:function:: calculate_relative_bearing(position_own_ship, heading_own_ship, position_target_ship, heading_target_ship) + + Calculates relative bearing between own ship and target ship, both seen from + own ship and seen from target ship. + + Params: + * position_own_ship: Dict, own ship position {north, east} [m] + * heading_own_ship: Own ship course [deg] + * position_target_ship: Dict, own ship position {north, east} [m] + * heading_target_ship: Target ship course [deg] + + :returns: relative bearing between target ship and own ship seen from target ship [deg] + * beta: relative bearing between own ship and target ship seen from own ship [deg] + :rtype: * alpha + + +.. py:function:: calculate_ship_course(waypoint_0, waypoint_1) + + Calculates ship course between two waypoints + + Params: + * waypoint_0: Dict, waypoint {north, east} [m] + * waypoint_1: Dict, waypoint {north, east} [m] + + :returns: Ship course [deg] + :rtype: course + + +.. py:function:: assign_vector_time(setting_vector_time) + + Randomly (uniform) assigns vector time + + Params: + * setting_vector_time: Minimum and maximum value for vector time + + :returns: Vector time [min] + :rtype: vector_time + + +.. py:function:: assign_speed_to_target_ship(encounter_type, own_ship_speed, min_target_ship_speed, relative_speed_setting) + + Randomly (uniform) assigns speed to target ship depending on type of encounter + + Params: + * encounter_type: Type of encounter + * own_ship_speed: Own ship speed [knot] + * min_target_ship_speed: Minimum target ship speed [knot] + * relative_speed_setting: Relative speed setting dependent on encounter [-] + + :returns: Target ship speed [knot] + :rtype: speed_target_ship + + +.. py:function:: assign_beta(encounter_type, settings) + + Randomly (uniform) assigns relative bearing beta between own ship + and target ship depending on type of encounter + + Params: + * encounter_type: Type of encounter + * settings: Encounter settings + + :returns: Relative bearing between own ship and target ship seen from own ship [deg] + + +.. py:function:: update_position_data_target_ship(ship, lat_lon_0) + + Updating position data of the target ship to also include latitude and longitude + position of the target ship + + Params: + * ship: Target ship data + * lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree] + + :returns: Updated target ship data + :rtype: ship + + +.. py:function:: update_position_data_own_ship(ship, lat_lon_0, delta_time) + + Updating position data of the target ship to also include latitude and longitude + position of the target ship + + Params: + * ship: Own ship data + * lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree] + * delta_time: Delta time from now to the time new position is being calculated [minutes] + + :returns: Updated own ship data + :rtype: ship + + +.. py:function:: decide_target_ship(target_ships) + + Randomly picks a target ship from a dict of target ships + + Params: + * target_ships: dict of target ships + + :returns: The target ship, info of type, size etc. + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/index.rst.txt new file mode 100644 index 0000000..7ac22fb --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/index.rst.txt @@ -0,0 +1,555 @@ +:py:mod:`trafficgen` +==================== + +.. py:module:: trafficgen + +.. autoapi-nested-parse:: + + Top-level package for Traffic Generator. + + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + check_land_crossing/index.rst + cli/index.rst + encounter/index.rst + marine_system_simulator/index.rst + plot_traffic_situation/index.rst + read_files/index.rst + ship_traffic_generator/index.rst + util_methods/index.rst + write_traffic_situation_to_file/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.knot_2_m_pr_min + trafficgen.m_pr_min_2_knot + trafficgen.m2nm + trafficgen.nm_2_m + trafficgen.deg_2_rad + trafficgen.rad_2_deg + trafficgen.convert_angle_minus_180_to_180_to_0_to_360 + trafficgen.convert_angle_0_to_360_to_minus_180_to_180 + trafficgen.calculate_position_at_certain_time + trafficgen.flat2llh + trafficgen.llh2flat + trafficgen.ssa + trafficgen.write_traffic_situations_to_json_file + trafficgen.clean_traffic_situation_data + trafficgen.generate_encounter + trafficgen.check_encounter_evolvement + trafficgen.find_start_position_target_ship + trafficgen.assign_future_position_to_target_ship + trafficgen.determine_colreg + trafficgen.calculate_relative_bearing + trafficgen.calculate_ship_course + trafficgen.assign_vector_time + trafficgen.assign_speed_to_target_ship + trafficgen.assign_beta + trafficgen.update_position_data_target_ship + trafficgen.update_position_data_own_ship + trafficgen.decide_target_ship + trafficgen.plot_traffic_situations + trafficgen.plot_specific_traffic_situation + trafficgen.read_situation_files + trafficgen.read_own_ship_file + trafficgen.read_target_ship_files + trafficgen.read_encounter_setting_file + trafficgen.generate_traffic_situations + trafficgen.find_value + + + +.. py:function:: knot_2_m_pr_min(speed_in_knot) + + Convert ship speed in knot to meters pr minutes. + + Params: + speed_in_knot: Ship speed given in knots + + :returns: Ship speed in meters pr minutes + :rtype: speed_in_m_pr_min + + +.. py:function:: m_pr_min_2_knot(speed_in_m_pr_min) + + Convert ship speed in meters pr minutes to knot. + + Params: + speed_in_m_pr_min: Ship speed in meters pr second + + :returns: Ship speed given in knots + :rtype: speed_in_knot + + +.. py:function:: m2nm(length_in_m) + + Convert length given in meters to length given in nautical miles. + + Params: + length_in_m: Length given in meters + + :returns: Length given in nautical miles + :rtype: length_in_nm + + +.. py:function:: nm_2_m(val) + + Convert length given in nautical miles to length given in meters. + + Params: + length_in_nm: Length given in nautical miles + + :returns: Length given in meters + :rtype: length_in_m + + +.. py:function:: deg_2_rad(angle_in_degrees) + + Convert angle given in degrees to angle give in radians. + + Params: + angle_in_degrees: Angle given in degrees + + :returns: Angle given in radians + :rtype: angle given in radians + + +.. py:function:: rad_2_deg(angle_in_radians) + + Convert angle given in radians to angle give in degrees. + + Params: + angle_in_degrees: Angle given in degrees + + :returns: Angle given in radians + :rtype: angle given in radians + + +.. py:function:: convert_angle_minus_180_to_180_to_0_to_360(angle_180) + + Convert an angle given in the region -180 to 180 degrees to an + angle given in the region 0 to 360 degrees + + Params: + angle_180: Angle given in the region -180 to 180 degrees + + :returns: Angle given in the region 0 to 360 degrees + :rtype: angle_360 + + +.. py:function:: convert_angle_0_to_360_to_minus_180_to_180(angle_360) + + Convert an angle given in the region 0 to 360 degrees to an + angle given in the region -180 to 180 degrees + + Params: + angle_360: Angle given in the region 0 to 360 degrees + + :returns: Angle given in the region -180 to 180 degrees + :rtype: angle_180 + + +.. py:function:: calculate_position_at_certain_time(position, speed, course, delta_time) + + Calculates the position of the ship at a given time based on initial position + and delta time, and constand speed and course. + + Params: + position: Initial ship position [m] + speed: Ship speed [knot] + course: Ship course [deg] + delta_time: Delta time from now to the time new position is being calculated [minutes] + + :returns: Dict, north and east position given in meters + :rtype: position{north, east} + + +.. py:function:: flat2llh(x_n, y_n, lat_0, lon_0, z_n=0.0, height_ref=0.0) + + Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink + library for marine systems. + + The method computes longitude lon (rad), latitude lat (rad) and height h (m) for the + NED coordinates (xn,yn,zn) using a flat Earth coordinate system defined by the WGS-84 + ellipsoid. The flat Earth coordinate origin is located at (lon_0, lat_0) with reference + height h_ref in meters above the surface of the ellipsoid. Both height and h_ref + are positive upwards, while zn is positive downwards (NED). + Author: Thor I. Fossen + Date: 20 July 2018 + Revisions: 2023-02-04 updates the formulas for latitude and longitude + + Params: + xn: Ship position, north [m] + yn: Ship position, east [m] + zn=0.0: Ship position, down [m] + lat_0, lon_0: Flat earth coordinate located at (lon_0, lat_0) + h_ref=0.0: Flat earth coordinate with reference h_ref in meters above the surface + of the ellipsoid + + :returns: Latitude [rad] + lon: Longitude [rad] + h: Height [m] + :rtype: lat + + +.. py:function:: llh2flat(lat, lon, lat_0, lon_0, height=0.0, height_ref=0.0) + + Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink + library for marine systems. + + The method computes (north, east) for a flat Earth coordinate system from longitude + lon (rad) and latitude lat (rad) of the WGS-84 elipsoid. The flat Earth coordinate + origin is located at (lon_0, lat_0). + Author: Thor I. Fossen + Date: 20 July 2018 + Revisions: 2023-02-04 updates the formulas for latitude and longitude + + Params: + lat: Ship position in latitude [rad] + lon: Ship position in longitude [rad] + h=0.0: Ship height in meters above the surface of the ellipsoid + lat_0, lon_0: Flat earth coordinate located at (lon_0, lat_0) + h_ref=0.0: Flat earth coordinate with reference h_ref in meters above + the surface of the ellipsoid + + :returns: Ship position, north [m] + y_n: Ship position, east [m] + z_n: Ship position, down [m] + :rtype: x_n + + +.. py:function:: ssa(angle) + + Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink + library for marine systems. + + SSA is the "smallest signed angle" or the smallest difference between two + angles. Examples: + angle = ssa(angle) maps an angle in rad to the interval [-pi pi) + + Author: Thor I. Fossen + Date: 2018-09-21 + + Param: + angle: angle given in radius + + :returns: "smallest signed angle" or the smallest difference between two angles + :rtype: smallest_angle + + +.. py:function:: write_traffic_situations_to_json_file(traffic_situations, write_folder) + + Write traffic situations to json file + + Params: + traffic_situations: Traffic situations to be written to file + write_folder: Folder where the json files is to be written + + +.. py:function:: clean_traffic_situation_data(traffic_situation) + + Clean traffic situation data to json file + + Params: + traffic_situation: Traffic situation to be cleaned + + :returns: Cleaned traffic situation + :rtype: traffic_situation + + +.. py:function:: generate_encounter(desired_encounter_type, own_ship, target_ships, target_ship_id, beta_default, relative_speed_default, vector_time_default, settings) + + Generates an encounter. + + Params: + * desired_encounter_type: Desired encounter to be generated + * own_ship: Dict, information about own ship that will encounter a target ship + * target_ships: List of target ships that may be used in an encounter + * target_ship_id: ID which should be used on target ship + * beta_default: User defined beta. If not set, this is None. + * relative_speed_default: User defined relative speed between own ship and + target ship. If not set, this is None. + * vector_time_default: User defined vector time. If not set, this is None. + * settings: Encounter settings + + :returns: target ship information, such as initial position, speed and course + encounter_found: 0=encounter not found, 1=encounter found + :rtype: target_ship + + +.. py:function:: check_encounter_evolvement(own_ship, own_ship_position_future, target_ship, target_ship_position_future, desired_encounter_type, settings) + + Checks encounter evolvement. The generated encounter should be the same type of + encounter (head-on, crossing, give-way) also some time before the encounter is started. + + Params: + * own_ship: Own ship information such as initial position, speed and course + * target_ship: Target ship information such as initial position, speed and course + * desired_encounter_type: Desired type of encounter to be generated + * settings: Encounter settings + + :returns: + + * returns 0 if encounter not ok, 1 if encounter ok + + +.. py:function:: find_start_position_target_ship(own_ship_position, own_ship_course, target_ship_position_future, target_ship_vector_length, desired_beta, desired_encounter_type, settings) + + Find start position of target ship using desired beta and vector length. + + Params: + * own_ship_position: Own ship initial position, speed and course + * own_ship_course: Own ship initial course + * target_ship_position_future: Target ship future position + * target_ship_vector_length: vector length (target ship speed x vector) + * desired_beta: Desired bearing between own ship and target ship seen from own ship + * desired_encounter_type: Desired type of encounter to be generated + * settings: Encounter settings + + :returns: Dict, initial position of target ship {north, east} [m] + * start_position_found: 0=position not found, 1=position found + :rtype: * start_position_target_ship + + +.. py:function:: assign_future_position_to_target_ship(own_ship_position_future, max_meeting_distance) + + Randomly assign future position of target ship. If drawing a circle with radius + max_meeting_distance around future position of own ship, future position of + target ship shall be somewhere inside this circle. + + Params: + * own_ship_position_future: Dict, own ship position at a given time in the + future, {north, east} + * max_meeting_distance: Maximum distance between own ship and target ship at + a given time in the future [nm] + + :returns: Dict, future position of target ship {north, east} [m] + :rtype: future_position_target_ship + + +.. py:function:: determine_colreg(alpha, beta, theta13_criteria, theta14_criteria, theta15_criteria, theta15) + + Determines the colreg type based on alpha, relative bearing between target ship and own + ship seen from target ship, and beta, relative bearing between own ship and target ship + seen from own ship. + + Params: + * alpha: relative bearing between target ship and own ship seen from target ship + * beta: relative bearing between own ship and target ship seen from own ship + * theta13_criteria: Tolerance for "coming up with" relative bearing + * theta14_criteria: Tolerance for "reciprocal or nearly reciprocal courses", + "when in any doubt... assume... [head-on]" + * theta15_criteria: Crossing aspect limit, used for classifying a crossing encounter + * theta15: 22.5 deg aft of the beam, used for classifying a crossing and an overtaking + encounter + + :returns: + + * encounter classification + + +.. py:function:: calculate_relative_bearing(position_own_ship, heading_own_ship, position_target_ship, heading_target_ship) + + Calculates relative bearing between own ship and target ship, both seen from + own ship and seen from target ship. + + Params: + * position_own_ship: Dict, own ship position {north, east} [m] + * heading_own_ship: Own ship course [deg] + * position_target_ship: Dict, own ship position {north, east} [m] + * heading_target_ship: Target ship course [deg] + + :returns: relative bearing between target ship and own ship seen from target ship [deg] + * beta: relative bearing between own ship and target ship seen from own ship [deg] + :rtype: * alpha + + +.. py:function:: calculate_ship_course(waypoint_0, waypoint_1) + + Calculates ship course between two waypoints + + Params: + * waypoint_0: Dict, waypoint {north, east} [m] + * waypoint_1: Dict, waypoint {north, east} [m] + + :returns: Ship course [deg] + :rtype: course + + +.. py:function:: assign_vector_time(setting_vector_time) + + Randomly (uniform) assigns vector time + + Params: + * setting_vector_time: Minimum and maximum value for vector time + + :returns: Vector time [min] + :rtype: vector_time + + +.. py:function:: assign_speed_to_target_ship(encounter_type, own_ship_speed, min_target_ship_speed, relative_speed_setting) + + Randomly (uniform) assigns speed to target ship depending on type of encounter + + Params: + * encounter_type: Type of encounter + * own_ship_speed: Own ship speed [knot] + * min_target_ship_speed: Minimum target ship speed [knot] + * relative_speed_setting: Relative speed setting dependent on encounter [-] + + :returns: Target ship speed [knot] + :rtype: speed_target_ship + + +.. py:function:: assign_beta(encounter_type, settings) + + Randomly (uniform) assigns relative bearing beta between own ship + and target ship depending on type of encounter + + Params: + * encounter_type: Type of encounter + * settings: Encounter settings + + :returns: Relative bearing between own ship and target ship seen from own ship [deg] + + +.. py:function:: update_position_data_target_ship(ship, lat_lon_0) + + Updating position data of the target ship to also include latitude and longitude + position of the target ship + + Params: + * ship: Target ship data + * lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree] + + :returns: Updated target ship data + :rtype: ship + + +.. py:function:: update_position_data_own_ship(ship, lat_lon_0, delta_time) + + Updating position data of the target ship to also include latitude and longitude + position of the target ship + + Params: + * ship: Own ship data + * lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree] + * delta_time: Delta time from now to the time new position is being calculated [minutes] + + :returns: Updated own ship data + :rtype: ship + + +.. py:function:: decide_target_ship(target_ships) + + Randomly picks a target ship from a dict of target ships + + Params: + * target_ships: dict of target ships + + :returns: The target ship, info of type, size etc. + + +.. py:function:: plot_traffic_situations(traffic_situations, col, row) + + Plots the traffic situations in one more figures + + Params: + traffic_situations: Traffic situations to be plotted + col: Number of columns in each figure + row: Number of rows in each figure + + +.. py:function:: plot_specific_traffic_situation(traffic_situations, situation_number) + + Plots a specific situation in map + + Params: + traffic_situations: Generated traffic situations + situation_number: The specific situation to be plotted + + +.. py:function:: read_situation_files(situation_folder) + + Reads traffic situation files. + + Params: + situation_folder: Path to the folder where situation files are found + + :returns: List of desired traffic situations + :rtype: situations + + +.. py:function:: read_own_ship_file(own_ship_file) + + Reads the own ship file. + + Params: + own_ship_file: Path to the own_ship_file file + + :returns: own_ship information + + +.. py:function:: read_target_ship_files(target_ship_folder) + + Reads target ship files. + + Params: + target_ship_folder: Path to the folder where target ships are found + + :returns: List of different target ships + :rtype: target_ships + + +.. py:function:: read_encounter_setting_file(settings_file) + + Reads the encounter setting file. + + Params: + settings_file: Path to the encounter setting file + + :returns: Encounter settings + + +.. py:function:: generate_traffic_situations(situation_folder, own_ship_file, target_ship_folder, settings_file) + + This is the main function for generating a set of traffic situations using input files + specifying number and type of encounter, type of target ships etc. + + Params: + * situation_folder: Path to situation folder, files describing the desired situations + * target_ship_folder: Path to where different type of target ships is found + * settings_file: Path to settings file + + :returns: List of generated traffic situations. + One situation may consist of one or more encounters. + :rtype: traffic_situations + + +.. py:function:: find_value(parameters, parameter) + + Finds a key, value pair in a dict. If the key is there, + the value is returned. If not, None is returned. + + Params: + * parameters: Dict of parameters + * parameter: Parameter key to look for in parameters + + :returns: value of the key parameter + :rtype: value + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/marine_system_simulator/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/marine_system_simulator/index.rst.txt new file mode 100644 index 0000000..f77fc24 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/marine_system_simulator/index.rst.txt @@ -0,0 +1,107 @@ +:py:mod:`trafficgen.marine_system_simulator` +============================================ + +.. py:module:: trafficgen.marine_system_simulator + +.. autoapi-nested-parse:: + + The Marine Systems Simulator (MSS) is a Matlab and Simulink library for marine systems. It includes + models for ships, underwater vehicles, unmanned surface vehicles, and floating structures. + The library also contains guidance, navigation, and control (GNC) blocks for real-time simulation. + The algorithms are described in: + + T. I. Fossen (2021). Handbook of Marine Craft Hydrodynamics and Motion Control. 2nd. Edition, + Wiley. ISBN-13: 978-1119575054 + + Parts of the library have been re-implemented in Python and are found below. + + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.marine_system_simulator.flat2llh + trafficgen.marine_system_simulator.llh2flat + trafficgen.marine_system_simulator.ssa + + + +.. py:function:: flat2llh(x_n, y_n, lat_0, lon_0, z_n=0.0, height_ref=0.0) + + Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink + library for marine systems. + + The method computes longitude lon (rad), latitude lat (rad) and height h (m) for the + NED coordinates (xn,yn,zn) using a flat Earth coordinate system defined by the WGS-84 + ellipsoid. The flat Earth coordinate origin is located at (lon_0, lat_0) with reference + height h_ref in meters above the surface of the ellipsoid. Both height and h_ref + are positive upwards, while zn is positive downwards (NED). + Author: Thor I. Fossen + Date: 20 July 2018 + Revisions: 2023-02-04 updates the formulas for latitude and longitude + + Params: + xn: Ship position, north [m] + yn: Ship position, east [m] + zn=0.0: Ship position, down [m] + lat_0, lon_0: Flat earth coordinate located at (lon_0, lat_0) + h_ref=0.0: Flat earth coordinate with reference h_ref in meters above the surface + of the ellipsoid + + :returns: Latitude [rad] + lon: Longitude [rad] + h: Height [m] + :rtype: lat + + +.. py:function:: llh2flat(lat, lon, lat_0, lon_0, height=0.0, height_ref=0.0) + + Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink + library for marine systems. + + The method computes (north, east) for a flat Earth coordinate system from longitude + lon (rad) and latitude lat (rad) of the WGS-84 elipsoid. The flat Earth coordinate + origin is located at (lon_0, lat_0). + Author: Thor I. Fossen + Date: 20 July 2018 + Revisions: 2023-02-04 updates the formulas for latitude and longitude + + Params: + lat: Ship position in latitude [rad] + lon: Ship position in longitude [rad] + h=0.0: Ship height in meters above the surface of the ellipsoid + lat_0, lon_0: Flat earth coordinate located at (lon_0, lat_0) + h_ref=0.0: Flat earth coordinate with reference h_ref in meters above + the surface of the ellipsoid + + :returns: Ship position, north [m] + y_n: Ship position, east [m] + z_n: Ship position, down [m] + :rtype: x_n + + +.. py:function:: ssa(angle) + + Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink + library for marine systems. + + SSA is the "smallest signed angle" or the smallest difference between two + angles. Examples: + angle = ssa(angle) maps an angle in rad to the interval [-pi pi) + + Author: Thor I. Fossen + Date: 2018-09-21 + + Param: + angle: angle given in radius + + :returns: "smallest signed angle" or the smallest difference between two angles + :rtype: smallest_angle + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/plot_traffic_situation/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/plot_traffic_situation/index.rst.txt new file mode 100644 index 0000000..cc9a378 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/plot_traffic_situation/index.rst.txt @@ -0,0 +1,116 @@ +:py:mod:`trafficgen.plot_traffic_situation` +=========================================== + +.. py:module:: trafficgen.plot_traffic_situation + +.. autoapi-nested-parse:: + + This module includes functions to prepare and plot traffic situations + + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.plot_traffic_situation.calculate_vector_arrow + trafficgen.plot_traffic_situation.calculate_ship_outline + trafficgen.plot_traffic_situation.plot_specific_traffic_situation + trafficgen.plot_traffic_situation.add_ship_to_map + trafficgen.plot_traffic_situation.plot_traffic_situations + trafficgen.plot_traffic_situation.find_max_value_for_plot + trafficgen.plot_traffic_situation.add_ship_to_plot + + + +.. py:function:: calculate_vector_arrow(position, direction, vector_length, lat_lon_0) + + Calculates the arrow with length vector pointing in the direction of ship course + + Params: + position: {north}, {east} position of the ship [m] + direction: direction the arrow is pointing [deg] + vector_length: length of vector + lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree] + + :returns: Polygon points to draw the arrow + :rtype: arrow_points + + +.. py:function:: calculate_ship_outline(position, course, lat_lon_0, ship_length=100, ship_width=15) + + Calculates the outline of the ship pointing in the direction of ship course + + Params: + position: {north}, {east} position of the ship [m] + course: course of the ship [deg] + lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree] + ship_length: Ship length. If not given, ship length is set to 100 + ship_width: Ship width. If not given, ship width is set to 15 + + :returns: Polygon points to draw the ship + :rtype: ship_outline_points + + +.. py:function:: plot_specific_traffic_situation(traffic_situations, situation_number) + + Plots a specific situation in map + + Params: + traffic_situations: Generated traffic situations + situation_number: The specific situation to be plotted + + +.. py:function:: add_ship_to_map(ship, vector_time, lat_lon_0, map_plot=None, color='black') + + Adds the ship to the map + + Params: + ship: Ship information + vector_time: Vector time [min] + lat_lon_0=Reference point, latitudinal [degree] and longitudinal [degree] + m: Instance of Map. If not set, instance is set to None + color: Color of the ship. If not set, color is 'black' + + Returns + m: Updated instance of Map. + + +.. py:function:: plot_traffic_situations(traffic_situations, col, row) + + Plots the traffic situations in one more figures + + Params: + traffic_situations: Traffic situations to be plotted + col: Number of columns in each figure + row: Number of rows in each figure + + +.. py:function:: find_max_value_for_plot(ship, max_value) + + Finds the maximum deviation from the Reference point in north and east direction + + Params: + ship: Ship information + max_value: maximum deviation in north, east direction + + :returns: updated maximum deviation in north, east direction + :rtype: max_value + + +.. py:function:: add_ship_to_plot(ship, vector_time, axes=None, color='black') + + Adds the ship to the plot + + Params: + ship: Ship information + vector_time: Vector time [min] + ax: Instance of figure axis. If not set, instance is set to None + color: Color of the ship. If not set, color is 'black' + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/read_files/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/read_files/index.rst.txt new file mode 100644 index 0000000..2701cf1 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/read_files/index.rst.txt @@ -0,0 +1,69 @@ +:py:mod:`trafficgen.read_files` +=============================== + +.. py:module:: trafficgen.read_files + +.. autoapi-nested-parse:: + + This module is used to read the files needed to build one or more traffic situations + + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.read_files.read_situation_files + trafficgen.read_files.read_own_ship_file + trafficgen.read_files.read_target_ship_files + trafficgen.read_files.read_encounter_setting_file + + + +.. py:function:: read_situation_files(situation_folder) + + Reads traffic situation files. + + Params: + situation_folder: Path to the folder where situation files are found + + :returns: List of desired traffic situations + :rtype: situations + + +.. py:function:: read_own_ship_file(own_ship_file) + + Reads the own ship file. + + Params: + own_ship_file: Path to the own_ship_file file + + :returns: own_ship information + + +.. py:function:: read_target_ship_files(target_ship_folder) + + Reads target ship files. + + Params: + target_ship_folder: Path to the folder where target ships are found + + :returns: List of different target ships + :rtype: target_ships + + +.. py:function:: read_encounter_setting_file(settings_file) + + Reads the encounter setting file. + + Params: + settings_file: Path to the encounter setting file + + :returns: Encounter settings + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/ship_traffic_generator/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/ship_traffic_generator/index.rst.txt new file mode 100644 index 0000000..5438d3b --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/ship_traffic_generator/index.rst.txt @@ -0,0 +1,53 @@ +:py:mod:`trafficgen.ship_traffic_generator` +=========================================== + +.. py:module:: trafficgen.ship_traffic_generator + +.. autoapi-nested-parse:: + + This is the main module for generating traffic situations + + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.ship_traffic_generator.generate_traffic_situations + trafficgen.ship_traffic_generator.find_value + + + +.. py:function:: generate_traffic_situations(situation_folder, own_ship_file, target_ship_folder, settings_file) + + This is the main function for generating a set of traffic situations using input files + specifying number and type of encounter, type of target ships etc. + + Params: + * situation_folder: Path to situation folder, files describing the desired situations + * target_ship_folder: Path to where different type of target ships is found + * settings_file: Path to settings file + + :returns: List of generated traffic situations. + One situation may consist of one or more encounters. + :rtype: traffic_situations + + +.. py:function:: find_value(parameters, parameter) + + Finds a key, value pair in a dict. If the key is there, + the value is returned. If not, None is returned. + + Params: + * parameters: Dict of parameters + * parameter: Parameter key to look for in parameters + + :returns: value of the key parameter + :rtype: value + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/util_methods/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/util_methods/index.rst.txt new file mode 100644 index 0000000..ddae8e2 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/util_methods/index.rst.txt @@ -0,0 +1,137 @@ +:py:mod:`trafficgen.util_methods` +================================= + +.. py:module:: trafficgen.util_methods + +.. autoapi-nested-parse:: + + This module includes utillities methods that is used by several other functions. + + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.util_methods.m_pr_min_2_knot + trafficgen.util_methods.knot_2_m_pr_min + trafficgen.util_methods.m2nm + trafficgen.util_methods.nm_2_m + trafficgen.util_methods.deg_2_rad + trafficgen.util_methods.rad_2_deg + trafficgen.util_methods.convert_angle_minus_180_to_180_to_0_to_360 + trafficgen.util_methods.convert_angle_0_to_360_to_minus_180_to_180 + trafficgen.util_methods.calculate_position_at_certain_time + + + +.. py:function:: m_pr_min_2_knot(speed_in_m_pr_min) + + Convert ship speed in meters pr minutes to knot. + + Params: + speed_in_m_pr_min: Ship speed in meters pr second + + :returns: Ship speed given in knots + :rtype: speed_in_knot + + +.. py:function:: knot_2_m_pr_min(speed_in_knot) + + Convert ship speed in knot to meters pr minutes. + + Params: + speed_in_knot: Ship speed given in knots + + :returns: Ship speed in meters pr minutes + :rtype: speed_in_m_pr_min + + +.. py:function:: m2nm(length_in_m) + + Convert length given in meters to length given in nautical miles. + + Params: + length_in_m: Length given in meters + + :returns: Length given in nautical miles + :rtype: length_in_nm + + +.. py:function:: nm_2_m(val) + + Convert length given in nautical miles to length given in meters. + + Params: + length_in_nm: Length given in nautical miles + + :returns: Length given in meters + :rtype: length_in_m + + +.. py:function:: deg_2_rad(angle_in_degrees) + + Convert angle given in degrees to angle give in radians. + + Params: + angle_in_degrees: Angle given in degrees + + :returns: Angle given in radians + :rtype: angle given in radians + + +.. py:function:: rad_2_deg(angle_in_radians) + + Convert angle given in radians to angle give in degrees. + + Params: + angle_in_degrees: Angle given in degrees + + :returns: Angle given in radians + :rtype: angle given in radians + + +.. py:function:: convert_angle_minus_180_to_180_to_0_to_360(angle_180) + + Convert an angle given in the region -180 to 180 degrees to an + angle given in the region 0 to 360 degrees + + Params: + angle_180: Angle given in the region -180 to 180 degrees + + :returns: Angle given in the region 0 to 360 degrees + :rtype: angle_360 + + +.. py:function:: convert_angle_0_to_360_to_minus_180_to_180(angle_360) + + Convert an angle given in the region 0 to 360 degrees to an + angle given in the region -180 to 180 degrees + + Params: + angle_360: Angle given in the region 0 to 360 degrees + + :returns: Angle given in the region -180 to 180 degrees + :rtype: angle_180 + + +.. py:function:: calculate_position_at_certain_time(position, speed, course, delta_time) + + Calculates the position of the ship at a given time based on initial position + and delta time, and constand speed and course. + + Params: + position: Initial ship position [m] + speed: Ship speed [knot] + course: Ship course [deg] + delta_time: Delta time from now to the time new position is being calculated [minutes] + + :returns: Dict, north and east position given in meters + :rtype: position{north, east} + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/write_traffic_situation_to_file/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/write_traffic_situation_to_file/index.rst.txt new file mode 100644 index 0000000..c83d6d6 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/api/trafficgen/write_traffic_situation_to_file/index.rst.txt @@ -0,0 +1,45 @@ +:py:mod:`trafficgen.write_traffic_situation_to_file` +==================================================== + +.. py:module:: trafficgen.write_traffic_situation_to_file + +.. autoapi-nested-parse:: + + This module cleans traffic situations data before writing it to json-file. + + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + trafficgen.write_traffic_situation_to_file.write_traffic_situations_to_json_file + trafficgen.write_traffic_situation_to_file.clean_traffic_situation_data + + + +.. py:function:: write_traffic_situations_to_json_file(traffic_situations, write_folder) + + Write traffic situations to json file + + Params: + traffic_situations: Traffic situations to be written to file + write_folder: Folder where the json files is to be written + + +.. py:function:: clean_traffic_situation_data(traffic_situation) + + Clean traffic situation data to json file + + Params: + traffic_situation: Traffic situation to be cleaned + + :returns: Cleaned traffic situation + :rtype: traffic_situation + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/authors.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/authors.rst.txt new file mode 100644 index 0000000..e122f91 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/authors.rst.txt @@ -0,0 +1 @@ +.. include:: ../AUTHORS.rst diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/contributing.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/contributing.rst.txt new file mode 100644 index 0000000..e582053 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/contributing.rst.txt @@ -0,0 +1 @@ +.. include:: ../CONTRIBUTING.rst diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/history.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/history.rst.txt new file mode 100644 index 0000000..2506499 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/history.rst.txt @@ -0,0 +1 @@ +.. include:: ../HISTORY.rst diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/index.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/index.rst.txt new file mode 100644 index 0000000..1ef9213 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/index.rst.txt @@ -0,0 +1,28 @@ +Welcome to Traffic Generator's documentation! +====================================== + +The tool generates a structured set of encounters for verifying automatic collision and +grounding avoidance systems. Based on input parameters such as desired situation, relative speed, +relative bearing etc, the tool will generate a set of traffic situations. The traffic situations +may be written to files and/or inspected using plots. + +A :download:`paper<../docs/ICMASS23_verfying_caga_systems.pdf>` is written describing the background for +the tool and how it works. + +.. toctree:: + :maxdepth: 2 + :glob: + :caption: Contents: + + installation + usage + input_files + contributing + authors + history + +Indices and tables +================== +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/input_files.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/input_files.rst.txt new file mode 100644 index 0000000..0950c59 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/input_files.rst.txt @@ -0,0 +1,93 @@ +=========== +Input files +=========== + +Example 1: Complete specified situation:: + + { + "title": "HO", + "common_vector": 10.0, + "own_ship": { + "speed": 10.0, + "course": 0.0, + "position": { + "north": 0.0, + "east": 0.0 + } + }, + "encounter": [ + { + "desired_encounter_type": "head-on", + "beta": 2.0, + "relative_speed": 1.2, + "vector_time": 15.0 + } + ] + } + +The `common_vector` is given in minutes. For radar plotting (plotting vessel positions and relative motions), +the `common_vector` and `vector_time` are used together with ship speed to display where the ship will be in e.g. 10 minutes +(Common vector is the common time vector used on a radar plot, e.g 10, 15, 20 minutes. The length of the arrow in the plot +will then be the speed times this time vector). +Speed and course of the own ship, which is the ship to be tested, are given in knots and degrees, respectively. +The own ship position is given in meters from the reference points, which are defined in latitudinal [degree] and longitudinal [degree]. +The global reference point is defined in `src/trafficgen/settings/encounter_settings.json`. + +An encounter may be fully described as shown above, but the user may also deside to input less data, +as demonstrated in Example 2. Desired encounter type is mandatory, +while the `beta`, `relative_speed` and `vector_time` parameters are optional: + + * `desired_encounter_type` is either head-on, overtaking-give-way, overtaking-stand-on, crossing-give-way, and crossing-stand-on. + * `beta` is the relative bearing between the own ship and the target ship as seen from the own shop, given in degrees. + * `relative_speed` is relative speed between the own ship and the target ship as seen from the own ship, such that a relative speed of 1.2 means that the target ship's speed is 20% higher than the speed of the own ship. + +An encounter is built using a maximum meeting distance [nm], see the paper linked in the introduction for more info. +At some time in the future, given by the `vector_time`, the target ship will be located somewhere inside a circle +with a radius given by `max_meeting_distance` and a center point given by the own ship position. This is not necessarily the +closest point of approach. + +The `max_meeting_distance` parameter is common for all encounters and is specified in `src/trafficgen/settings/encounter_settings.json`. + +Example 2: Minimum specified situation:: + + { + "title": "HO", + "common_vector": 10.0, + "own_ship": { + "speed": 10.0, + "course": 0.0, + "position": { + "north": 0.0, + "east": 0.0 + } + }, + "encounter": [ + { + "desired_encounter_type": "head-on" + } + ] + } + + +You can also request the generation of several traffic situations of the same encounter type by specifying `num_situations`: + +Example 3: Generate multiple situations using `num_situations`:: + + { + "title": "OT_GW", + "common_vector": 10.0, + "own_ship": { + "speed": 7.0, + "course": 0.0, + "position": { + "north": 0.0, + "east": 0.0 + } + }, + "num_situations": 5, + "encounter": [ + { + "desired_encounter_type": "overtaking-give-way" + } + ] + } \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/installation.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/installation.rst.txt new file mode 100644 index 0000000..13058cb --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/installation.rst.txt @@ -0,0 +1,45 @@ +.. highlight:: shell + +============ +Installation +============ + + +Stable release +-------------- + +To install Traffic Generator, run this command in your terminal: + +.. code-block:: console + + $ pip install trafficgen + +This is the preferred method to install Traffic Generator, as it will always install the most recent stable release. + +If you don't have `pip`_ installed, this `Python installation guide`_ can guide +you through the process. + +.. _pip: https://pip.pypa.io +.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ + + +From sources +------------ + +The sources for Traffic Generator can be downloaded from the https://github.com/dnv-opensource/ship-traffic-generator. + +You can either clone the public repository: + +.. code-block:: console + + $ git clone https://github.com/dnv-opensource/ship-traffic-generator + + +Once you have a copy of the source, you can install it with: + +.. code-block:: console + + $ python setup.py install + + +.. _Git repo: git clone https://github.com/dnv-opensource/ship-traffic-generator diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/modules.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/modules.rst.txt new file mode 100644 index 0000000..2bce8f8 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/modules.rst.txt @@ -0,0 +1,7 @@ +trafficgen +========== + +.. toctree:: + :maxdepth: 4 + + trafficgen diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/trafficgen.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/trafficgen.rst.txt new file mode 100644 index 0000000..da5f234 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/trafficgen.rst.txt @@ -0,0 +1,85 @@ +trafficgen package +================== + +Submodules +---------- + +trafficgen.check\_land\_crossing module +--------------------------------------- + +.. automodule:: trafficgen.check_land_crossing + :members: + :undoc-members: + :show-inheritance: + +trafficgen.cli module +--------------------- + +.. automodule:: trafficgen.cli + :members: + :undoc-members: + :show-inheritance: + +trafficgen.encounter module +--------------------------- + +.. automodule:: trafficgen.encounter + :members: + :undoc-members: + :show-inheritance: + +trafficgen.marine\_system\_simulator module +------------------------------------------- + +.. automodule:: trafficgen.marine_system_simulator + :members: + :undoc-members: + :show-inheritance: + +trafficgen.plot\_traffic\_situation module +------------------------------------------ + +.. automodule:: trafficgen.plot_traffic_situation + :members: + :undoc-members: + :show-inheritance: + +trafficgen.read\_files module +----------------------------- + +.. automodule:: trafficgen.read_files + :members: + :undoc-members: + :show-inheritance: + +trafficgen.ship\_traffic\_generator module +------------------------------------------ + +.. automodule:: trafficgen.ship_traffic_generator + :members: + :undoc-members: + :show-inheritance: + +trafficgen.util\_methods module +------------------------------- + +.. automodule:: trafficgen.util_methods + :members: + :undoc-members: + :show-inheritance: + +trafficgen.write\_traffic\_situation\_to\_file module +----------------------------------------------------- + +.. automodule:: trafficgen.write_traffic_situation_to_file + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: trafficgen + :members: + :undoc-members: + :show-inheritance: diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/usage.rst.txt b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/usage.rst.txt new file mode 100644 index 0000000..e631882 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_sources/usage.rst.txt @@ -0,0 +1,58 @@ +===== +Usage +===== + +To use Traffic Generator in a project:: + + import trafficgen + +To use Traffic Generator as a command line tool for generating traffic situations, write:: + + trafficgen gen-situation + +The command line tool takes different input options:: + + -s, --situations PATH Folders with situations (default=./baseline_situations_input/) + -t, --targets PATH Folder with target configurations (default=./target_ships/) + -c, --settings PATH Path to settings file (default=./settings/encounter_settings.json) + --visualize Plot visualization + --col INTEGER Number of columns for plot, may be used with visualize (default=10) + --row INTEGER Number of rows for plot, may be used with visualize (default=6) + --visualize-situation INTEGER Plot individual traffic situation, specify INTEGER value + -o, --output PATH Output folder (default=None) + --help Show this message and exit. + +Example:: + + trafficgen gen-situation -s ./data/example_situations_input -o ./data/test_output_1 + +Situations +~~~~~~~~~~ +When generating situations without specifying where the desired situations (``--situation``) are found, the +default path, which is ``default=./baseline_situations_input/``, will be used. + +Baseline situations +~~~~~~~~~~~~~~~~~~~ +The baseline situations are a set of generic traffic situations covering head-on, overtaking stand-on/give-way +and crossing stand-on/give-way encounters. To cover the combination of encounters for 1, 2 and 3 target ships, +there are in total 55 baseline situations. The input files for generating these situations are found in +``./baseline_situations_input/`` + +Plotting +~~~~~~~~ +Plotting all generated traffic situations +----------------------------------------- +All the generated situations are displayed if using ``--visualize``. This will pop up one or more plot windows, +which show all the traffic situations. The number of colums and rows for the plots (per figure) can be specified by +using ``--col`` and ``--row``, respectively. + +Individual plots with map background +------------------------------------ +A specific encounter is visualized by using ``--visualize-situation INTEGER``, e.g.:: + + trafficgen gen-situation -s ./data/example_situations_input -o ./data/test_output_1 --visualize-situation 2 + +This will open a browser window/tab with an OpenStreetMap background and the traffic situation +radar plot as an overlay. +Note that the integer needs to be within the range of the number of generated situations, +for example 1 - 12 if you generated 12 situations. diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/_sphinx_javascript_frameworks_compat.js b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8141580 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/basic.css b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/basic.css new file mode 100644 index 0000000..30fee9d --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/badge_only.css b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/badge_only.css new file mode 100644 index 0000000..c718cee --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Bold.woff b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Bold.woff2 b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Regular.woff b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Regular.woff2 b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.eot b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.svg b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.ttf b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.woff b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.woff2 b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold-italic.woff b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold-italic.woff differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold-italic.woff2 b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold.woff b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold.woff differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold.woff2 b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-bold.woff2 differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal-italic.woff b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal-italic.woff differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal-italic.woff2 b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal.woff b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal.woff differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal.woff2 b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/fonts/lato-normal.woff2 differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/theme.css b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/theme.css new file mode 100644 index 0000000..19a446a --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/doctools.js b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/doctools.js new file mode 100644 index 0000000..d06a71d --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/documentation_options.js b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/documentation_options.js new file mode 100644 index 0000000..13d90ff --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '0.1.0', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/file.png b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/file.png differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/graphviz.css b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/graphviz.css new file mode 100644 index 0000000..8d81c02 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/graphviz.css @@ -0,0 +1,19 @@ +/* + * graphviz.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- graphviz extension. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +img.graphviz { + border: 0; + max-width: 100%; +} + +object.graphviz { + max-width: 100%; +} diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/jquery.js b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/jquery.js new file mode 100644 index 0000000..c4c6022 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/js/html5shiv.min.js b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/js/html5shiv.min.js new file mode 100644 index 0000000..cd1c674 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/js/theme.js b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/js/theme.js new file mode 100644 index 0000000..1fddb6e --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/minus.png b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/minus.png differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/plus.png b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/plus.png differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/pygments.css b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/pygments.css new file mode 100644 index 0000000..0d49244 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #eeffcc; } +.highlight .c { color: #408090; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #333333 } /* Generic.Output */ +.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020 } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000 } /* Keyword.Type */ +.highlight .m { color: #208050 } /* Literal.Number */ +.highlight .s { color: #4070a0 } /* Literal.String */ +.highlight .na { color: #4070a0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60add5 } /* Name.Constant */ +.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #007020 } /* Name.Exception */ +.highlight .nf { color: #06287e } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #bb60d5 } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #208050 } /* Literal.Number.Bin */ +.highlight .mf { color: #208050 } /* Literal.Number.Float */ +.highlight .mh { color: #208050 } /* Literal.Number.Hex */ +.highlight .mi { color: #208050 } /* Literal.Number.Integer */ +.highlight .mo { color: #208050 } /* Literal.Number.Oct */ +.highlight .sa { color: #4070a0 } /* Literal.String.Affix */ +.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070a0 } /* Literal.String.Char */ +.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ +.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ +.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #c65d09 } /* Literal.String.Other */ +.highlight .sr { color: #235388 } /* Literal.String.Regex */ +.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +.highlight .ss { color: #517918 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #06287e } /* Name.Function.Magic */ +.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ +.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ +.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ +.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ +.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/searchtools.js b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/searchtools.js new file mode 100644 index 0000000..7918c3f --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/sphinx_highlight.js b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/index.html new file mode 100644 index 0000000..7ac1b08 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/index.html @@ -0,0 +1,145 @@ + + + + + + + API Reference — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+ +
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/check_land_crossing/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/check_land_crossing/index.html new file mode 100644 index 0000000..5ebac6f --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/check_land_crossing/index.html @@ -0,0 +1,175 @@ + + + + + + + trafficgen.check_land_crossing — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen.check_land_crossing

+

This module finds if the generated path is crossing land.

+
+

Module Contents

+
+

Functions

+ + + + + + +

path_crosses_land(position_1, speed, course, lat_lon_0)

Find if path is crossing land.

+
+
+trafficgen.check_land_crossing.path_crosses_land(position_1, speed, course, lat_lon_0, time_interval=50)
+

Find if path is crossing land.

+
+
Params:

position_1: Ship position in (north, east) [m]. +speed: Ship speed [knots]. +course: Ship course [degree]. +lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree]. +time_interval: The time interval the vessel should travel without crossing land [minutes]

+
+
+
+
Returns:
+

True if parts of the path crosses land.

+
+
Return type:
+

is_on_land

+
+
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/cli/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/cli/index.html new file mode 100644 index 0000000..a162ed1 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/cli/index.html @@ -0,0 +1,232 @@ + + + + + + + trafficgen.cli — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen.cli

+

CLI for trafficgen package.

+
+

Module Contents

+
+

Functions

+ + + + + + + + + +

main([args])

gen_situation(situations, own_ship, targets, settings, ...)

Console script for trafficgen. Example:

+
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + + +

logger

default_data_path

sit_folder

own_ship_file

target_ship_folder

settings_file

output_folder

+
+
+trafficgen.cli.logger
+
+ +
+
+trafficgen.cli.default_data_path
+
+ +
+
+trafficgen.cli.sit_folder
+
+ +
+
+trafficgen.cli.own_ship_file
+
+ +
+
+trafficgen.cli.target_ship_folder
+
+ +
+
+trafficgen.cli.settings_file
+
+ +
+
+trafficgen.cli.output_folder
+
+ +
+
+trafficgen.cli.main(args=None)
+
+ +
+
+trafficgen.cli.gen_situation(situations, own_ship, targets, settings, visualize, col, row, visualize_situation, output)
+

Console script for trafficgen. Example:

+

trafficgen gen-situation -s ./data/example_situations_input +-o ./data/test_output_1

+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/encounter/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/encounter/index.html new file mode 100644 index 0000000..75dceba --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/encounter/index.html @@ -0,0 +1,533 @@ + + + + + + + trafficgen.encounter — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen.encounter

+

This module generates encounters consisting of one own ship and one to many target ships. +The generated encounters may be of type head-on, overtaking give-way and stand-on and +crossing give-way and stand-on.

+
+

Module Contents

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

generate_encounter(desired_encounter_type, own_ship, ...)

Generates an encounter.

check_encounter_evolvement(own_ship, ...)

Checks encounter evolvement. The generated encounter should be the same type of

calculate_min_vector_length_target_ship(...)

Calculates minimum vector length (target ship speed x vector). This will

find_start_position_target_ship(own_ship_position, ...)

Find start position of target ship using desired beta and vector length.

assign_future_position_to_target_ship(...)

Randomly assign future position of target ship. If drawing a circle with radius

determine_colreg(alpha, beta, theta13_criteria, ...)

Determines the colreg type based on alpha, relative bearing between target ship and own

calculate_relative_bearing(position_own_ship, ...)

Calculates relative bearing between own ship and target ship, both seen from

calculate_ship_course(waypoint_0, waypoint_1)

Calculates ship course between two waypoints

assign_vector_time(setting_vector_time)

Randomly (uniform) assigns vector time

assign_speed_to_target_ship(encounter_type, ...)

Randomly (uniform) assigns speed to target ship depending on type of encounter

assign_beta(encounter_type, settings)

Randomly (uniform) assigns relative bearing beta between own ship

update_position_data_target_ship(ship, lat_lon_0)

Updating position data of the target ship to also include latitude and longitude

update_position_data_own_ship(ship, lat_lon_0, delta_time)

Updating position data of the target ship to also include latitude and longitude

decide_target_ship(target_ships)

Randomly picks a target ship from a dict of target ships

+
+
+trafficgen.encounter.generate_encounter(desired_encounter_type, own_ship, target_ships, target_ship_id, beta_default, relative_speed_default, vector_time_default, settings)
+

Generates an encounter.

+
+
Params:
    +

  • desired_encounter_type: Desired encounter to be generated

    • +

  • own_ship: Dict, information about own ship that will encounter a target ship

    • +

  • target_ships: List of target ships that may be used in an encounter

    • +

  • target_ship_id: ID which should be used on target ship

    • +

  • beta_default: User defined beta. If not set, this is None.

    • +
  • +
    relative_speed_default: User defined relative speed between own ship and

    target ship. If not set, this is None.

    +
    +
    +
    • +

  • vector_time_default: User defined vector time. If not set, this is None.

    • +

  • settings: Encounter settings

    • +
+
+
+
+
Returns:
+

target ship information, such as initial position, speed and course +encounter_found: 0=encounter not found, 1=encounter found

+
+
Return type:
+

target_ship

+
+
+
+ +
+
+trafficgen.encounter.check_encounter_evolvement(own_ship, own_ship_position_future, target_ship, target_ship_position_future, desired_encounter_type, settings)
+

Checks encounter evolvement. The generated encounter should be the same type of +encounter (head-on, crossing, give-way) also some time before the encounter is started.

+
+
Params:
    +

  • own_ship: Own ship information such as initial position, speed and course

    • +

  • target_ship: Target ship information such as initial position, speed and course

    • +

  • desired_encounter_type: Desired type of encounter to be generated

    • +

  • settings: Encounter settings

    • +
+
+
+
+
Returns:
+

    +

  • returns 0 if encounter not ok, 1 if encounter ok

    • +
+

+
+
+
+ +
+
+trafficgen.encounter.calculate_min_vector_length_target_ship(own_ship_position, own_ship_course, target_ship_position_future, desired_beta)
+

Calculates minimum vector length (target ship speed x vector). This will +ensure that ship speed is high enough to find proper situation.

+
+
Params:
    +

  • own_ship_position: Own ship initial position, speed and course

    • +

  • own_ship_course: Own ship initial course

    • +

  • target_ship_position_future: Target ship future position

    • +

  • desired_beta: Desired relative bearing between

    • +
+
+
+

Returns: min_vector_length: Minimum vector length (target ship speed x vector)

+
+ +
+
+trafficgen.encounter.find_start_position_target_ship(own_ship_position, own_ship_course, target_ship_position_future, target_ship_vector_length, desired_beta, desired_encounter_type, settings)
+

Find start position of target ship using desired beta and vector length.

+
+
Params:
    +

  • own_ship_position: Own ship initial position, speed and course

    • +

  • own_ship_course: Own ship initial course

    • +

  • target_ship_position_future: Target ship future position

    • +

  • target_ship_vector_length: vector length (target ship speed x vector)

    • +

  • desired_beta: Desired bearing between own ship and target ship seen from own ship

    • +

  • desired_encounter_type: Desired type of encounter to be generated

    • +

  • settings: Encounter settings

    • +
+
+
+
+
Returns:
+

Dict, initial position of target ship {north, east} [m] +* start_position_found: 0=position not found, 1=position found

+
+
Return type:
+

    +

  • start_position_target_ship

    • +
+

+
+
+
+ +
+
+trafficgen.encounter.assign_future_position_to_target_ship(own_ship_position_future, max_meeting_distance)
+

Randomly assign future position of target ship. If drawing a circle with radius +max_meeting_distance around future position of own ship, future position of +target ship shall be somewhere inside this circle.

+
+
Params:
    +
  • +
    own_ship_position_future: Dict, own ship position at a given time in the

    future, {north, east}

    +
    +
    +
    • +
  • +
    max_meeting_distance: Maximum distance between own ship and target ship at

    a given time in the future [nm]

    +
    +
    +
    • +
+
+
+
+
Returns:
+

Dict, future position of target ship {north, east} [m]

+
+
Return type:
+

future_position_target_ship

+
+
+
+ +
+
+trafficgen.encounter.determine_colreg(alpha, beta, theta13_criteria, theta14_criteria, theta15_criteria, theta15)
+

Determines the colreg type based on alpha, relative bearing between target ship and own +ship seen from target ship, and beta, relative bearing between own ship and target ship +seen from own ship.

+
+
Params:
    +

  • alpha: relative bearing between target ship and own ship seen from target ship

    • +

  • beta: relative bearing between own ship and target ship seen from own ship

    • +

  • theta13_criteria: Tolerance for “coming up with” relative bearing

    • +

  • theta14_criteria: Tolerance for “reciprocal or nearly reciprocal courses”, +“when in any doubt… assume… [head-on]”

    • +

  • theta15_criteria: Crossing aspect limit, used for classifying a crossing encounter

    • +
  • +
    theta15: 22.5 deg aft of the beam, used for classifying a crossing and an overtaking

    encounter

    +
    +
    +
    • +
+
+
+
+
Returns:
+

    +

  • encounter classification

    • +
+

+
+
+
+ +
+
+trafficgen.encounter.calculate_relative_bearing(position_own_ship, heading_own_ship, position_target_ship, heading_target_ship)
+

Calculates relative bearing between own ship and target ship, both seen from +own ship and seen from target ship.

+
+
Params:
    +

  • position_own_ship: Dict, own ship position {north, east} [m]

    • +

  • heading_own_ship: Own ship course [deg]

    • +

  • position_target_ship: Dict, own ship position {north, east} [m]

    • +

  • heading_target_ship: Target ship course [deg]

    • +
+
+
+
+
Returns:
+

relative bearing between target ship and own ship seen from target ship [deg] +* beta: relative bearing between own ship and target ship seen from own ship [deg]

+
+
Return type:
+

    +

  • alpha

    • +
+

+
+
+
+ +
+
+trafficgen.encounter.calculate_ship_course(waypoint_0, waypoint_1)
+

Calculates ship course between two waypoints

+
+
Params:
    +

  • waypoint_0: Dict, waypoint {north, east} [m]

    • +

  • waypoint_1: Dict, waypoint {north, east} [m]

    • +
+
+
+
+
Returns:
+

Ship course [deg]

+
+
Return type:
+

course

+
+
+
+ +
+
+trafficgen.encounter.assign_vector_time(setting_vector_time)
+

Randomly (uniform) assigns vector time

+
+
Params:
    +

  • setting_vector_time: Minimum and maximum value for vector time

    • +
+
+
+
+
Returns:
+

Vector time [min]

+
+
Return type:
+

vector_time

+
+
+
+ +
+
+trafficgen.encounter.assign_speed_to_target_ship(encounter_type, own_ship_speed, min_target_ship_speed, relative_speed_setting)
+

Randomly (uniform) assigns speed to target ship depending on type of encounter

+
+
Params:
    +

  • encounter_type: Type of encounter

    • +

  • own_ship_speed: Own ship speed [knot]

    • +

  • min_target_ship_speed: Minimum target ship speed [knot]

    • +

  • relative_speed_setting: Relative speed setting dependent on encounter [-]

    • +
+
+
+
+
Returns:
+

Target ship speed [knot]

+
+
Return type:
+

speed_target_ship

+
+
+
+ +
+
+trafficgen.encounter.assign_beta(encounter_type, settings)
+

Randomly (uniform) assigns relative bearing beta between own ship +and target ship depending on type of encounter

+
+
Params:
    +

  • encounter_type: Type of encounter

    • +

  • settings: Encounter settings

    • +
+
+
+
+
Returns:
+

Relative bearing between own ship and target ship seen from own ship [deg]

+
+
+
+ +
+
+trafficgen.encounter.update_position_data_target_ship(ship, lat_lon_0)
+

Updating position data of the target ship to also include latitude and longitude +position of the target ship

+
+
Params:
    +

  • ship: Target ship data

    • +

  • lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree]

    • +
+
+
+
+
Returns:
+

Updated target ship data

+
+
Return type:
+

ship

+
+
+
+ +
+
+trafficgen.encounter.update_position_data_own_ship(ship, lat_lon_0, delta_time)
+

Updating position data of the target ship to also include latitude and longitude +position of the target ship

+
+
Params:
    +

  • ship: Own ship data

    • +

  • lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree]

    • +

  • delta_time: Delta time from now to the time new position is being calculated [minutes]

    • +
+
+
+
+
Returns:
+

Updated own ship data

+
+
Return type:
+

ship

+
+
+
+ +
+
+trafficgen.encounter.decide_target_ship(target_ships)
+

Randomly picks a target ship from a dict of target ships

+
+
Params:
    +

  • target_ships: dict of target ships

    • +
+
+
+
+
Returns:
+

The target ship, info of type, size etc.

+
+
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/index.html new file mode 100644 index 0000000..28e7802 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/index.html @@ -0,0 +1,1017 @@ + + + + + + + trafficgen — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen

+

Top-level package for Traffic Generator.

+
+

Submodules

+
+ +
+
+
+

Package Contents

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

knot_2_m_pr_min(speed_in_knot)

Convert ship speed in knot to meters pr minutes.

m_pr_min_2_knot(speed_in_m_pr_min)

Convert ship speed in meters pr minutes to knot.

m2nm(length_in_m)

Convert length given in meters to length given in nautical miles.

nm_2_m(val)

Convert length given in nautical miles to length given in meters.

deg_2_rad(angle_in_degrees)

Convert angle given in degrees to angle give in radians.

rad_2_deg(angle_in_radians)

Convert angle given in radians to angle give in degrees.

convert_angle_minus_180_to_180_to_0_to_360(angle_180)

Convert an angle given in the region -180 to 180 degrees to an

convert_angle_0_to_360_to_minus_180_to_180(angle_360)

Convert an angle given in the region 0 to 360 degrees to an

calculate_position_at_certain_time(position, speed, ...)

Calculates the position of the ship at a given time based on initial position

flat2llh(x_n, y_n, lat_0, lon_0[, z_n, height_ref])

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink

llh2flat(lat, lon, lat_0, lon_0[, height, height_ref])

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink

ssa(angle)

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink

write_traffic_situations_to_json_file(...)

Write traffic situations to json file

clean_traffic_situation_data(traffic_situation)

Clean traffic situation data to json file

generate_encounter(desired_encounter_type, own_ship, ...)

Generates an encounter.

check_encounter_evolvement(own_ship, ...)

Checks encounter evolvement. The generated encounter should be the same type of

find_start_position_target_ship(own_ship_position, ...)

Find start position of target ship using desired beta and vector length.

assign_future_position_to_target_ship(...)

Randomly assign future position of target ship. If drawing a circle with radius

determine_colreg(alpha, beta, theta13_criteria, ...)

Determines the colreg type based on alpha, relative bearing between target ship and own

calculate_relative_bearing(position_own_ship, ...)

Calculates relative bearing between own ship and target ship, both seen from

calculate_ship_course(waypoint_0, waypoint_1)

Calculates ship course between two waypoints

assign_vector_time(setting_vector_time)

Randomly (uniform) assigns vector time

assign_speed_to_target_ship(encounter_type, ...)

Randomly (uniform) assigns speed to target ship depending on type of encounter

assign_beta(encounter_type, settings)

Randomly (uniform) assigns relative bearing beta between own ship

update_position_data_target_ship(ship, lat_lon_0)

Updating position data of the target ship to also include latitude and longitude

update_position_data_own_ship(ship, lat_lon_0, delta_time)

Updating position data of the target ship to also include latitude and longitude

decide_target_ship(target_ships)

Randomly picks a target ship from a dict of target ships

plot_traffic_situations(traffic_situations, col, row)

Plots the traffic situations in one more figures

plot_specific_traffic_situation(traffic_situations, ...)

Plots a specific situation in map

read_situation_files(situation_folder)

Reads traffic situation files.

read_own_ship_file(own_ship_file)

Reads the own ship file.

read_target_ship_files(target_ship_folder)

Reads target ship files.

read_encounter_setting_file(settings_file)

Reads the encounter setting file.

generate_traffic_situations(situation_folder, ...)

This is the main function for generating a set of traffic situations using input files

find_value(parameters, parameter)

Finds a key, value pair in a dict. If the key is there,

+
+
+trafficgen.knot_2_m_pr_min(speed_in_knot)
+

Convert ship speed in knot to meters pr minutes.

+
+
Params:

speed_in_knot: Ship speed given in knots

+
+
+
+
Returns:
+

Ship speed in meters pr minutes

+
+
Return type:
+

speed_in_m_pr_min

+
+
+
+ +
+
+trafficgen.m_pr_min_2_knot(speed_in_m_pr_min)
+

Convert ship speed in meters pr minutes to knot.

+
+
Params:

speed_in_m_pr_min: Ship speed in meters pr second

+
+
+
+
Returns:
+

Ship speed given in knots

+
+
Return type:
+

speed_in_knot

+
+
+
+ +
+
+trafficgen.m2nm(length_in_m)
+

Convert length given in meters to length given in nautical miles.

+
+
Params:

length_in_m: Length given in meters

+
+
+
+
Returns:
+

Length given in nautical miles

+
+
Return type:
+

length_in_nm

+
+
+
+ +
+
+trafficgen.nm_2_m(val)
+

Convert length given in nautical miles to length given in meters.

+
+
Params:

length_in_nm: Length given in nautical miles

+
+
+
+
Returns:
+

Length given in meters

+
+
Return type:
+

length_in_m

+
+
+
+ +
+
+trafficgen.deg_2_rad(angle_in_degrees)
+

Convert angle given in degrees to angle give in radians.

+
+
Params:

angle_in_degrees: Angle given in degrees

+
+
+
+
Returns:
+

Angle given in radians

+
+
Return type:
+

angle given in radians

+
+
+
+ +
+
+trafficgen.rad_2_deg(angle_in_radians)
+

Convert angle given in radians to angle give in degrees.

+
+
Params:

angle_in_degrees: Angle given in degrees

+
+
+
+
Returns:
+

Angle given in radians

+
+
Return type:
+

angle given in radians

+
+
+
+ +
+
+trafficgen.convert_angle_minus_180_to_180_to_0_to_360(angle_180)
+

Convert an angle given in the region -180 to 180 degrees to an +angle given in the region 0 to 360 degrees

+
+
Params:

angle_180: Angle given in the region -180 to 180 degrees

+
+
+
+
Returns:
+

Angle given in the region 0 to 360 degrees

+
+
Return type:
+

angle_360

+
+
+
+ +
+
+trafficgen.convert_angle_0_to_360_to_minus_180_to_180(angle_360)
+

Convert an angle given in the region 0 to 360 degrees to an +angle given in the region -180 to 180 degrees

+
+
Params:

angle_360: Angle given in the region 0 to 360 degrees

+
+
+
+
Returns:
+

Angle given in the region -180 to 180 degrees

+
+
Return type:
+

angle_180

+
+
+
+ +
+
+trafficgen.calculate_position_at_certain_time(position, speed, course, delta_time)
+

Calculates the position of the ship at a given time based on initial position +and delta time, and constand speed and course.

+
+
Params:

position: Initial ship position [m] +speed: Ship speed [knot] +course: Ship course [deg] +delta_time: Delta time from now to the time new position is being calculated [minutes]

+
+
+
+
Returns:
+

Dict, north and east position given in meters

+
+
Return type:
+

position{north, east}

+
+
+
+ +
+
+trafficgen.flat2llh(x_n, y_n, lat_0, lon_0, z_n=0.0, height_ref=0.0)
+

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink +library for marine systems.

+

The method computes longitude lon (rad), latitude lat (rad) and height h (m) for the +NED coordinates (xn,yn,zn) using a flat Earth coordinate system defined by the WGS-84 +ellipsoid. The flat Earth coordinate origin is located at (lon_0, lat_0) with reference +height h_ref in meters above the surface of the ellipsoid. Both height and h_ref +are positive upwards, while zn is positive downwards (NED). +Author: Thor I. Fossen +Date: 20 July 2018 +Revisions: 2023-02-04 updates the formulas for latitude and longitude

+
+
Params:

xn: Ship position, north [m] +yn: Ship position, east [m] +zn=0.0: Ship position, down [m] +lat_0, lon_0: Flat earth coordinate located at (lon_0, lat_0) +h_ref=0.0: Flat earth coordinate with reference h_ref in meters above the surface +of the ellipsoid

+
+
+
+
Returns:
+

Latitude [rad] +lon: Longitude [rad] +h: Height [m]

+
+
Return type:
+

lat

+
+
+
+ +
+
+trafficgen.llh2flat(lat, lon, lat_0, lon_0, height=0.0, height_ref=0.0)
+

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink +library for marine systems.

+

The method computes (north, east) for a flat Earth coordinate system from longitude +lon (rad) and latitude lat (rad) of the WGS-84 elipsoid. The flat Earth coordinate +origin is located at (lon_0, lat_0). +Author: Thor I. Fossen +Date: 20 July 2018 +Revisions: 2023-02-04 updates the formulas for latitude and longitude

+
+
Params:

lat: Ship position in latitude [rad] +lon: Ship position in longitude [rad] +h=0.0: Ship height in meters above the surface of the ellipsoid +lat_0, lon_0: Flat earth coordinate located at (lon_0, lat_0) +h_ref=0.0: Flat earth coordinate with reference h_ref in meters above +the surface of the ellipsoid

+
+
+
+
Returns:
+

Ship position, north [m] +y_n: Ship position, east [m] +z_n: Ship position, down [m]

+
+
Return type:
+

x_n

+
+
+
+ +
+
+trafficgen.ssa(angle)
+

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink +library for marine systems.

+

SSA is the “smallest signed angle” or the smallest difference between two +angles. Examples: +angle = ssa(angle) maps an angle in rad to the interval [-pi pi)

+

Author: Thor I. Fossen +Date: 2018-09-21

+
+
Param:

angle: angle given in radius

+
+
+
+
Returns:
+

“smallest signed angle” or the smallest difference between two angles

+
+
Return type:
+

smallest_angle

+
+
+
+ +
+
+trafficgen.write_traffic_situations_to_json_file(traffic_situations, write_folder)
+

Write traffic situations to json file

+
+
Params:

traffic_situations: Traffic situations to be written to file +write_folder: Folder where the json files is to be written

+
+
+
+ +
+
+trafficgen.clean_traffic_situation_data(traffic_situation)
+

Clean traffic situation data to json file

+
+
Params:

traffic_situation: Traffic situation to be cleaned

+
+
+
+
Returns:
+

Cleaned traffic situation

+
+
Return type:
+

traffic_situation

+
+
+
+ +
+
+trafficgen.generate_encounter(desired_encounter_type, own_ship, target_ships, target_ship_id, beta_default, relative_speed_default, vector_time_default, settings)
+

Generates an encounter.

+
+
Params:
    +

  • desired_encounter_type: Desired encounter to be generated

    • +

  • own_ship: Dict, information about own ship that will encounter a target ship

    • +

  • target_ships: List of target ships that may be used in an encounter

    • +

  • target_ship_id: ID which should be used on target ship

    • +

  • beta_default: User defined beta. If not set, this is None.

    • +
  • +
    relative_speed_default: User defined relative speed between own ship and

    target ship. If not set, this is None.

    +
    +
    +
    • +

  • vector_time_default: User defined vector time. If not set, this is None.

    • +

  • settings: Encounter settings

    • +
+
+
+
+
Returns:
+

target ship information, such as initial position, speed and course +encounter_found: 0=encounter not found, 1=encounter found

+
+
Return type:
+

target_ship

+
+
+
+ +
+
+trafficgen.check_encounter_evolvement(own_ship, own_ship_position_future, target_ship, target_ship_position_future, desired_encounter_type, settings)
+

Checks encounter evolvement. The generated encounter should be the same type of +encounter (head-on, crossing, give-way) also some time before the encounter is started.

+
+
Params:
    +

  • own_ship: Own ship information such as initial position, speed and course

    • +

  • target_ship: Target ship information such as initial position, speed and course

    • +

  • desired_encounter_type: Desired type of encounter to be generated

    • +

  • settings: Encounter settings

    • +
+
+
+
+
Returns:
+

    +

  • returns 0 if encounter not ok, 1 if encounter ok

    • +
+

+
+
+
+ +
+
+trafficgen.find_start_position_target_ship(own_ship_position, own_ship_course, target_ship_position_future, target_ship_vector_length, desired_beta, desired_encounter_type, settings)
+

Find start position of target ship using desired beta and vector length.

+
+
Params:
    +

  • own_ship_position: Own ship initial position, speed and course

    • +

  • own_ship_course: Own ship initial course

    • +

  • target_ship_position_future: Target ship future position

    • +

  • target_ship_vector_length: vector length (target ship speed x vector)

    • +

  • desired_beta: Desired bearing between own ship and target ship seen from own ship

    • +

  • desired_encounter_type: Desired type of encounter to be generated

    • +

  • settings: Encounter settings

    • +
+
+
+
+
Returns:
+

Dict, initial position of target ship {north, east} [m] +* start_position_found: 0=position not found, 1=position found

+
+
Return type:
+

    +

  • start_position_target_ship

    • +
+

+
+
+
+ +
+
+trafficgen.assign_future_position_to_target_ship(own_ship_position_future, max_meeting_distance)
+

Randomly assign future position of target ship. If drawing a circle with radius +max_meeting_distance around future position of own ship, future position of +target ship shall be somewhere inside this circle.

+
+
Params:
    +
  • +
    own_ship_position_future: Dict, own ship position at a given time in the

    future, {north, east}

    +
    +
    +
    • +
  • +
    max_meeting_distance: Maximum distance between own ship and target ship at

    a given time in the future [nm]

    +
    +
    +
    • +
+
+
+
+
Returns:
+

Dict, future position of target ship {north, east} [m]

+
+
Return type:
+

future_position_target_ship

+
+
+
+ +
+
+trafficgen.determine_colreg(alpha, beta, theta13_criteria, theta14_criteria, theta15_criteria, theta15)
+

Determines the colreg type based on alpha, relative bearing between target ship and own +ship seen from target ship, and beta, relative bearing between own ship and target ship +seen from own ship.

+
+
Params:
    +

  • alpha: relative bearing between target ship and own ship seen from target ship

    • +

  • beta: relative bearing between own ship and target ship seen from own ship

    • +

  • theta13_criteria: Tolerance for “coming up with” relative bearing

    • +

  • theta14_criteria: Tolerance for “reciprocal or nearly reciprocal courses”, +“when in any doubt… assume… [head-on]”

    • +

  • theta15_criteria: Crossing aspect limit, used for classifying a crossing encounter

    • +
  • +
    theta15: 22.5 deg aft of the beam, used for classifying a crossing and an overtaking

    encounter

    +
    +
    +
    • +
+
+
+
+
Returns:
+

    +

  • encounter classification

    • +
+

+
+
+
+ +
+
+trafficgen.calculate_relative_bearing(position_own_ship, heading_own_ship, position_target_ship, heading_target_ship)
+

Calculates relative bearing between own ship and target ship, both seen from +own ship and seen from target ship.

+
+
Params:
    +

  • position_own_ship: Dict, own ship position {north, east} [m]

    • +

  • heading_own_ship: Own ship course [deg]

    • +

  • position_target_ship: Dict, own ship position {north, east} [m]

    • +

  • heading_target_ship: Target ship course [deg]

    • +
+
+
+
+
Returns:
+

relative bearing between target ship and own ship seen from target ship [deg] +* beta: relative bearing between own ship and target ship seen from own ship [deg]

+
+
Return type:
+

    +

  • alpha

    • +
+

+
+
+
+ +
+
+trafficgen.calculate_ship_course(waypoint_0, waypoint_1)
+

Calculates ship course between two waypoints

+
+
Params:
    +

  • waypoint_0: Dict, waypoint {north, east} [m]

    • +

  • waypoint_1: Dict, waypoint {north, east} [m]

    • +
+
+
+
+
Returns:
+

Ship course [deg]

+
+
Return type:
+

course

+
+
+
+ +
+
+trafficgen.assign_vector_time(setting_vector_time)
+

Randomly (uniform) assigns vector time

+
+
Params:
    +

  • setting_vector_time: Minimum and maximum value for vector time

    • +
+
+
+
+
Returns:
+

Vector time [min]

+
+
Return type:
+

vector_time

+
+
+
+ +
+
+trafficgen.assign_speed_to_target_ship(encounter_type, own_ship_speed, min_target_ship_speed, relative_speed_setting)
+

Randomly (uniform) assigns speed to target ship depending on type of encounter

+
+
Params:
    +

  • encounter_type: Type of encounter

    • +

  • own_ship_speed: Own ship speed [knot]

    • +

  • min_target_ship_speed: Minimum target ship speed [knot]

    • +

  • relative_speed_setting: Relative speed setting dependent on encounter [-]

    • +
+
+
+
+
Returns:
+

Target ship speed [knot]

+
+
Return type:
+

speed_target_ship

+
+
+
+ +
+
+trafficgen.assign_beta(encounter_type, settings)
+

Randomly (uniform) assigns relative bearing beta between own ship +and target ship depending on type of encounter

+
+
Params:
    +

  • encounter_type: Type of encounter

    • +

  • settings: Encounter settings

    • +
+
+
+
+
Returns:
+

Relative bearing between own ship and target ship seen from own ship [deg]

+
+
+
+ +
+
+trafficgen.update_position_data_target_ship(ship, lat_lon_0)
+

Updating position data of the target ship to also include latitude and longitude +position of the target ship

+
+
Params:
    +

  • ship: Target ship data

    • +

  • lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree]

    • +
+
+
+
+
Returns:
+

Updated target ship data

+
+
Return type:
+

ship

+
+
+
+ +
+
+trafficgen.update_position_data_own_ship(ship, lat_lon_0, delta_time)
+

Updating position data of the target ship to also include latitude and longitude +position of the target ship

+
+
Params:
    +

  • ship: Own ship data

    • +

  • lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree]

    • +

  • delta_time: Delta time from now to the time new position is being calculated [minutes]

    • +
+
+
+
+
Returns:
+

Updated own ship data

+
+
Return type:
+

ship

+
+
+
+ +
+
+trafficgen.decide_target_ship(target_ships)
+

Randomly picks a target ship from a dict of target ships

+
+
Params:
    +

  • target_ships: dict of target ships

    • +
+
+
+
+
Returns:
+

The target ship, info of type, size etc.

+
+
+
+ +
+
+trafficgen.plot_traffic_situations(traffic_situations, col, row)
+

Plots the traffic situations in one more figures

+
+
Params:

traffic_situations: Traffic situations to be plotted +col: Number of columns in each figure +row: Number of rows in each figure

+
+
+
+ +
+
+trafficgen.plot_specific_traffic_situation(traffic_situations, situation_number)
+

Plots a specific situation in map

+
+
Params:

traffic_situations: Generated traffic situations +situation_number: The specific situation to be plotted

+
+
+
+ +
+
+trafficgen.read_situation_files(situation_folder)
+

Reads traffic situation files.

+
+
Params:

situation_folder: Path to the folder where situation files are found

+
+
+
+
Returns:
+

List of desired traffic situations

+
+
Return type:
+

situations

+
+
+
+ +
+
+trafficgen.read_own_ship_file(own_ship_file)
+

Reads the own ship file.

+
+
Params:

own_ship_file: Path to the own_ship_file file

+
+
+
+
Returns:
+

own_ship information

+
+
+
+ +
+
+trafficgen.read_target_ship_files(target_ship_folder)
+

Reads target ship files.

+
+
Params:

target_ship_folder: Path to the folder where target ships are found

+
+
+
+
Returns:
+

List of different target ships

+
+
Return type:
+

target_ships

+
+
+
+ +
+
+trafficgen.read_encounter_setting_file(settings_file)
+

Reads the encounter setting file.

+
+
Params:

settings_file: Path to the encounter setting file

+
+
+
+
Returns:
+

Encounter settings

+
+
+
+ +
+
+trafficgen.generate_traffic_situations(situation_folder, own_ship_file, target_ship_folder, settings_file)
+

This is the main function for generating a set of traffic situations using input files +specifying number and type of encounter, type of target ships etc.

+
+
Params:
    +

  • situation_folder: Path to situation folder, files describing the desired situations

    • +

  • target_ship_folder: Path to where different type of target ships is found

    • +

  • settings_file: Path to settings file

    • +
+
+
+
+
Returns:
+

List of generated traffic situations. +One situation may consist of one or more encounters.

+
+
Return type:
+

traffic_situations

+
+
+
+ +
+
+trafficgen.find_value(parameters, parameter)
+

Finds a key, value pair in a dict. If the key is there, +the value is returned. If not, None is returned.

+
+
Params:
    +

  • parameters: Dict of parameters

    • +

  • parameter: Parameter key to look for in parameters

    • +
+
+
+
+
Returns:
+

value of the key parameter

+
+
Return type:
+

value

+
+
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/marine_system_simulator/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/marine_system_simulator/index.html new file mode 100644 index 0000000..39652ab --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/marine_system_simulator/index.html @@ -0,0 +1,255 @@ + + + + + + + trafficgen.marine_system_simulator — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen.marine_system_simulator

+

The Marine Systems Simulator (MSS) is a Matlab and Simulink library for marine systems. It includes +models for ships, underwater vehicles, unmanned surface vehicles, and floating structures. +The library also contains guidance, navigation, and control (GNC) blocks for real-time simulation. +The algorithms are described in:

+

T. I. Fossen (2021). Handbook of Marine Craft Hydrodynamics and Motion Control. 2nd. Edition, +Wiley. ISBN-13: 978-1119575054

+

Parts of the library have been re-implemented in Python and are found below.

+
+

Module Contents

+
+

Functions

+ + + + + + + + + + + + +

flat2llh(x_n, y_n, lat_0, lon_0[, z_n, height_ref])

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink

llh2flat(lat, lon, lat_0, lon_0[, height, height_ref])

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink

ssa(angle)

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink

+
+
+trafficgen.marine_system_simulator.flat2llh(x_n, y_n, lat_0, lon_0, z_n=0.0, height_ref=0.0)
+

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink +library for marine systems.

+

The method computes longitude lon (rad), latitude lat (rad) and height h (m) for the +NED coordinates (xn,yn,zn) using a flat Earth coordinate system defined by the WGS-84 +ellipsoid. The flat Earth coordinate origin is located at (lon_0, lat_0) with reference +height h_ref in meters above the surface of the ellipsoid. Both height and h_ref +are positive upwards, while zn is positive downwards (NED). +Author: Thor I. Fossen +Date: 20 July 2018 +Revisions: 2023-02-04 updates the formulas for latitude and longitude

+
+
Params:

xn: Ship position, north [m] +yn: Ship position, east [m] +zn=0.0: Ship position, down [m] +lat_0, lon_0: Flat earth coordinate located at (lon_0, lat_0) +h_ref=0.0: Flat earth coordinate with reference h_ref in meters above the surface +of the ellipsoid

+
+
+
+
Returns:
+

Latitude [rad] +lon: Longitude [rad] +h: Height [m]

+
+
Return type:
+

lat

+
+
+
+ +
+
+trafficgen.marine_system_simulator.llh2flat(lat, lon, lat_0, lon_0, height=0.0, height_ref=0.0)
+

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink +library for marine systems.

+

The method computes (north, east) for a flat Earth coordinate system from longitude +lon (rad) and latitude lat (rad) of the WGS-84 elipsoid. The flat Earth coordinate +origin is located at (lon_0, lat_0). +Author: Thor I. Fossen +Date: 20 July 2018 +Revisions: 2023-02-04 updates the formulas for latitude and longitude

+
+
Params:

lat: Ship position in latitude [rad] +lon: Ship position in longitude [rad] +h=0.0: Ship height in meters above the surface of the ellipsoid +lat_0, lon_0: Flat earth coordinate located at (lon_0, lat_0) +h_ref=0.0: Flat earth coordinate with reference h_ref in meters above +the surface of the ellipsoid

+
+
+
+
Returns:
+

Ship position, north [m] +y_n: Ship position, east [m] +z_n: Ship position, down [m]

+
+
Return type:
+

x_n

+
+
+
+ +
+
+trafficgen.marine_system_simulator.ssa(angle)
+

Method taken from the MSS (Marine System Simulator) toolbox which is a Matlab/Simulink +library for marine systems.

+

SSA is the “smallest signed angle” or the smallest difference between two +angles. Examples: +angle = ssa(angle) maps an angle in rad to the interval [-pi pi)

+

Author: Thor I. Fossen +Date: 2018-09-21

+
+
Param:

angle: angle given in radius

+
+
+
+
Returns:
+

“smallest signed angle” or the smallest difference between two angles

+
+
Return type:
+

smallest_angle

+
+
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/plot_traffic_situation/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/plot_traffic_situation/index.html new file mode 100644 index 0000000..9f04d84 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/plot_traffic_situation/index.html @@ -0,0 +1,285 @@ + + + + + + + trafficgen.plot_traffic_situation — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen.plot_traffic_situation

+

This module includes functions to prepare and plot traffic situations

+
+

Module Contents

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + +

calculate_vector_arrow(position, direction, ...)

Calculates the arrow with length vector pointing in the direction of ship course

calculate_ship_outline(position, course, lat_lon_0[, ...])

Calculates the outline of the ship pointing in the direction of ship course

plot_specific_traffic_situation(traffic_situations, ...)

Plots a specific situation in map

add_ship_to_map(ship, vector_time, lat_lon_0[, ...])

Adds the ship to the map

plot_traffic_situations(traffic_situations, col, row)

Plots the traffic situations in one more figures

find_max_value_for_plot(ship, max_value)

Finds the maximum deviation from the Reference point in north and east direction

add_ship_to_plot(ship, vector_time[, axes, color])

Adds the ship to the plot

+
+
+trafficgen.plot_traffic_situation.calculate_vector_arrow(position, direction, vector_length, lat_lon_0)
+

Calculates the arrow with length vector pointing in the direction of ship course

+
+
Params:

position: {north}, {east} position of the ship [m] +direction: direction the arrow is pointing [deg] +vector_length: length of vector +lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree]

+
+
+
+
Returns:
+

Polygon points to draw the arrow

+
+
Return type:
+

arrow_points

+
+
+
+ +
+
+trafficgen.plot_traffic_situation.calculate_ship_outline(position, course, lat_lon_0, ship_length=100, ship_width=15)
+

Calculates the outline of the ship pointing in the direction of ship course

+
+
Params:

position: {north}, {east} position of the ship [m] +course: course of the ship [deg] +lat_lon_0: Reference point, latitudinal [degree] and longitudinal [degree] +ship_length: Ship length. If not given, ship length is set to 100 +ship_width: Ship width. If not given, ship width is set to 15

+
+
+
+
Returns:
+

Polygon points to draw the ship

+
+
Return type:
+

ship_outline_points

+
+
+
+ +
+
+trafficgen.plot_traffic_situation.plot_specific_traffic_situation(traffic_situations, situation_number)
+

Plots a specific situation in map

+
+
Params:

traffic_situations: Generated traffic situations +situation_number: The specific situation to be plotted

+
+
+
+ +
+
+trafficgen.plot_traffic_situation.add_ship_to_map(ship, vector_time, lat_lon_0, map_plot=None, color='black')
+

Adds the ship to the map

+
+
Params:

ship: Ship information +vector_time: Vector time [min] +lat_lon_0=Reference point, latitudinal [degree] and longitudinal [degree] +m: Instance of Map. If not set, instance is set to None +color: Color of the ship. If not set, color is ‘black’

+
+
Returns

m: Updated instance of Map.

+
+
+
+ +
+
+trafficgen.plot_traffic_situation.plot_traffic_situations(traffic_situations, col, row)
+

Plots the traffic situations in one more figures

+
+
Params:

traffic_situations: Traffic situations to be plotted +col: Number of columns in each figure +row: Number of rows in each figure

+
+
+
+ +
+
+trafficgen.plot_traffic_situation.find_max_value_for_plot(ship, max_value)
+

Finds the maximum deviation from the Reference point in north and east direction

+
+
Params:

ship: Ship information +max_value: maximum deviation in north, east direction

+
+
+
+
Returns:
+

updated maximum deviation in north, east direction

+
+
Return type:
+

max_value

+
+
+
+ +
+
+trafficgen.plot_traffic_situation.add_ship_to_plot(ship, vector_time, axes=None, color='black')
+

Adds the ship to the plot

+
+
Params:

ship: Ship information +vector_time: Vector time [min] +ax: Instance of figure axis. If not set, instance is set to None +color: Color of the ship. If not set, color is ‘black’

+
+
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/read_files/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/read_files/index.html new file mode 100644 index 0000000..844c859 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/read_files/index.html @@ -0,0 +1,228 @@ + + + + + + + trafficgen.read_files — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen.read_files

+

This module is used to read the files needed to build one or more traffic situations

+
+

Module Contents

+
+

Functions

+ + + + + + + + + + + + + + + +

read_situation_files(situation_folder)

Reads traffic situation files.

read_own_ship_file(own_ship_file)

Reads the own ship file.

read_target_ship_files(target_ship_folder)

Reads target ship files.

read_encounter_setting_file(settings_file)

Reads the encounter setting file.

+
+
+trafficgen.read_files.read_situation_files(situation_folder)
+

Reads traffic situation files.

+
+
Params:

situation_folder: Path to the folder where situation files are found

+
+
+
+
Returns:
+

List of desired traffic situations

+
+
Return type:
+

situations

+
+
+
+ +
+
+trafficgen.read_files.read_own_ship_file(own_ship_file)
+

Reads the own ship file.

+
+
Params:

own_ship_file: Path to the own_ship_file file

+
+
+
+
Returns:
+

own_ship information

+
+
+
+ +
+
+trafficgen.read_files.read_target_ship_files(target_ship_folder)
+

Reads target ship files.

+
+
Params:

target_ship_folder: Path to the folder where target ships are found

+
+
+
+
Returns:
+

List of different target ships

+
+
Return type:
+

target_ships

+
+
+
+ +
+
+trafficgen.read_files.read_encounter_setting_file(settings_file)
+

Reads the encounter setting file.

+
+
Params:

settings_file: Path to the encounter setting file

+
+
+
+
Returns:
+

Encounter settings

+
+
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/ship_traffic_generator/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/ship_traffic_generator/index.html new file mode 100644 index 0000000..5826a68 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/ship_traffic_generator/index.html @@ -0,0 +1,202 @@ + + + + + + + trafficgen.ship_traffic_generator — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen.ship_traffic_generator

+

This is the main module for generating traffic situations

+
+

Module Contents

+
+

Functions

+ + + + + + + + + +

generate_traffic_situations(situation_folder, ...)

This is the main function for generating a set of traffic situations using input files

find_value(parameters, parameter)

Finds a key, value pair in a dict. If the key is there,

+
+
+trafficgen.ship_traffic_generator.generate_traffic_situations(situation_folder, own_ship_file, target_ship_folder, settings_file)
+

This is the main function for generating a set of traffic situations using input files +specifying number and type of encounter, type of target ships etc.

+
+
Params:
    +

  • situation_folder: Path to situation folder, files describing the desired situations

    • +

  • target_ship_folder: Path to where different type of target ships is found

    • +

  • settings_file: Path to settings file

    • +
+
+
+
+
Returns:
+

List of generated traffic situations. +One situation may consist of one or more encounters.

+
+
Return type:
+

traffic_situations

+
+
+
+ +
+
+trafficgen.ship_traffic_generator.find_value(parameters, parameter)
+

Finds a key, value pair in a dict. If the key is there, +the value is returned. If not, None is returned.

+
+
Params:
    +

  • parameters: Dict of parameters

    • +

  • parameter: Parameter key to look for in parameters

    • +
+
+
+
+
Returns:
+

value of the key parameter

+
+
Return type:
+

value

+
+
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/util_methods/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/util_methods/index.html new file mode 100644 index 0000000..55e1db4 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/util_methods/index.html @@ -0,0 +1,345 @@ + + + + + + + trafficgen.util_methods — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen.util_methods

+

This module includes utillities methods that is used by several other functions.

+
+

Module Contents

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

m_pr_min_2_knot(speed_in_m_pr_min)

Convert ship speed in meters pr minutes to knot.

knot_2_m_pr_min(speed_in_knot)

Convert ship speed in knot to meters pr minutes.

m2nm(length_in_m)

Convert length given in meters to length given in nautical miles.

nm_2_m(val)

Convert length given in nautical miles to length given in meters.

deg_2_rad(angle_in_degrees)

Convert angle given in degrees to angle give in radians.

rad_2_deg(angle_in_radians)

Convert angle given in radians to angle give in degrees.

convert_angle_minus_180_to_180_to_0_to_360(angle_180)

Convert an angle given in the region -180 to 180 degrees to an

convert_angle_0_to_360_to_minus_180_to_180(angle_360)

Convert an angle given in the region 0 to 360 degrees to an

calculate_position_at_certain_time(position, speed, ...)

Calculates the position of the ship at a given time based on initial position

+
+
+trafficgen.util_methods.m_pr_min_2_knot(speed_in_m_pr_min)
+

Convert ship speed in meters pr minutes to knot.

+
+
Params:

speed_in_m_pr_min: Ship speed in meters pr second

+
+
+
+
Returns:
+

Ship speed given in knots

+
+
Return type:
+

speed_in_knot

+
+
+
+ +
+
+trafficgen.util_methods.knot_2_m_pr_min(speed_in_knot)
+

Convert ship speed in knot to meters pr minutes.

+
+
Params:

speed_in_knot: Ship speed given in knots

+
+
+
+
Returns:
+

Ship speed in meters pr minutes

+
+
Return type:
+

speed_in_m_pr_min

+
+
+
+ +
+
+trafficgen.util_methods.m2nm(length_in_m)
+

Convert length given in meters to length given in nautical miles.

+
+
Params:

length_in_m: Length given in meters

+
+
+
+
Returns:
+

Length given in nautical miles

+
+
Return type:
+

length_in_nm

+
+
+
+ +
+
+trafficgen.util_methods.nm_2_m(val)
+

Convert length given in nautical miles to length given in meters.

+
+
Params:

length_in_nm: Length given in nautical miles

+
+
+
+
Returns:
+

Length given in meters

+
+
Return type:
+

length_in_m

+
+
+
+ +
+
+trafficgen.util_methods.deg_2_rad(angle_in_degrees)
+

Convert angle given in degrees to angle give in radians.

+
+
Params:

angle_in_degrees: Angle given in degrees

+
+
+
+
Returns:
+

Angle given in radians

+
+
Return type:
+

angle given in radians

+
+
+
+ +
+
+trafficgen.util_methods.rad_2_deg(angle_in_radians)
+

Convert angle given in radians to angle give in degrees.

+
+
Params:

angle_in_degrees: Angle given in degrees

+
+
+
+
Returns:
+

Angle given in radians

+
+
Return type:
+

angle given in radians

+
+
+
+ +
+
+trafficgen.util_methods.convert_angle_minus_180_to_180_to_0_to_360(angle_180)
+

Convert an angle given in the region -180 to 180 degrees to an +angle given in the region 0 to 360 degrees

+
+
Params:

angle_180: Angle given in the region -180 to 180 degrees

+
+
+
+
Returns:
+

Angle given in the region 0 to 360 degrees

+
+
Return type:
+

angle_360

+
+
+
+ +
+
+trafficgen.util_methods.convert_angle_0_to_360_to_minus_180_to_180(angle_360)
+

Convert an angle given in the region 0 to 360 degrees to an +angle given in the region -180 to 180 degrees

+
+
Params:

angle_360: Angle given in the region 0 to 360 degrees

+
+
+
+
Returns:
+

Angle given in the region -180 to 180 degrees

+
+
Return type:
+

angle_180

+
+
+
+ +
+
+trafficgen.util_methods.calculate_position_at_certain_time(position, speed, course, delta_time)
+

Calculates the position of the ship at a given time based on initial position +and delta time, and constand speed and course.

+
+
Params:

position: Initial ship position [m] +speed: Ship speed [knot] +course: Ship course [deg] +delta_time: Delta time from now to the time new position is being calculated [minutes]

+
+
+
+
Returns:
+

Dict, north and east position given in meters

+
+
Return type:
+

position{north, east}

+
+
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/write_traffic_situation_to_file/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/write_traffic_situation_to_file/index.html new file mode 100644 index 0000000..7228b66 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/api/trafficgen/write_traffic_situation_to_file/index.html @@ -0,0 +1,183 @@ + + + + + + + trafficgen.write_traffic_situation_to_file — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen.write_traffic_situation_to_file

+

This module cleans traffic situations data before writing it to json-file.

+
+

Module Contents

+
+

Functions

+ + + + + + + + + +

write_traffic_situations_to_json_file(...)

Write traffic situations to json file

clean_traffic_situation_data(traffic_situation)

Clean traffic situation data to json file

+
+
+trafficgen.write_traffic_situation_to_file.write_traffic_situations_to_json_file(traffic_situations, write_folder)
+

Write traffic situations to json file

+
+
Params:

traffic_situations: Traffic situations to be written to file +write_folder: Folder where the json files is to be written

+
+
+
+ +
+
+trafficgen.write_traffic_situation_to_file.clean_traffic_situation_data(traffic_situation)
+

Clean traffic situation data to json file

+
+
Params:

traffic_situation: Traffic situation to be cleaned

+
+
+
+
Returns:
+

Cleaned traffic situation

+
+
Return type:
+

traffic_situation

+
+
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/authors.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/authors.html new file mode 100644 index 0000000..9aef60a --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/authors.html @@ -0,0 +1,135 @@ + + + + + + + Authors — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Authors

+
+

Primary author

+

Tom Arne Pedersen +Tom.Arne.Pedersen@dnv.com

+
+
+

Testers

+
    +

  • Grunde Løvoll

    • +

  • Stephanie Kemna

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/contributing.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/contributing.html new file mode 100644 index 0000000..5bf149d --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/contributing.html @@ -0,0 +1,254 @@ + + + + + + + Contributing — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Contributing

+

Contributions are welcome, and they are greatly appreciated! Every little bit +helps, and credit will always be given.

+

You can contribute in many ways:

+
+

Types of Contributions

+
+

Report Bugs

+

Report bugs at https://github.com/dnv-opensource/ship-traffic-generator/issues.

+

If you are reporting a bug, please include:

+
    +

  • Your operating system name and version.

    • +

  • The version of Python (and Conda) that you are using.

    • +

  • Any additional details about your local setup that might be helpful in troubleshooting.

    • +

  • Detailed steps to reproduce the bug.

    • +
+
+
+

Fix Bugs

+

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help +wanted” is open to whoever wants to implement it.

+
+
+

Implement Features

+

Look through the GitHub issues for features. Anything tagged with “enhancement” +and “help wanted” is open to whoever wants to implement it.

+
+
+

Write Documentation

+

Traffic Generator could always use more documentation, whether as part of the +official Traffic Generator docs, in docstrings, or even on the web in blog posts, +articles, and such.

+
+
+

Submit Feedback

+

The best way to send feedback is to file an issue at https://github.com/dnv-opensource/ship-traffic-generator/issues.

+

If you are proposing a feature:

+
    +

  • Explain in detail how it would work.

    • +

  • Keep the scope as narrow as possible, to make it easier to implement.

    • +

  • Remember that this is a volunteer-driven project, and that contributions +are welcome :)

    • +
+
+
+
+

Get Started!

+

Ready to contribute? Here’s how to set up trafficgen for local development.

+
    +

  1. Clone the trafficgen repo on GitHub.

    2. +

  2. Install your local copy into a pyenv or conda environment.

    3. +

  3. Create a branch for local development:

    +
    $ git checkout -b name-of-your-bugfix-or-feature
+
    +
    +

    Now you can make your changes locally.

    +
    4. +

  4. When you’re done making changes, check that your changes pass flake8 and the +tests, including testing other Python versions with tox:

    +
    $ flake8 --config tox.ini ./src/trafficgen ./tests
+$ pytest ./tests
+$ tox
+
    +
    +

    If you installed the package with poetry

    +
    +

    $ poetry install –with dev,docs

    +
    +

    flake8, pytest and tox should already be installed in your Python environment. +Note that the tox config assumes Python 3.10 and Python 3.11, you would have +to have them both available to tox for all tests to run. +If you only have one of these available tox will skip the non supported +environment (and in most cases that is OK). +If you are managing your Python enhancements with pyenv you will have to +install the necessary versions and then run pyenv rehash to make them +available to tox (or set multiple local envs with pyenv local py310 py311). +If you are using conda you will have to create a new environment with +the necessary Python version, install virtualenv in the environments +and then run conda activate <env-name> to make it available to tox (to run all +the environments in one go do conda activate inside activated environments).

    +

    You can also run the python tests from VSCode via the “Testing” view, +“Configure Python Tests”, with pytest` and select the folder tests.

    +
    5. +

  5. Commit your changes and push your branch to the source repo:

    +
    $ git add .
+$ git commit -m "Your detailed description of your changes."
+$ git push origin name-of-your-bugfix-or-feature
+
    +
    +
    6. +

  6. Submit a pull request through https://github.com/dnv-opensource/ship-traffic-generator/pulls.

    7. +
+
+
+

Pull Request Guidelines

+

Before you submit a pull request, check that it meets these guidelines:

+
    +

  1. The pull request should include tests.

    2. +

  2. If the pull request adds functionality, the docs should be updated. Put +your new functionality into a function with a docstring, and add the +feature to the list in README.md.

    3. +

  3. The pull request should work for Python 3.10.

    4. +
+
+
+

Tips

+

To run a subset of tests:

+
$ pytest tests.test_trafficgen
+
+
+
+
+

Deploying

+

A reminder for the maintainers on how to deploy. +Make sure all your changes are committed (including an entry in HISTORY.rst). +Then run:

+
$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/genindex.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/genindex.html new file mode 100644 index 0000000..15c7b68 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/genindex.html @@ -0,0 +1,588 @@ + + + + + + Index — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Index
    • +
  • +
    • +
+
+
+
+
+ + +

Index

+ +
+ A + | C + | D + | F + | G + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + | W + +
+

A

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

K

+ + +
+ +

L

+ + + +
+ +

M

+ + +
+ +

N

+ + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
    +
  • + trafficgen.plot_traffic_situation + +
    • +
  • + trafficgen.read_files + +
    • +
  • + trafficgen.ship_traffic_generator + +
    • +
  • + trafficgen.util_methods + +
    • +
  • + trafficgen.write_traffic_situation_to_file + +
    • +
+ +

U

+ + + +
+ +

W

+ + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2023, DNV, Tom Arne Pedersen.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/history.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/history.html new file mode 100644 index 0000000..3fa4bfc --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/history.html @@ -0,0 +1,128 @@ + + + + + + + History — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

History

+
+

0.1.0 (2023-11-08)

+
    +

  • First release on PyPI.

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/index.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/index.html new file mode 100644 index 0000000..7ec42f1 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/index.html @@ -0,0 +1,169 @@ + + + + + + + Welcome to Traffic Generator’s documentation! — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Welcome to Traffic Generator’s documentation!

+

The tool generates a structured set of encounters for verifying automatic collision and +grounding avoidance systems. Based on input parameters such as desired situation, relative speed, +relative bearing etc, the tool will generate a set of traffic situations. The traffic situations +may be written to files and/or inspected using plots.

+

A paper is written describing the background for +the tool and how it works.

+
+

Contents:

+ +
+
+
+

Indices and tables

+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/input_files.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/input_files.html new file mode 100644 index 0000000..e2cf81a --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/input_files.html @@ -0,0 +1,206 @@ + + + + + + + Input files — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Input files

+

Example 1: Complete specified situation:

+
{
+    "title": "HO",
+    "common_vector": 10.0,
+    "own_ship": {
+        "speed": 10.0,
+        "course": 0.0,
+        "position": {
+            "north": 0.0,
+            "east": 0.0
+        }
+    },
+    "encounter": [
+        {
+        "desired_encounter_type": "head-on",
+        "beta": 2.0,
+        "relative_speed": 1.2,
+        "vector_time": 15.0
+        }
+    ]
+}
+
+
+

The common_vector is given in minutes. For radar plotting (plotting vessel positions and relative motions), +the common_vector and vector_time are used together with ship speed to display where the ship will be in e.g. 10 minutes +(Common vector is the common time vector used on a radar plot, e.g 10, 15, 20 minutes. The length of the arrow in the plot +will then be the speed times this time vector). +Speed and course of the own ship, which is the ship to be tested, are given in knots and degrees, respectively. +The own ship position is given in meters from the reference points, which are defined in latitudinal [degree] and longitudinal [degree]. +The global reference point is defined in src/trafficgen/settings/encounter_settings.json.

+

An encounter may be fully described as shown above, but the user may also deside to input less data, +as demonstrated in Example 2. Desired encounter type is mandatory, +while the beta, relative_speed and vector_time parameters are optional:

+
+
    +

  • desired_encounter_type is either head-on, overtaking-give-way, overtaking-stand-on, crossing-give-way, and crossing-stand-on.

    • +

  • beta is the relative bearing between the own ship and the target ship as seen from the own shop, given in degrees.

    • +

  • relative_speed is relative speed between the own ship and the target ship as seen from the own ship, such that a relative speed of 1.2 means that the target ship’s speed is 20% higher than the speed of the own ship.

    • +
+
+

An encounter is built using a maximum meeting distance [nm], see the paper linked in the introduction for more info. +At some time in the future, given by the vector_time, the target ship will be located somewhere inside a circle +with a radius given by max_meeting_distance and a center point given by the own ship position. This is not necessarily the +closest point of approach.

+

The max_meeting_distance parameter is common for all encounters and is specified in src/trafficgen/settings/encounter_settings.json.

+

Example 2: Minimum specified situation:

+
{
+    "title": "HO",
+    "common_vector": 10.0,
+    "own_ship": {
+        "speed": 10.0,
+        "course": 0.0,
+        "position": {
+            "north": 0.0,
+            "east": 0.0
+        }
+    },
+    "encounter": [
+        {
+        "desired_encounter_type": "head-on"
+        }
+    ]
+}
+
+
+

You can also request the generation of several traffic situations of the same encounter type by specifying num_situations:

+

Example 3: Generate multiple situations using num_situations:

+
{
+    "title": "OT_GW",
+    "common_vector": 10.0,
+    "own_ship": {
+        "speed": 7.0,
+        "course": 0.0,
+        "position": {
+            "north": 0.0,
+            "east": 0.0
+        }
+    },
+    "num_situations": 5,
+    "encounter": [
+        {
+        "desired_encounter_type": "overtaking-give-way"
+        }
+    ]
+}
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/installation.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/installation.html new file mode 100644 index 0000000..6b4ba17 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/installation.html @@ -0,0 +1,145 @@ + + + + + + + Installation — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Installation

+
+

Stable release

+

To install Traffic Generator, run this command in your terminal:

+
$ pip install trafficgen
+
+
+

This is the preferred method to install Traffic Generator, as it will always install the most recent stable release.

+

If you don’t have pip installed, this Python installation guide can guide +you through the process.

+
+
+

From sources

+

The sources for Traffic Generator can be downloaded from the https://github.com/dnv-opensource/ship-traffic-generator.

+

You can either clone the public repository:

+
$ git clone https://github.com/dnv-opensource/ship-traffic-generator
+
+
+

Once you have a copy of the source, you can install it with:

+
$ python setup.py install
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/modules.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/modules.html new file mode 100644 index 0000000..94ae102 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/modules.html @@ -0,0 +1,132 @@ + + + + + + + trafficgen — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+ +
+
+ +
+ +
+

© Copyright 2023, DNV, Tom Arne Pedersen.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/objects.inv b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/objects.inv new file mode 100644 index 0000000..32af1ae Binary files /dev/null and b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/objects.inv differ diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/py-modindex.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/py-modindex.html new file mode 100644 index 0000000..817cc5f --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/py-modindex.html @@ -0,0 +1,175 @@ + + + + + + Python Module Index — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Python Module Index
    • +
  • +
    • +
+
+
+
+
+ + +

Python Module Index

+ +
+ t +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ t
+ trafficgen +
    + trafficgen.check_land_crossing +
    + trafficgen.cli +
    + trafficgen.encounter +
    + trafficgen.marine_system_simulator +
    + trafficgen.plot_traffic_situation +
    + trafficgen.read_files +
    + trafficgen.ship_traffic_generator +
    + trafficgen.util_methods +
    + trafficgen.write_traffic_situation_to_file +
+ + +
+
+
+ +
+ +
+

© Copyright 2023, DNV, Tom Arne Pedersen.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/search.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/search.html new file mode 100644 index 0000000..d086bad --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/search.html @@ -0,0 +1,130 @@ + + + + + + Search — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2023, DNV, Tom Arne Pedersen.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/searchindex.js b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/searchindex.js new file mode 100644 index 0000000..4253817 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["api/index", "api/trafficgen/check_land_crossing/index", "api/trafficgen/cli/index", "api/trafficgen/encounter/index", "api/trafficgen/index", "api/trafficgen/marine_system_simulator/index", "api/trafficgen/plot_traffic_situation/index", "api/trafficgen/read_files/index", "api/trafficgen/ship_traffic_generator/index", "api/trafficgen/util_methods/index", "api/trafficgen/write_traffic_situation_to_file/index", "authors", "contributing", "history", "index", "input_files", "installation", "modules", "trafficgen", "usage"], "filenames": ["api/index.rst", "api/trafficgen/check_land_crossing/index.rst", "api/trafficgen/cli/index.rst", "api/trafficgen/encounter/index.rst", "api/trafficgen/index.rst", "api/trafficgen/marine_system_simulator/index.rst", "api/trafficgen/plot_traffic_situation/index.rst", "api/trafficgen/read_files/index.rst", "api/trafficgen/ship_traffic_generator/index.rst", "api/trafficgen/util_methods/index.rst", "api/trafficgen/write_traffic_situation_to_file/index.rst", "authors.rst", "contributing.rst", "history.rst", "index.rst", "input_files.rst", "installation.rst", "modules.rst", "trafficgen.rst", "usage.rst"], "titles": ["API Reference", "trafficgen.check_land_crossing", "trafficgen.cli", "trafficgen.encounter", "trafficgen", "trafficgen.marine_system_simulator", "trafficgen.plot_traffic_situation", "trafficgen.read_files", "trafficgen.ship_traffic_generator", "trafficgen.util_methods", "trafficgen.write_traffic_situation_to_file", "Authors", "Contributing", "History", "Welcome to Traffic Generator\u2019s documentation!", "Input files", "Installation", "trafficgen", "trafficgen package", "Usage"], "terms": {"thi": [0, 1, 3, 4, 6, 7, 8, 9, 10, 12, 15, 16, 19], "page": [0, 14], "contain": [0, 5], "auto": 0, "gener": [0, 1, 3, 4, 6, 8, 12, 15, 16], "document": 0, "1": [0, 3, 4, 14, 15, 19], "trafficgen": [0, 12, 14, 15, 16, 19], "check_land_cross": [0, 4, 17], "cli": [0, 4, 17], "encount": [0, 4, 7, 8, 14, 15, 17, 19], "marine_system_simul": [0, 4, 17], "plot_traffic_situ": [0, 4, 17], "read_fil": [0, 4, 17], "ship_traffic_gener": [0, 4, 17], "util_method": [0, 4, 17], "write_traffic_situation_to_fil": [0, 4, 17], "creat": [0, 12], "sphinx": 0, "autoapi": 0, "find": [1, 3, 4, 6, 8], "path": [1, 4, 7, 8, 19], "i": [1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 15, 16, 19], "cross": [1, 3, 4, 15, 19], "land": 1, "path_crosses_land": 1, "position_1": 1, "speed": [1, 3, 4, 9, 14, 15], "cours": [1, 3, 4, 6, 9, 15], "lat_lon_0": [1, 3, 4, 6], "time_interv": 1, "50": 1, "param": [1, 3, 4, 5, 6, 7, 8, 9, 10], "ship": [1, 3, 4, 5, 6, 7, 8, 9, 12, 15, 16, 19], "posit": [1, 3, 4, 5, 6, 9, 15], "north": [1, 3, 4, 5, 6, 9, 15], "east": [1, 3, 4, 5, 6, 9, 15], "m": [1, 3, 4, 5, 6, 9, 12], "knot": [1, 3, 4, 9, 15], "degre": [1, 3, 4, 6, 9, 15], "refer": [1, 3, 4, 5, 6, 14, 15], "point": [1, 3, 4, 6, 15], "latitudin": [1, 3, 4, 6, 15], "longitudin": [1, 3, 4, 6, 15], "The": [1, 3, 4, 5, 6, 12, 14, 15, 16, 19], "time": [1, 3, 4, 5, 6, 9, 15], "interv": [1, 4, 5], "vessel": [1, 15], "should": [1, 3, 4, 12], "travel": 1, "without": [1, 19], "minut": [1, 3, 4, 9, 15], "return": [1, 3, 4, 5, 6, 7, 8, 9, 10], "true": 1, "part": [1, 5, 12], "type": [1, 3, 4, 5, 6, 7, 8, 9, 10, 14, 15], "is_on_land": 1, "packag": [2, 12, 17], "logger": 2, "default_data_path": 2, "sit_fold": 2, "own_ship_fil": [2, 4, 7, 8], "target_ship_fold": [2, 4, 7, 8], "settings_fil": [2, 4, 7, 8], "output_fold": 2, "main": [2, 4, 8], "arg": 2, "none": [2, 3, 4, 6, 8, 19], "gen_situ": 2, "situat": [2, 3, 4, 6, 7, 8, 10, 14, 15], "own_ship": [2, 3, 4, 7, 15], "target": [2, 3, 4, 7, 8, 15, 19], "set": [2, 3, 4, 6, 7, 8, 12, 14, 15, 19], "visual": [2, 19], "col": [2, 4, 6, 19], "row": [2, 4, 6, 19], "visualize_situ": 2, "output": [2, 19], "consol": 2, "script": 2, "exampl": [2, 4, 5, 15, 19], "gen": [2, 19], "": [2, 12, 15, 19], "data": [2, 3, 4, 10, 15, 19], "example_situations_input": [2, 19], "o": [2, 19], "test_output_1": [2, 19], "consist": [3, 4, 8], "one": [3, 4, 6, 7, 8, 12, 19], "own": [3, 4, 7, 15], "mani": [3, 12], "mai": [3, 4, 8, 14, 15, 19], "head": [3, 4, 15, 19], "overtak": [3, 4, 15, 19], "give": [3, 4, 9, 15, 19], "wai": [3, 4, 12, 15, 19], "stand": [3, 15, 19], "generate_encount": [3, 4], "desired_encounter_typ": [3, 4, 15], "target_ship": [3, 4, 7, 19], "target_ship_id": [3, 4], "beta_default": [3, 4], "relative_speed_default": [3, 4], "vector_time_default": [3, 4], "an": [3, 4, 5, 9, 12, 15, 19], "desir": [3, 4, 7, 8, 14, 15, 19], "dict": [3, 4, 8, 9], "inform": [3, 4, 6, 7], "about": [3, 4, 12], "list": [3, 4, 7, 8, 12], "us": [3, 4, 5, 7, 8, 9, 12, 14, 15, 19], "id": [3, 4], "which": [3, 4, 5, 15, 19], "user": [3, 4, 15], "defin": [3, 4, 5, 15], "beta": [3, 4, 15], "If": [3, 4, 6, 8, 12, 16], "rel": [3, 4, 14, 15], "between": [3, 4, 5, 15], "vector": [3, 4, 6, 15], "initi": [3, 4, 9], "encounter_found": [3, 4], "0": [3, 4, 5, 9, 14, 15], "found": [3, 4, 5, 7, 8, 19], "check_encounter_evolv": [3, 4], "own_ship_position_futur": [3, 4], "target_ship_position_futur": [3, 4], "check": [3, 4, 12], "evolv": [3, 4], "same": [3, 4, 15], "also": [3, 4, 5, 12, 15], "some": [3, 4, 15], "befor": [3, 4, 10, 12], "start": [3, 4, 14], "ok": [3, 4, 12], "calculate_min_vector_length_target_ship": 3, "own_ship_posit": [3, 4], "own_ship_cours": [3, 4], "desired_beta": [3, 4], "calcul": [3, 4, 6, 9], "minimum": [3, 4, 15], "length": [3, 4, 6, 9, 15], "x": [3, 4], "ensur": 3, "high": 3, "enough": 3, "proper": 3, "futur": [3, 4, 15], "bear": [3, 4, 14, 15], "min_vector_length": 3, "find_start_position_target_ship": [3, 4], "target_ship_vector_length": [3, 4], "seen": [3, 4, 15], "from": [3, 4, 5, 6, 9, 12, 14, 15], "start_position_found": [3, 4], "start_position_target_ship": [3, 4], "assign_future_position_to_target_ship": [3, 4], "max_meeting_dist": [3, 4, 15], "randomli": [3, 4], "assign": [3, 4], "draw": [3, 4, 6], "circl": [3, 4, 15], "radiu": [3, 4, 5, 15], "around": [3, 4], "shall": [3, 4], "somewher": [3, 4, 15], "insid": [3, 4, 12, 15], "given": [3, 4, 5, 6, 9, 12, 15], "maximum": [3, 4, 6, 15], "distanc": [3, 4, 15], "nm": [3, 4, 15], "future_position_target_ship": [3, 4], "determine_colreg": [3, 4], "alpha": [3, 4], "theta13_criteria": [3, 4], "theta14_criteria": [3, 4], "theta15_criteria": [3, 4], "theta15": [3, 4], "determin": [3, 4], "colreg": [3, 4], "base": [3, 4, 9, 14], "toler": [3, 4], "come": [3, 4], "up": [3, 4, 12, 19], "reciproc": [3, 4], "nearli": [3, 4], "when": [3, 4, 12, 19], "ani": [3, 4, 12], "doubt": [3, 4], "assum": [3, 4, 12], "aspect": [3, 4], "limit": [3, 4], "classifi": [3, 4], "22": [3, 4], "5": [3, 4, 15], "deg": [3, 4, 6, 9], "aft": [3, 4], "beam": [3, 4], "classif": [3, 4], "calculate_relative_bear": [3, 4], "position_own_ship": [3, 4], "heading_own_ship": [3, 4], "position_target_ship": [3, 4], "heading_target_ship": [3, 4], "both": [3, 4, 5, 12], "calculate_ship_cours": [3, 4], "waypoint_0": [3, 4], "waypoint_1": [3, 4], "two": [3, 4, 5], "waypoint": [3, 4], "assign_vector_tim": [3, 4], "setting_vector_tim": [3, 4], "uniform": [3, 4], "valu": [3, 4, 8, 19], "min": [3, 4, 6], "vector_tim": [3, 4, 6, 15], "assign_speed_to_target_ship": [3, 4], "encounter_typ": [3, 4], "own_ship_spe": [3, 4], "min_target_ship_spe": [3, 4], "relative_speed_set": [3, 4], "depend": [3, 4], "speed_target_ship": [3, 4], "assign_beta": [3, 4], "update_position_data_target_ship": [3, 4], "updat": [3, 4, 5, 6, 12], "includ": [3, 4, 5, 6, 9, 12], "latitud": [3, 4, 5], "longitud": [3, 4, 5], "update_position_data_own_ship": [3, 4], "delta_tim": [3, 4, 9], "delta": [3, 4, 9], "now": [3, 4, 9, 12], "new": [3, 4, 9, 12], "being": [3, 4, 9], "decide_target_ship": [3, 4], "pick": [3, 4], "info": [3, 4, 15], "size": [3, 4], "etc": [3, 4, 8, 14], "top": 4, "level": 4, "traffic": [4, 6, 7, 8, 10, 12, 15, 16], "knot_2_m_pr_min": [4, 9], "speed_in_knot": [4, 9], "convert": [4, 9], "meter": [4, 5, 9, 15], "pr": [4, 9], "speed_in_m_pr_min": [4, 9], "m_pr_min_2_knot": [4, 9], "second": [4, 9], "m2nm": [4, 9], "length_in_m": [4, 9], "nautic": [4, 9], "mile": [4, 9], "length_in_nm": [4, 9], "nm_2_m": [4, 9], "val": [4, 9], "deg_2_rad": [4, 9], "angle_in_degre": [4, 9], "angl": [4, 5, 9], "radian": [4, 9], "rad_2_deg": [4, 9], "angle_in_radian": [4, 9], "convert_angle_minus_180_to_180_to_0_to_360": [4, 9], "angle_180": [4, 9], "region": [4, 9], "180": [4, 9], "360": [4, 9], "angle_360": [4, 9], "convert_angle_0_to_360_to_minus_180_to_180": [4, 9], "calculate_position_at_certain_tim": [4, 9], "constand": [4, 9], "flat2llh": [4, 5], "x_n": [4, 5], "y_n": [4, 5], "lat_0": [4, 5], "lon_0": [4, 5], "z_n": [4, 5], "height_ref": [4, 5], "method": [4, 5, 9, 16], "taken": [4, 5], "mss": [4, 5], "marin": [4, 5], "system": [4, 5, 12, 14], "simul": [4, 5], "toolbox": [4, 5], "matlab": [4, 5], "simulink": [4, 5], "librari": [4, 5], "comput": [4, 5], "lon": [4, 5], "rad": [4, 5], "lat": [4, 5], "height": [4, 5], "h": [4, 5], "ned": [4, 5], "coordin": [4, 5], "xn": [4, 5], "yn": [4, 5], "zn": [4, 5], "flat": [4, 5], "earth": [4, 5], "wg": [4, 5], "84": [4, 5], "ellipsoid": [4, 5], "origin": [4, 5, 12], "locat": [4, 5, 15], "h_ref": [4, 5], "abov": [4, 5, 15], "surfac": [4, 5], "ar": [4, 5, 7, 12, 15, 19], "upward": [4, 5], "while": [4, 5, 15], "downward": [4, 5], "author": [4, 5, 14], "thor": [4, 5], "fossen": [4, 5], "date": [4, 5], "20": [4, 5, 15], "juli": [4, 5], "2018": [4, 5], "revis": [4, 5], "2023": [4, 5, 14], "02": [4, 5], "04": [4, 5], "formula": [4, 5], "down": [4, 5], "llh2flat": [4, 5], "elipsoid": [4, 5], "ssa": [4, 5], "smallest": [4, 5], "sign": [4, 5], "differ": [4, 5, 7, 8, 19], "map": [4, 5, 6], "pi": [4, 5], "09": [4, 5], "21": [4, 5], "smallest_angl": [4, 5], "write_traffic_situations_to_json_fil": [4, 10], "traffic_situ": [4, 6, 8, 10], "write_fold": [4, 10], "write": [4, 10, 19], "json": [4, 10, 15, 19], "file": [4, 7, 8, 10, 12, 14, 19], "written": [4, 10, 14], "folder": [4, 7, 8, 10, 12, 19], "where": [4, 7, 8, 10, 15, 19], "clean_traffic_situation_data": [4, 10], "clean": [4, 10], "plot": [4, 6, 14, 15], "more": [4, 6, 7, 8, 12, 15, 19], "figur": [4, 6, 19], "number": [4, 6, 8, 19], "column": [4, 6, 19], "each": [4, 6], "plot_specific_traffic_situ": [4, 6], "situation_numb": [4, 6], "specif": [4, 6, 19], "read_situation_fil": [4, 7], "situation_fold": [4, 7, 8], "read": [4, 7], "read_own_ship_fil": [4, 7], "read_target_ship_fil": [4, 7], "read_encounter_setting_fil": [4, 7], "generate_traffic_situ": [4, 8], "input": [4, 8, 14, 19], "specifi": [4, 8, 15, 19], "describ": [4, 5, 8, 14, 15], "One": [4, 8], "find_valu": [4, 8], "paramet": [4, 8, 14, 15], "kei": [4, 8], "pair": [4, 8], "look": [4, 8, 12], "It": 5, "model": 5, "underwat": 5, "vehicl": 5, "unman": 5, "float": 5, "structur": [5, 14], "guidanc": 5, "navig": 5, "control": 5, "gnc": 5, "block": 5, "real": 5, "algorithm": 5, "t": [5, 16, 19], "2021": 5, "handbook": 5, "craft": 5, "hydrodynam": 5, "motion": [5, 15], "2nd": 5, "edit": 5, "wilei": 5, "isbn": 5, "13": 5, "978": 5, "1119575054": 5, "have": [5, 12, 16], "been": 5, "re": [5, 12], "implement": 5, "python": [5, 12, 16], "below": 5, "prepar": 6, "calculate_vector_arrow": 6, "direct": 6, "vector_length": 6, "arrow": [6, 15], "polygon": 6, "arrow_point": 6, "calculate_ship_outlin": 6, "ship_length": 6, "100": 6, "ship_width": 6, "15": [6, 15], "outlin": 6, "width": 6, "ship_outline_point": 6, "add_ship_to_map": 6, "map_plot": 6, "color": 6, "black": 6, "add": [6, 12], "instanc": 6, "find_max_value_for_plot": 6, "max_valu": 6, "deviat": 6, "add_ship_to_plot": 6, "ax": 6, "axi": 6, "need": [7, 19], "build": 7, "util": 9, "sever": [9, 15], "other": [9, 12], "tom": 11, "arn": 11, "pedersen": 11, "dnv": [11, 12, 16], "com": [11, 12, 16], "grund": 11, "l\u00f8voll": 11, "stephani": 11, "kemna": 11, "welcom": 12, "thei": 12, "greatli": 12, "appreci": 12, "everi": 12, "littl": 12, "bit": 12, "help": [12, 19], "credit": 12, "alwai": [12, 16], "you": [12, 15, 16, 19], "can": [12, 15, 16, 19], "http": [12, 16], "github": [12, 16], "opensourc": [12, 16], "issu": 12, "pleas": 12, "your": [12, 16], "oper": 12, "name": 12, "version": 12, "conda": 12, "addit": 12, "detail": 12, "local": 12, "setup": [12, 16], "might": 12, "troubleshoot": 12, "step": 12, "reproduc": 12, "through": [12, 16], "anyth": 12, "tag": 12, "want": 12, "open": [12, 19], "whoever": 12, "enhanc": 12, "could": 12, "whether": 12, "offici": 12, "doc": 12, "docstr": 12, "even": 12, "web": 12, "blog": 12, "post": 12, "articl": 12, "best": 12, "send": 12, "propos": 12, "explain": 12, "how": [12, 14], "would": 12, "work": [12, 14], "keep": 12, "scope": 12, "narrow": 12, "possibl": 12, "make": 12, "easier": 12, "rememb": 12, "volunt": 12, "driven": 12, "project": [12, 19], "readi": 12, "here": 12, "develop": 12, "clone": [12, 16], "repo": 12, "instal": [12, 14], "copi": [12, 16], "pyenv": 12, "environ": 12, "branch": 12, "git": [12, 16], "checkout": 12, "b": 12, "bugfix": 12, "chang": 12, "done": 12, "pass": 12, "flake8": 12, "test": [12, 15], "tox": 12, "config": 12, "ini": 12, "src": [12, 15], "pytest": 12, "poetri": 12, "dev": 12, "alreadi": 12, "note": [12, 19], "3": [12, 15, 19], "10": [12, 15, 19], "11": [12, 14], "them": 12, "avail": 12, "all": [12, 15], "run": [12, 16], "onli": 12, "skip": 12, "non": 12, "support": 12, "most": [12, 16], "case": 12, "manag": 12, "necessari": 12, "rehash": 12, "multipl": [12, 15], "env": 12, "py310": 12, "py311": 12, "virtualenv": 12, "activ": 12, "go": 12, "do": 12, "vscode": 12, "via": 12, "view": 12, "configur": [12, 19], "select": 12, "commit": 12, "push": 12, "sourc": [12, 14], "descript": 12, "meet": [12, 15], "function": 12, "put": 12, "readm": 12, "md": 12, "To": [12, 16, 19], "subset": 12, "test_trafficgen": 12, "A": [12, 14, 19], "remind": 12, "maintain": 12, "sure": 12, "entri": 12, "histori": [12, 14], "rst": 12, "Then": 12, "bump2vers": 12, "patch": 12, "major": 12, "minor": 12, "first": 13, "releas": [13, 14], "pypi": 13, "tool": [14, 19], "verifi": 14, "automat": 14, "collis": 14, "ground": 14, "avoid": 14, "inspect": 14, "paper": [14, 15], "background": 14, "stabl": 14, "usag": 14, "baselin": 14, "contribut": 14, "get": 14, "pull": 14, "request": [14, 15], "guidelin": 14, "tip": 14, "deploi": 14, "primari": 14, "tester": 14, "08": 14, "api": 14, "index": 14, "modul": [14, 17], "search": 14, "complet": 15, "titl": 15, "ho": 15, "common_vector": 15, "2": [15, 19], "relative_spe": 15, "For": 15, "radar": [15, 19], "togeth": 15, "displai": [15, 19], "e": [15, 19], "g": [15, 19], "common": 15, "respect": [15, 19], "global": 15, "encounter_set": [15, 19], "fulli": 15, "shown": 15, "desid": 15, "less": 15, "demonstr": 15, "mandatori": 15, "option": [15, 19], "either": [15, 16], "shop": 15, "mean": 15, "higher": 15, "than": 15, "built": 15, "see": 15, "link": 15, "introduct": 15, "At": 15, "center": 15, "necessarili": 15, "closest": 15, "approach": 15, "num_situ": 15, "ot_gw": 15, "7": 15, "command": [16, 19], "termin": 16, "pip": 16, "prefer": 16, "recent": 16, "don": 16, "guid": 16, "process": 16, "download": 16, "public": 16, "repositori": 16, "onc": 16, "py": 16, "submodul": 17, "content": 17, "import": 19, "line": 19, "take": 19, "default": 19, "baseline_situations_input": 19, "c": 19, "integ": 19, "6": 19, "show": 19, "messag": 19, "exit": 19, "cover": 19, "combin": 19, "total": 19, "55": 19, "pop": 19, "window": 19, "colum": 19, "per": 19, "browser": 19, "tab": 19, "openstreetmap": 19, "overlai": 19, "within": 19, "rang": 19, "12": 19}, "objects": {"": [[4, 0, 0, "-", "trafficgen"]], "trafficgen": [[4, 1, 1, "", "assign_beta"], [4, 1, 1, "", "assign_future_position_to_target_ship"], [4, 1, 1, "", "assign_speed_to_target_ship"], [4, 1, 1, "", "assign_vector_time"], [4, 1, 1, "", "calculate_position_at_certain_time"], [4, 1, 1, "", "calculate_relative_bearing"], [4, 1, 1, "", "calculate_ship_course"], [4, 1, 1, "", "check_encounter_evolvement"], [1, 0, 0, "-", "check_land_crossing"], [4, 1, 1, "", "clean_traffic_situation_data"], [2, 0, 0, "-", "cli"], [4, 1, 1, "", "convert_angle_0_to_360_to_minus_180_to_180"], [4, 1, 1, "", "convert_angle_minus_180_to_180_to_0_to_360"], [4, 1, 1, "", "decide_target_ship"], [4, 1, 1, "", "deg_2_rad"], [4, 1, 1, "", "determine_colreg"], [3, 0, 0, "-", "encounter"], [4, 1, 1, "", "find_start_position_target_ship"], [4, 1, 1, "", "find_value"], [4, 1, 1, "", "flat2llh"], [4, 1, 1, "", "generate_encounter"], [4, 1, 1, "", "generate_traffic_situations"], [4, 1, 1, "", "knot_2_m_pr_min"], [4, 1, 1, "", "llh2flat"], [4, 1, 1, "", "m2nm"], [4, 1, 1, "", "m_pr_min_2_knot"], [5, 0, 0, "-", "marine_system_simulator"], [4, 1, 1, "", "nm_2_m"], [4, 1, 1, "", "plot_specific_traffic_situation"], [6, 0, 0, "-", "plot_traffic_situation"], [4, 1, 1, "", "plot_traffic_situations"], [4, 1, 1, "", "rad_2_deg"], [4, 1, 1, "", "read_encounter_setting_file"], [7, 0, 0, "-", "read_files"], [4, 1, 1, "", "read_own_ship_file"], [4, 1, 1, "", "read_situation_files"], [4, 1, 1, "", "read_target_ship_files"], [8, 0, 0, "-", "ship_traffic_generator"], [4, 1, 1, "", "ssa"], [4, 1, 1, "", "update_position_data_own_ship"], [4, 1, 1, "", "update_position_data_target_ship"], [9, 0, 0, "-", "util_methods"], [10, 0, 0, "-", "write_traffic_situation_to_file"], [4, 1, 1, "", "write_traffic_situations_to_json_file"]], "trafficgen.check_land_crossing": [[1, 1, 1, "", "path_crosses_land"]], "trafficgen.cli": [[2, 2, 1, "", "default_data_path"], [2, 1, 1, "", "gen_situation"], [2, 2, 1, "", "logger"], [2, 1, 1, "", "main"], [2, 2, 1, "", "output_folder"], [2, 2, 1, "", "own_ship_file"], [2, 2, 1, "", "settings_file"], [2, 2, 1, "", "sit_folder"], [2, 2, 1, "", "target_ship_folder"]], "trafficgen.encounter": [[3, 1, 1, "", "assign_beta"], [3, 1, 1, "", "assign_future_position_to_target_ship"], [3, 1, 1, "", "assign_speed_to_target_ship"], [3, 1, 1, "", "assign_vector_time"], [3, 1, 1, "", "calculate_min_vector_length_target_ship"], [3, 1, 1, "", "calculate_relative_bearing"], [3, 1, 1, "", "calculate_ship_course"], [3, 1, 1, "", "check_encounter_evolvement"], [3, 1, 1, "", "decide_target_ship"], [3, 1, 1, "", "determine_colreg"], [3, 1, 1, "", "find_start_position_target_ship"], [3, 1, 1, "", "generate_encounter"], [3, 1, 1, "", "update_position_data_own_ship"], [3, 1, 1, "", "update_position_data_target_ship"]], "trafficgen.marine_system_simulator": [[5, 1, 1, "", "flat2llh"], [5, 1, 1, "", "llh2flat"], [5, 1, 1, "", "ssa"]], "trafficgen.plot_traffic_situation": [[6, 1, 1, "", "add_ship_to_map"], [6, 1, 1, "", "add_ship_to_plot"], [6, 1, 1, "", "calculate_ship_outline"], [6, 1, 1, "", "calculate_vector_arrow"], [6, 1, 1, "", "find_max_value_for_plot"], [6, 1, 1, "", "plot_specific_traffic_situation"], [6, 1, 1, "", "plot_traffic_situations"]], "trafficgen.read_files": [[7, 1, 1, "", "read_encounter_setting_file"], [7, 1, 1, "", "read_own_ship_file"], [7, 1, 1, "", "read_situation_files"], [7, 1, 1, "", "read_target_ship_files"]], "trafficgen.ship_traffic_generator": [[8, 1, 1, "", "find_value"], [8, 1, 1, "", "generate_traffic_situations"]], "trafficgen.util_methods": [[9, 1, 1, "", "calculate_position_at_certain_time"], [9, 1, 1, "", "convert_angle_0_to_360_to_minus_180_to_180"], [9, 1, 1, "", "convert_angle_minus_180_to_180_to_0_to_360"], [9, 1, 1, "", "deg_2_rad"], [9, 1, 1, "", "knot_2_m_pr_min"], [9, 1, 1, "", "m2nm"], [9, 1, 1, "", "m_pr_min_2_knot"], [9, 1, 1, "", "nm_2_m"], [9, 1, 1, "", "rad_2_deg"]], "trafficgen.write_traffic_situation_to_file": [[10, 1, 1, "", "clean_traffic_situation_data"], [10, 1, 1, "", "write_traffic_situations_to_json_file"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"]}, "titleterms": {"api": 0, "refer": 0, "trafficgen": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 17, 18], "check_land_cross": [1, 18], "modul": [1, 2, 3, 5, 6, 7, 8, 9, 10, 18], "content": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 14, 18], "function": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "cli": [2, 18], "attribut": 2, "encount": [3, 18], "submodul": [4, 18], "packag": [4, 18], "marine_system_simul": [5, 18], "plot_traffic_situ": [6, 18], "read_fil": [7, 18], "ship_traffic_gener": [8, 18], "util_method": [9, 18], "write_traffic_situation_to_fil": [10, 18], "author": 11, "primari": 11, "tester": 11, "contribut": 12, "type": 12, "report": 12, "bug": 12, "fix": 12, "implement": 12, "featur": 12, "write": 12, "document": [12, 14], "submit": 12, "feedback": 12, "get": 12, "start": 12, "pull": 12, "request": 12, "guidelin": 12, "tip": 12, "deploi": 12, "histori": 13, "0": 13, "1": 13, "2023": 13, "11": 13, "08": 13, "welcom": 14, "traffic": [14, 19], "gener": [14, 19], "": 14, "indic": 14, "tabl": 14, "input": 15, "file": 15, "instal": 16, "stabl": 16, "releas": 16, "from": 16, "sourc": 16, "usag": 19, "situat": 19, "baselin": 19, "plot": 19, "all": 19, "individu": 19, "map": 19, "background": 19}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"API Reference": [[0, "api-reference"]], "trafficgen.check_land_crossing": [[1, "module-trafficgen.check_land_crossing"]], "Module Contents": [[1, "module-contents"], [2, "module-contents"], [3, "module-contents"], [5, "module-contents"], [6, "module-contents"], [7, "module-contents"], [8, "module-contents"], [9, "module-contents"], [10, "module-contents"]], "Functions": [[1, "functions"], [2, "functions"], [3, "functions"], [4, "functions"], [5, "functions"], [6, "functions"], [7, "functions"], [8, "functions"], [9, "functions"], [10, "functions"]], "trafficgen.cli": [[2, "module-trafficgen.cli"]], "Attributes": [[2, "attributes"]], "trafficgen.encounter": [[3, "module-trafficgen.encounter"]], "trafficgen": [[4, "module-trafficgen"], [17, "trafficgen"]], "Submodules": [[4, "submodules"], [18, "submodules"]], "Package Contents": [[4, "package-contents"]], "trafficgen.marine_system_simulator": [[5, "module-trafficgen.marine_system_simulator"]], "trafficgen.plot_traffic_situation": [[6, "module-trafficgen.plot_traffic_situation"]], "trafficgen.read_files": [[7, "module-trafficgen.read_files"]], "trafficgen.ship_traffic_generator": [[8, "module-trafficgen.ship_traffic_generator"]], "trafficgen.util_methods": [[9, "module-trafficgen.util_methods"]], "trafficgen.write_traffic_situation_to_file": [[10, "module-trafficgen.write_traffic_situation_to_file"]], "Authors": [[11, "authors"]], "Primary author": [[11, "primary-author"]], "Testers": [[11, "testers"]], "Contributing": [[12, "contributing"]], "Types of Contributions": [[12, "types-of-contributions"]], "Report Bugs": [[12, "report-bugs"]], "Fix Bugs": [[12, "fix-bugs"]], "Implement Features": [[12, "implement-features"]], "Write Documentation": [[12, "write-documentation"]], "Submit Feedback": [[12, "submit-feedback"]], "Get Started!": [[12, "get-started"]], "Pull Request Guidelines": [[12, "pull-request-guidelines"]], "Tips": [[12, "tips"]], "Deploying": [[12, "deploying"]], "History": [[13, "history"]], "0.1.0 (2023-11-08)": [[13, "id1"]], "Welcome to Traffic Generator\u2019s documentation!": [[14, "welcome-to-traffic-generator-s-documentation"]], "Contents:": [[14, null]], "Indices and tables": [[14, "indices-and-tables"]], "Input files": [[15, "input-files"]], "Installation": [[16, "installation"]], "Stable release": [[16, "stable-release"]], "From sources": [[16, "from-sources"]], "trafficgen package": [[18, "trafficgen-package"]], "trafficgen.check_land_crossing module": [[18, "trafficgen-check-land-crossing-module"]], "trafficgen.cli module": [[18, "trafficgen-cli-module"]], "trafficgen.encounter module": [[18, "trafficgen-encounter-module"]], "trafficgen.marine_system_simulator module": [[18, "trafficgen-marine-system-simulator-module"]], "trafficgen.plot_traffic_situation module": [[18, "trafficgen-plot-traffic-situation-module"]], "trafficgen.read_files module": [[18, "trafficgen-read-files-module"]], "trafficgen.ship_traffic_generator module": [[18, "trafficgen-ship-traffic-generator-module"]], "trafficgen.util_methods module": [[18, "trafficgen-util-methods-module"]], "trafficgen.write_traffic_situation_to_file module": [[18, "trafficgen-write-traffic-situation-to-file-module"]], "Module contents": [[18, "module-contents"]], "Usage": [[19, "usage"]], "Situations": [[19, "situations"]], "Baseline situations": [[19, "baseline-situations"]], "Plotting": [[19, "plotting"]], "Plotting all generated traffic situations": [[19, "plotting-all-generated-traffic-situations"]], "Individual plots with map background": [[19, "individual-plots-with-map-background"]]}, "indexentries": {"module": [[1, "module-trafficgen.check_land_crossing"], [2, "module-trafficgen.cli"], [3, "module-trafficgen.encounter"], [4, "module-trafficgen"], [5, "module-trafficgen.marine_system_simulator"], [6, "module-trafficgen.plot_traffic_situation"], [7, "module-trafficgen.read_files"], [8, "module-trafficgen.ship_traffic_generator"], [9, "module-trafficgen.util_methods"], [10, "module-trafficgen.write_traffic_situation_to_file"]], "path_crosses_land() (in module trafficgen.check_land_crossing)": [[1, "trafficgen.check_land_crossing.path_crosses_land"]], "trafficgen.check_land_crossing": [[1, "module-trafficgen.check_land_crossing"]], "default_data_path (in module trafficgen.cli)": [[2, "trafficgen.cli.default_data_path"]], "gen_situation() (in module trafficgen.cli)": [[2, "trafficgen.cli.gen_situation"]], "logger (in module trafficgen.cli)": [[2, "trafficgen.cli.logger"]], "main() (in module trafficgen.cli)": [[2, "trafficgen.cli.main"]], "output_folder (in module trafficgen.cli)": [[2, "trafficgen.cli.output_folder"]], "own_ship_file (in module trafficgen.cli)": [[2, "trafficgen.cli.own_ship_file"]], "settings_file (in module trafficgen.cli)": [[2, "trafficgen.cli.settings_file"]], "sit_folder (in module trafficgen.cli)": [[2, "trafficgen.cli.sit_folder"]], "target_ship_folder (in module trafficgen.cli)": [[2, "trafficgen.cli.target_ship_folder"]], "trafficgen.cli": [[2, "module-trafficgen.cli"]], "assign_beta() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.assign_beta"]], "assign_future_position_to_target_ship() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.assign_future_position_to_target_ship"]], "assign_speed_to_target_ship() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.assign_speed_to_target_ship"]], "assign_vector_time() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.assign_vector_time"]], "calculate_min_vector_length_target_ship() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.calculate_min_vector_length_target_ship"]], "calculate_relative_bearing() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.calculate_relative_bearing"]], "calculate_ship_course() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.calculate_ship_course"]], "check_encounter_evolvement() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.check_encounter_evolvement"]], "decide_target_ship() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.decide_target_ship"]], "determine_colreg() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.determine_colreg"]], "find_start_position_target_ship() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.find_start_position_target_ship"]], "generate_encounter() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.generate_encounter"]], "trafficgen.encounter": [[3, "module-trafficgen.encounter"]], "update_position_data_own_ship() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.update_position_data_own_ship"]], "update_position_data_target_ship() (in module trafficgen.encounter)": [[3, "trafficgen.encounter.update_position_data_target_ship"]], "assign_beta() (in module trafficgen)": [[4, "trafficgen.assign_beta"]], "assign_future_position_to_target_ship() (in module trafficgen)": [[4, "trafficgen.assign_future_position_to_target_ship"]], "assign_speed_to_target_ship() (in module trafficgen)": [[4, "trafficgen.assign_speed_to_target_ship"]], "assign_vector_time() (in module trafficgen)": [[4, "trafficgen.assign_vector_time"]], "calculate_position_at_certain_time() (in module trafficgen)": [[4, "trafficgen.calculate_position_at_certain_time"]], "calculate_relative_bearing() (in module trafficgen)": [[4, "trafficgen.calculate_relative_bearing"]], "calculate_ship_course() (in module trafficgen)": [[4, "trafficgen.calculate_ship_course"]], "check_encounter_evolvement() (in module trafficgen)": [[4, "trafficgen.check_encounter_evolvement"]], "clean_traffic_situation_data() (in module trafficgen)": [[4, "trafficgen.clean_traffic_situation_data"]], "convert_angle_0_to_360_to_minus_180_to_180() (in module trafficgen)": [[4, "trafficgen.convert_angle_0_to_360_to_minus_180_to_180"]], "convert_angle_minus_180_to_180_to_0_to_360() (in module trafficgen)": [[4, "trafficgen.convert_angle_minus_180_to_180_to_0_to_360"]], "decide_target_ship() (in module trafficgen)": [[4, "trafficgen.decide_target_ship"]], "deg_2_rad() (in module trafficgen)": [[4, "trafficgen.deg_2_rad"]], "determine_colreg() (in module trafficgen)": [[4, "trafficgen.determine_colreg"]], "find_start_position_target_ship() (in module trafficgen)": [[4, "trafficgen.find_start_position_target_ship"]], "find_value() (in module trafficgen)": [[4, "trafficgen.find_value"]], "flat2llh() (in module trafficgen)": [[4, "trafficgen.flat2llh"]], "generate_encounter() (in module trafficgen)": [[4, "trafficgen.generate_encounter"]], "generate_traffic_situations() (in module trafficgen)": [[4, "trafficgen.generate_traffic_situations"]], "knot_2_m_pr_min() (in module trafficgen)": [[4, "trafficgen.knot_2_m_pr_min"]], "llh2flat() (in module trafficgen)": [[4, "trafficgen.llh2flat"]], "m2nm() (in module trafficgen)": [[4, "trafficgen.m2nm"]], "m_pr_min_2_knot() (in module trafficgen)": [[4, "trafficgen.m_pr_min_2_knot"]], "nm_2_m() (in module trafficgen)": [[4, "trafficgen.nm_2_m"]], "plot_specific_traffic_situation() (in module trafficgen)": [[4, "trafficgen.plot_specific_traffic_situation"]], "plot_traffic_situations() (in module trafficgen)": [[4, "trafficgen.plot_traffic_situations"]], "rad_2_deg() (in module trafficgen)": [[4, "trafficgen.rad_2_deg"]], "read_encounter_setting_file() (in module trafficgen)": [[4, "trafficgen.read_encounter_setting_file"]], "read_own_ship_file() (in module trafficgen)": [[4, "trafficgen.read_own_ship_file"]], "read_situation_files() (in module trafficgen)": [[4, "trafficgen.read_situation_files"]], "read_target_ship_files() (in module trafficgen)": [[4, "trafficgen.read_target_ship_files"]], "ssa() (in module trafficgen)": [[4, "trafficgen.ssa"]], "trafficgen": [[4, "module-trafficgen"]], "update_position_data_own_ship() (in module trafficgen)": [[4, "trafficgen.update_position_data_own_ship"]], "update_position_data_target_ship() (in module trafficgen)": [[4, "trafficgen.update_position_data_target_ship"]], "write_traffic_situations_to_json_file() (in module trafficgen)": [[4, "trafficgen.write_traffic_situations_to_json_file"]], "flat2llh() (in module trafficgen.marine_system_simulator)": [[5, "trafficgen.marine_system_simulator.flat2llh"]], "llh2flat() (in module trafficgen.marine_system_simulator)": [[5, "trafficgen.marine_system_simulator.llh2flat"]], "ssa() (in module trafficgen.marine_system_simulator)": [[5, "trafficgen.marine_system_simulator.ssa"]], "trafficgen.marine_system_simulator": [[5, "module-trafficgen.marine_system_simulator"]], "add_ship_to_map() (in module trafficgen.plot_traffic_situation)": [[6, "trafficgen.plot_traffic_situation.add_ship_to_map"]], "add_ship_to_plot() (in module trafficgen.plot_traffic_situation)": [[6, "trafficgen.plot_traffic_situation.add_ship_to_plot"]], "calculate_ship_outline() (in module trafficgen.plot_traffic_situation)": [[6, "trafficgen.plot_traffic_situation.calculate_ship_outline"]], "calculate_vector_arrow() (in module trafficgen.plot_traffic_situation)": [[6, "trafficgen.plot_traffic_situation.calculate_vector_arrow"]], "find_max_value_for_plot() (in module trafficgen.plot_traffic_situation)": [[6, "trafficgen.plot_traffic_situation.find_max_value_for_plot"]], "plot_specific_traffic_situation() (in module trafficgen.plot_traffic_situation)": [[6, "trafficgen.plot_traffic_situation.plot_specific_traffic_situation"]], "plot_traffic_situations() (in module trafficgen.plot_traffic_situation)": [[6, "trafficgen.plot_traffic_situation.plot_traffic_situations"]], "trafficgen.plot_traffic_situation": [[6, "module-trafficgen.plot_traffic_situation"]], "read_encounter_setting_file() (in module trafficgen.read_files)": [[7, "trafficgen.read_files.read_encounter_setting_file"]], "read_own_ship_file() (in module trafficgen.read_files)": [[7, "trafficgen.read_files.read_own_ship_file"]], "read_situation_files() (in module trafficgen.read_files)": [[7, "trafficgen.read_files.read_situation_files"]], "read_target_ship_files() (in module trafficgen.read_files)": [[7, "trafficgen.read_files.read_target_ship_files"]], "trafficgen.read_files": [[7, "module-trafficgen.read_files"]], "find_value() (in module trafficgen.ship_traffic_generator)": [[8, "trafficgen.ship_traffic_generator.find_value"]], "generate_traffic_situations() (in module trafficgen.ship_traffic_generator)": [[8, "trafficgen.ship_traffic_generator.generate_traffic_situations"]], "trafficgen.ship_traffic_generator": [[8, "module-trafficgen.ship_traffic_generator"]], "calculate_position_at_certain_time() (in module trafficgen.util_methods)": [[9, "trafficgen.util_methods.calculate_position_at_certain_time"]], "convert_angle_0_to_360_to_minus_180_to_180() (in module trafficgen.util_methods)": [[9, "trafficgen.util_methods.convert_angle_0_to_360_to_minus_180_to_180"]], "convert_angle_minus_180_to_180_to_0_to_360() (in module trafficgen.util_methods)": [[9, "trafficgen.util_methods.convert_angle_minus_180_to_180_to_0_to_360"]], "deg_2_rad() (in module trafficgen.util_methods)": [[9, "trafficgen.util_methods.deg_2_rad"]], "knot_2_m_pr_min() (in module trafficgen.util_methods)": [[9, "trafficgen.util_methods.knot_2_m_pr_min"]], "m2nm() (in module trafficgen.util_methods)": [[9, "trafficgen.util_methods.m2nm"]], "m_pr_min_2_knot() (in module trafficgen.util_methods)": [[9, "trafficgen.util_methods.m_pr_min_2_knot"]], "nm_2_m() (in module trafficgen.util_methods)": [[9, "trafficgen.util_methods.nm_2_m"]], "rad_2_deg() (in module trafficgen.util_methods)": [[9, "trafficgen.util_methods.rad_2_deg"]], "trafficgen.util_methods": [[9, "module-trafficgen.util_methods"]], "clean_traffic_situation_data() (in module trafficgen.write_traffic_situation_to_file)": [[10, "trafficgen.write_traffic_situation_to_file.clean_traffic_situation_data"]], "trafficgen.write_traffic_situation_to_file": [[10, "module-trafficgen.write_traffic_situation_to_file"]], "write_traffic_situations_to_json_file() (in module trafficgen.write_traffic_situation_to_file)": [[10, "trafficgen.write_traffic_situation_to_file.write_traffic_situations_to_json_file"]]}}) \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/trafficgen.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/trafficgen.html new file mode 100644 index 0000000..d1ebce9 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/trafficgen.html @@ -0,0 +1,147 @@ + + + + + + + trafficgen package — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

trafficgen package

+
+

Submodules

+
+
+

trafficgen.check_land_crossing module

+
+
+

trafficgen.cli module

+
+
+

trafficgen.encounter module

+
+
+

trafficgen.marine_system_simulator module

+
+
+

trafficgen.plot_traffic_situation module

+
+
+

trafficgen.read_files module

+
+
+

trafficgen.ship_traffic_generator module

+
+
+

trafficgen.util_methods module

+
+
+

trafficgen.write_traffic_situation_to_file module

+
+
+

Module contents

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2023, DNV, Tom Arne Pedersen.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/usage.html b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/usage.html new file mode 100644 index 0000000..4041c06 --- /dev/null +++ b/branch/7-add-github-workflows-to-build-package-and-to-build-and-publish-documentation/usage.html @@ -0,0 +1,184 @@ + + + + + + + Usage — Traffic Generator 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Usage

+

To use Traffic Generator in a project:

+
import trafficgen
+
+
+

To use Traffic Generator as a command line tool for generating traffic situations, write:

+
trafficgen gen-situation
+
+
+

The command line tool takes different input options:

+
-s, --situations PATH          Folders with situations (default=./baseline_situations_input/)
+-t, --targets PATH             Folder with target configurations (default=./target_ships/)
+-c, --settings PATH            Path to settings file (default=./settings/encounter_settings.json)
+--visualize                    Plot visualization
+--col INTEGER                  Number of columns for plot, may be used with visualize (default=10)
+--row INTEGER                  Number of rows for plot, may be used with visualize (default=6)
+--visualize-situation INTEGER  Plot individual traffic situation, specify INTEGER value
+-o, --output PATH              Output folder (default=None)
+--help                         Show this message and exit.
+
+
+

Example:

+
trafficgen gen-situation -s ./data/example_situations_input -o ./data/test_output_1
+
+
+
+

Situations

+

When generating situations without specifying where the desired situations (--situation) are found, the +default path, which is default=./baseline_situations_input/, will be used.

+
+
+

Baseline situations

+

The baseline situations are a set of generic traffic situations covering head-on, overtaking stand-on/give-way +and crossing stand-on/give-way encounters. To cover the combination of encounters for 1, 2 and 3 target ships, +there are in total 55 baseline situations. The input files for generating these situations are found in +./baseline_situations_input/

+
+
+

Plotting

+
+

Plotting all generated traffic situations

+

All the generated situations are displayed if using --visualize. This will pop up one or more plot windows, +which show all the traffic situations. The number of colums and rows for the plots (per figure) can be specified by +using --col and --row, respectively.

+
+
+

Individual plots with map background

+

A specific encounter is visualized by using --visualize-situation INTEGER, e.g.:

+
trafficgen gen-situation -s ./data/example_situations_input -o ./data/test_output_1 --visualize-situation 2
+
+
+

This will open a browser window/tab with an OpenStreetMap background and the traffic situation +radar plot as an overlay. +Note that the integer needs to be within the range of the number of generated situations, +for example 1 - 12 if you generated 12 situations.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file