Skip to content

feat: automating simulation restarts #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sebhoerl wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

feat: automating simulation restarts #516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3cee4d
feat: automating simulation restarts
sebhoerl Jan 12, 2026
7660022
update
sebhoerl Jan 12, 2026
361858c
update
sebhoerl Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
186 changes: 186 additions & 0 deletions core/src/main/java/org/eqasim/core/simulation/restart/RestartConfigurator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
package org.eqasim.core.simulation.restart;

import java.io.File;
import java.util.LinkedList;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Function;

import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
import org.eqasim.core.simulation.termination.EqasimTerminationConfigGroup;
import org.eqasim.core.simulation.termination.EqasimTerminationModule;
import org.eqasim.core.simulation.vdf.VDFConfigGroup;
import org.eqasim.core.simulation.vdf.VDFUpdateListener;
import org.matsim.core.config.CommandLine;
import org.matsim.core.config.Config;
import org.matsim.core.controler.OutputDirectoryHierarchy;

/**
* This class is supposed to be applied after all configuration is set up. It
* will modify the paths such that each new runs ends up in a "restart-*"
* subdirectory of the output directory defined in the controller config group.
* Each time the simulation is restarted on the same output directory, a new
* restart directory is created and the output files of the last successful
* iteration of the previous run are set as input for the new restart. See
* addDefaultMappings for the files that are reconfigured by default.
*/
public class RestartConfigurator {
private final static Logger logger = LogManager.getLogger(RestartConfigurator.class);

static public final String PREFIX = "restart_";
static public final String CMD = "restart";

private record Mapping(boolean isIteration, String sourcePath, Function<Config, Consumer<String>> mapper) {
}

private List<Mapping> mappings = new LinkedList<>();

private File getRestartPath(File basePath, int restartIndex) {
return new File(basePath, PREFIX + restartIndex);
}

public void apply(Config config) {
File basePath = new File(config.controller().getOutputDirectory());

// find the number of restarts
int maximumRestartIndex = -1;
if (basePath.exists()) {
for (File restartPath : basePath.listFiles()) {
if (restartPath.getName().startsWith(PREFIX)) {
int restartIndex = Integer.parseInt(restartPath.getName().replace(PREFIX, ""));
maximumRestartIndex = Math.max(maximumRestartIndex, restartIndex);
}
}
}

int selectedRestartIndex = -1;
int selectedIteration = -1;

if (maximumRestartIndex == -1) {
logger.info(String.format("No restarts found"));
} else {
logger.info(String.format("Examining %d restarts", maximumRestartIndex + 1));

for (int restartIndex = 0; restartIndex <= maximumRestartIndex; restartIndex++) {
File restartPath = getRestartPath(basePath, restartIndex);

// find the available iterations
int maximumIterationIndex = 0;
for (File iterationPath : new File(restartPath, "ITERS").listFiles()) {
if (iterationPath.getName().startsWith("it.")) {
int iterationIndex = Integer.parseInt(iterationPath.getName().replace("it.", ""));
maximumIterationIndex = Math.max(iterationIndex, maximumIterationIndex);
}
}

// check for output level files that must be present
config.controller().setOutputDirectory(restartPath.getAbsolutePath());
OutputDirectoryHierarchy outputDirectoryHierarchy = new OutputDirectoryHierarchy(config);

List<String> missing = new LinkedList<>();
for (Mapping mapping : mappings) {
if (!mapping.isIteration) {
String expectedPath = outputDirectoryHierarchy.getOutputFilename(mapping.sourcePath);

if (!new File(expectedPath).exists()) {
missing.add(mapping.sourcePath);
}
}
}

if (missing.size() == 0) {
for (int iterationIndex = 0; iterationIndex <= maximumIterationIndex; iterationIndex++) {
// check for iteration level files that must be present
missing.clear();

for (Mapping mapping : mappings) {
if (mapping.isIteration) {
String expectedPath = outputDirectoryHierarchy.getIterationFilename(iterationIndex,
mapping.sourcePath);

if (!new File(expectedPath).exists()) {
missing.add(mapping.sourcePath);
}
}
}

if (missing.size() == 0) {
// add files are in place
selectedRestartIndex = restartIndex;
selectedIteration = iterationIndex;

logger.info("Found a viable restart source: restart " + restartIndex + ", iteration "
+ iterationIndex);
}
}
}
}

// we found a viable restart source
if (selectedRestartIndex >= 0 && selectedIteration >= 0) {
File restartPath = getRestartPath(basePath, selectedRestartIndex);
config.controller().setOutputDirectory(restartPath.getAbsolutePath());
OutputDirectoryHierarchy outputHierarchy = new OutputDirectoryHierarchy(config);

// apply all mappings
for (Mapping mapping : mappings) {
if (mapping.isIteration) {
File sourcePath = new File(
outputHierarchy.getIterationFilename(selectedIteration, mapping.sourcePath));
mapping.mapper.apply(config).accept(sourcePath.getAbsolutePath());
} else {
File sourcePath = new File(outputHierarchy.getOutputFilename(mapping.sourcePath));
mapping.mapper.apply(config).accept(sourcePath.getAbsolutePath());
}
}
}
}

// now set up the next restart
int nextRestartIndex = maximumRestartIndex + 1;
File restartPath = getRestartPath(basePath, nextRestartIndex);
config.controller().setOutputDirectory(restartPath.getAbsolutePath());

if (selectedIteration >= 0) {
config.controller().setFirstIteration(selectedIteration);
}

logger.info("Restarting simulation with index " + nextRestartIndex + " and iteration "
+ config.controller().getFirstIteration() + " at " + restartPath.getAbsolutePath());
}

public void addMapping(boolean isIteration, String sourcePath, Function<Config, Consumer<String>> mapper) {
mappings.add(new Mapping(isIteration, sourcePath, mapper));
}

public void clearMappings() {
mappings.clear();
}

public void addDefaultMappings(Config config) {
// plans
addMapping(false, "plans.xml", c -> c.plans()::setInputFile);

// termination
if (config.getModules().containsKey(EqasimTerminationConfigGroup.GROUP_NAME)) {
addMapping(true, EqasimTerminationModule.TERMINATION_CSV_FILE,
c -> EqasimTerminationConfigGroup.getOrCreate(c)::setHistoryFile);
}

// vdf
if (config.getModules().containsKey(VDFConfigGroup.GROUP_NAME)) {
addMapping(true, VDFUpdateListener.FLOW_FILE, c -> VDFConfigGroup.getOrCreate(c)::setInputFlowFile);
addMapping(true, VDFUpdateListener.TRAVEL_TIMES_FILE,
c -> VDFConfigGroup.getOrCreate(c)::setInputTravelTimesFile);
}
}

static public void setup(CommandLine cmd, Config config) {
if (cmd.getOption(CMD).map(Boolean::parseBoolean).orElse(false)) {
RestartConfigurator configurator = new RestartConfigurator();
configurator.addDefaultMappings(config);
configurator.apply(config);
}
}
}
15 changes: 11 additions & 4 deletions core/src/main/java/org/eqasim/core/simulation/termination/EqasimTerminationModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
import com.google.inject.multibindings.MapBinder;

