rng implementation by kabarmaz · Pull Request #200 · 52North/WeatherRoutingTool

kabarmaz · 2026-07-08T16:55:16Z

…tils.py and called it where necessary to harmonize the handling of random seeds.

Related Issue / Discussion:

Relates to issue [https://github.com/52North/WRT-Issues/issues/52]

Changes:

    modified:   WeatherRoutingTool/algorithms/data_utils.py
    modified:   WeatherRoutingTool/algorithms/genetic/__init__.py
    modified:   WeatherRoutingTool/algorithms/genetic/crossover.py
    modified:   WeatherRoutingTool/algorithms/genetic/mutation.py
    modified:   WeatherRoutingTool/algorithms/genetic/population.py
    modified:   WeatherRoutingTool/algorithms/genetic/utils.py
    modified:   WeatherRoutingTool/execute_routing.py *
    modified:   WeatherRoutingTool/ship/ship.py *

*access counter for weather data

Further Details:

Summary:

Initialized a random number generator in genetic/utils.py to harmonize the random seed and random number generation throughout the genetic algorithm. Implemented into the above listed files.

Dependencies:

Dependencies remain unchanged.

PR Checklist:

In the context of this PR, I:

have (already previously) filled the 52North Contributor License Agreement and received positive feedback on this matter
have filled the 52North Contributor License Agreement and am waiting for feedback
provide unit tests embedded in the WRT test framework (WeatherRoutingTool/tests) that allow the simple testing of the new/modified functionalities. All (previous and new) unit tests execute without new error messages.
ensure that the code formatter runs without errors/warnings
ensure that my changes follow the WRT’s guidelines for contributing at the time of the contribution

Please consider that PRs which do not meet the requirements specified in the checklist will not be evaluated. Also, PRs with no activities will be closed after a reasonable amount of time.

…tils.py and called it where necessary to harmonize the handling of random seeds.

MartinPontius · 2026-07-09T08:46:03Z

 logger = logging.getLogger("WRT.genetic")


+def get_rng(config: Config, seed=1):


Please add a type hint for the return value (numpy.random.Generator) and a short docstring.

MartinPontius · 2026-07-09T09:06:04Z

@kabarmaz Please also update the tests accordingly, particularly test_genetic.py.

…ils.py

MartinPontius · 2026-07-09T09:15:45Z

 logger = logging.getLogger("WRT.genetic")


+def get_rng(config: Config, seed=1):


Use DEFAULT_RANDOM_SEED as default function argument instead of 1.

MartinPontius · 2026-07-09T09:16:05Z

        if self.config.GENETIC_FIX_RANDOM_SEED:
            logger.info('Fixing random seed for genetic algorithm.')
-            np.random.seed(1)
            seed = 1


Use DEFAULT_RANDOM_SEED instead of 1 (see comments in utils.py).

MartinPontius · 2026-07-09T09:32:27Z

        super().__init__(config)

        self.config = config
+        self.rng = utils.get_rng(config)


Remove this line as self.rng is never used in class Genetic.

MartinPontius · 2026-07-09T09:34:33Z

            constraints_list: ConstraintsList,
            prob=.5,
            crossover_type="unnamed"
+


Remove empty line.

MartinPontius · 2026-07-09T10:27:19Z

        # ~99.7 % in interval (0, BOAT_SPEED_MAX)
-        # self.mu = 0.5 * self.config.BOAT_SPEED_BOUNDARIES[1]
-        self.sigma = 1.54
-        self.max_acceleration = 1


Why change these lines? If there is no reason, revert it (see also lines 588 and 589 below).

MartinPontius · 2026-07-09T10:34:02Z

-        shuffled_cost = rng.permutation(shuffled_cost, axis=0)
-        shuffled_cost = rng.permutation(shuffled_cost, axis=1)
+        shuffled_cost = genetic_utils.RNG.permutation(shuffled_cost, axis=0)
+        shuffled_cost = genetic_utils.RNG.permutation(shuffled_cost, axis=1)


These changes are not working with the latest updates/current implementation. Please correct.

MartinPontius · 2026-07-09T10:34:42Z

        self.time_min_max = [None, None]
        self.lat_min_max = [None, None]
        self.lon_min_max = [None, None]
+        self.counter = 0


Revert this change.

MartinPontius · 2026-07-09T10:34:46Z

        if depth:
            ship_var = ship_var.sel(depth=depth, method='nearest', drop=False)
        ship_var = ship_var.fillna(0).to_numpy()
+        self.counter += 1


Revert this change.

MartinPontius · 2026-07-09T10:34:54Z

        min_fuel_route_postprocessed.write_to_geojson(
            routepath / f"{min_fuel_route_postprocessed.route_type}_postprocessed.geojson")
+
+    print(boat.counter)


Revert this change.

…_SEED(type:int)for better rng implementation

MartinPontius · 2026-07-21T15:45:47Z

    default_map = Map(32., 15, 36, 29)
    constraint_list = basic_test_func.generate_dummy_constraint_list()
-    np.random.seed(1)
+    np.random.default_rng(config.GENETIC_RANDOM_SEED)


Remove the line np.random.default_rng(config.GENETIC_RANDOM_SEED).
This returns a generator which is never used.

In the new structure, it's enough to pass config to RandomPlateauMutation because it creates its own random number generator using the seed specified in the config.

MartinPontius · 2026-07-21T15:46:04Z

    constraint_list = basic_test_func.generate_dummy_constraint_list()

-    np.random.seed(1)
+    np.random.default_rng(config.GENETIC_RANDOM_SEED)


Remove the line np.random.default_rng(config.GENETIC_RANDOM_SEED).
This returns a generator which is never used.

In the new structure, it's enough to pass config to RandomPlateauMutation because it creates its own random number generator using the seed specified in the config.

MartinPontius · 2026-07-21T15:47:35Z

    default_map = Map(32., 15, 36, 29)
    constraint_list = basic_test_func.generate_dummy_constraint_list()
-    np.random.seed(2)
+    np.random.default_rng(config.GENETIC_RANDOM_SEED)


Remove the line np.random.default_rng(config.GENETIC_RANDOM_SEED).
This returns a generator which is never used.

In the new structure, it's enough to pass config to RouteBlendMutation because it creates its own random number generator using the seed specified in the config.

MartinPontius · 2026-07-21T15:48:08Z

    constraint_list = basic_test_func.generate_dummy_constraint_list()

-    np.random.seed(1)
+    np.random.default_rng(config.GENETIC_RANDOM_SEED)


Remove the line np.random.default_rng(config.GENETIC_RANDOM_SEED).
This returns a generator which is never used.

In the new structure, it's enough to pass config to RouteBlendMutation because it creates its own random number generator using the seed specified in the config.

MartinPontius · 2026-07-21T15:54:11Z

    default_map = Map(32., 15, 36, 29)
    constraint_list = basic_test_func.generate_dummy_constraint_list()
-    np.random.seed(2)
+    np.random.default_rng(config.GENETIC_RANDOM_SEED)


Remove the line np.random.default_rng(config.GENETIC_RANDOM_SEED).
This returns a generator which is never used.

Why was np.random.seed(2) used at all? Double-check if the seed was/is considered in the subsequent code.

MartinPontius · 2026-07-21T15:55:13Z

    departure_time = datetime(2025, 4, 1, 11, 11)

-    np.random.seed(2)
+    np.random.default_rng(config.GENETIC_RANDOM_SEED)


Remove the line np.random.default_rng(config.GENETIC_RANDOM_SEED).
This returns a generator which is never used.

In the new structure, it's enough to pass config to SinglePointCrossover because it creates its own random number generator using the seed specified in the config.

MartinPontius · 2026-07-21T15:59:58Z

        # FIXME: these numbers should be carefully evaluated
        # ~99.7 % in interval (0, BOAT_SPEED_MAX)
-        # self.mu = 0.5 * self.config.BOAT_SPEED_BOUNDARIES[1]
+        self.mu = 0.5 * self.config.BOAT_SPEED_BOUNDARIES[1]


Re-apply comment as the variable is currently not used.

MartinPontius · 2026-07-21T16:01:55Z


        self.speed_opts = speed_opts
        self.waypoint_opts = waypoint_opts
+        self.config = config


Remove self.config = config as it is never used.

MartinPontius · 2026-07-21T16:04:41Z

-        shuffled_cost = rng.permutation(shuffled_cost, axis=0)
-        shuffled_cost = rng.permutation(shuffled_cost, axis=1)
+        shuffled_cost = self.rng.permutation(shuffled_cost, axis=0)
+        shuffled_cost = self.rng.permutation(shuffled_cost, axis=1)


self doesn't have an attribute rng.

[bug] Initialized a global random number generator (rng) in genetic/u…

f9779a8

…tils.py and called it where necessary to harmonize the handling of random seeds.

MartinPontius reviewed Jul 9, 2026

View reviewed changes

[add] Added type hint and docstring to get_rng function in genetic/ut…

303b1ee

…ils.py

MartinPontius requested changes Jul 13, 2026

View reviewed changes

kabarmaz added 4 commits July 13, 2026 16:43

solved the issues commented in the PR

c68fa8d

addressed the comments under the PR.

f51d2e7

[change] Changed GENETIC_FIX_RANDOM_SEED(type:bool) to GENETIC_RANDOM…

e96e2db

…_SEED(type:int)for better rng implementation

[change] changed np.random.seed to np.random.default_rng

0974032

kabarmaz marked this pull request as ready for review July 21, 2026 13:07

MartinPontius reviewed Jul 21, 2026

View reviewed changes

kabarmaz added 2 commits July 21, 2026 18:31

adressed the comments to the PR

ea28815

adressed the comments under PR further

a624cb8

MartinPontius merged commit 5dd032b into main Jul 22, 2026
1 check passed

		logger = logging.getLogger("WRT.genetic")


		def get_rng(config: Config, seed=1):

Uh oh!

Conversation

kabarmaz commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related Issue / Discussion:

Changes:

Further Details:

Summary:

Dependencies:

PR Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MartinPontius commented Jul 9, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kabarmaz commented Jul 8, 2026 •

edited

Loading