public class EqasimTerminationModule extends AbstractEqasimExtension {
private static final String TERMINATION_CSV_FILE = "eqasim_termination.csv";
private static final String TERMINATION_HTML_FILE = "eqasim_termination.html";
public static final String TERMINATION_CSV_FILE = "eqasim_termination.csv";
public static final String TERMINATION_HTML_FILE = "eqasim_termination.html";

@Override
protected void installEqasimExtension() {
Expand All @@ -37,15 +37,22 @@ EqasimTerminationCriterion provideEqasimTerminationCriterion(ControllerConfigGro
int firstIteration = controllerConfig.getFirstIteration();
int lastIteration = controllerConfig.getLastIteration();

List<TerminationData> history = Collections.emptyList();

if (terminationConfig.getHistoryFile() != null) {
URL historyURL = ConfigGroup.getInputFileURL(getConfig().getContext(), terminationConfig.getHistoryFile());
new TerminationReader(indicators.keySet(), criteria.keySet()).read(historyURL);
history = new TerminationReader(indicators.keySet(), criteria.keySet()).read(historyURL);
}

int minimumIteration = firstIteration + terminationConfig.getMinimumIterations();

return new EqasimTerminationCriterion(firstIteration, lastIteration, minimumIteration, indicators, criteria,
EqasimTerminationCriterion criterion = new EqasimTerminationCriterion(firstIteration, lastIteration,
minimumIteration, indicators, criteria,
writer);

criterion.replay(history);

return criterion;
}

@Provides
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/org/eqasim/core/simulation/vdf/VDFUpdateListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
public class VDFUpdateListener implements IterationEndsListener, StartupListener, ShutdownListener {
private final static Logger logger = LogManager.getLogger(VDFUpdateListener.class);

private final String VDF_FILE = "vdf.bin";
private final String FLOW_FILE = "vdf_flow.csv";
private final String TRAVEL_TIMES_FILE = "vdf_travel_times.bin";
static public final String VDF_FILE = "vdf.bin";
static public final String FLOW_FILE = "vdf_flow.csv";
static public final String TRAVEL_TIMES_FILE = "vdf_travel_times.bin";

private final VDFScope scope;
private final VDFTrafficHandler handler;
Expand Down
3 changes: 3 additions & 0 deletions ile_de_france/src/main/java/org/eqasim/ile_de_france/RunSimulation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package org.eqasim.ile_de_france;

import org.eqasim.core.scenario.validation.VehiclesValidator;
import org.eqasim.core.simulation.restart.RestartConfigurator;
import org.matsim.api.core.v01.Scenario;
import org.matsim.core.config.CommandLine;
import org.matsim.core.config.CommandLine.ConfigurationException;
Expand All @@ -13,6 +14,7 @@ public class RunSimulation {
static public void main(String[] args) throws ConfigurationException {
CommandLine cmd = new CommandLine.Builder(args) //
.requireOptions("config-path") //
.allowOptions(RestartConfigurator.CMD) //
.allowPrefixes("mode-choice-parameter", "cost-parameter") //
.build();

Expand All @@ -21,6 +23,7 @@ static public void main(String[] args) throws ConfigurationException {
configurator.updateConfig(config);

cmd.applyConfiguration(config);
RestartConfigurator.setup(cmd, config);
VehiclesValidator.validate(config);

Scenario scenario = ScenarioUtils.createScenario(config);
Expand Down