customModules = getCustomModules();
-
- final Config config = ConfigUtils.loadConfig(path, customModules.toArray(new ConfigGroup[0]));
- Config prepared = prepareConfig(config);
-
- return prepared != null ? prepared : config;
- }
-
@Override
public String defaultValue(CommandLine.Model.ArgSpec argSpec) throws Exception {
Object obj = argSpec.userObject();
@@ -429,6 +342,13 @@ public static void run(Class clazz, String... args)
l.addAll(Arrays.asList(args));
args = l.toArray(new String[0]);
+
+ // Pass stored args to the instance as well
+ if (System.getenv().containsKey("MATSIM_GUI_ARGS")) {
+ String[] guiArgs = System.getenv("MATSIM_GUI_ARGS").split(ARGS_DELIMITER);
+ if (guiArgs.length > 0)
+ args = ApplicationUtils.mergeArgs(args, guiArgs);
+ }
}
prepareArgs(args);
@@ -451,6 +371,83 @@ public static void run(Class clazz, String... args)
System.exit(code);
}
+ /**
+ * Convenience method to run a scenario from code or automatically with gui when desktop application is detected.
+ * This method may also be used to predefine some default arguments.
+ *
+ * With respect to args it looks like arguments are treated in the following sequence (programmed in the run method):
+ *
+ * - ConfigUtils.loadConfig without args
+ * - prepareConfig which is usually overwritten
+ * - config options from some yaml file which can be provided as a command line option
+ * - config options on command line
+ *
+ *
+ * defaultArgs could be used to provide defaults when calling this method here; they would go in addition to what is coming in from "upstream" which is typically the command line.
+ *
+ * There are many execution paths that can be reached from this class, but a typical one for matsim-scenarios seems to be:
+ * - This method runs MATSimApplication.run( TheScenarioClass.class , args ).
+ * - That run class will instantiate an instance of TheScenarioClass (*), then do some args consistenty checking, then call the piccoli execute method.
+ * - The piccoli execute method will essentially call the "call" method of MATSimApplication.
+ * - I think that in the described execution path, this.config in that call method will initially be null. (The ctor of MATSimApplication was called via reflection at (*); I think that it was called there without a config argument.)
+ * - This call method then will do:
+ * - getCustomModules() (which is empty by default but can be overriden)
+ * - ConfigUtils.loadConfig(...) _without_ passing on the args
+ * - prepareConfig(...) (which is empty by default but is typically overridden, in this case in OpenBerlinScenario). In our case, this sets the typical scoring params and the typical replanning strategies.
+ *
- next one can override the config from some yaml file provided as a commandline option
+ *
- next args is parsed and set
+ *
- then some standard CL options are detected and set
+ *
- then createScenario(config) is called (which can be overwritten but is not)
+ *
- then prepareScenario(scenario) is called (which can be overwritten but is not)
+ *
- then a standard controler is created from scenario
+ *
- then prepareControler is called which can be overwritten
+ *
+ *
+ *
+ *
+ * @param clazz class of the scenario to run
+ * @param args pass arguments from the main method
+ * @param defaultArgs predefined default arguments that will always be present
+ */
+ public static void runWithDefaults(Class clazz, String[] args, String... defaultArgs) {
+
+ if (ApplicationUtils.isRunFromDesktop() && args.length == 0) {
+
+ System.setProperty("MATSIM_GUI_DESKTOP", "true");
+
+ if (defaultArgs.length > 0) {
+ String value = String.join(ARGS_DELIMITER, defaultArgs);
+ System.setProperty("MATSIM_GUI_ARGS", value);
+ }
+
+ // args are empty when run from desktop and is not used
+ run(clazz, "gui");
+
+ } else {
+ // run if no other command is present
+ if (args.length > 0) {
+ // valid command is present
+ if (args[0].equals("run") || args[0].equals("prepare") || args[0].equals("analysis") || args[0].equals("gui") ){
+ // If this is a run command, the default args can be applied
+ if (args[0].equals("run"))
+ args = ApplicationUtils.mergeArgs(args, defaultArgs);
+
+ } else {
+ // Automatically add run command
+ String[] runArgs = ApplicationUtils.mergeArgs(new String[]{"run"}, defaultArgs);
+ args = ApplicationUtils.mergeArgs(runArgs, args);
+ }
+
+ } else
+ // Automatically add run command
+ args = ApplicationUtils.mergeArgs(new String[]{"run"}, defaultArgs);
+
+ log.info("Running {} with: {}", clazz.getSimpleName(), String.join(" ", args));
+
+ run(clazz, args);
+ }
+ }
+
/**
* Calls an application class and forwards any exceptions.
*
@@ -512,7 +509,7 @@ public static Controler prepare(MATSimApplication app, Config config, String...
config = tmp != null ? tmp : config;
if (app.specs != null) {
- applySpecs(config, app.specs);
+ ApplicationUtils.applyConfigUpdate(config, app.specs);
}
if (app.remainingArgs != null) {
@@ -744,7 +741,7 @@ public Integer call() throws Exception {
}
/**
- * Option to switch post processing behavour
+ * Option to switch post-processing behaviour
*/
public enum PostProcessOption {
diff --git a/contribs/application/src/main/java/org/matsim/application/commands/RunScenario.java b/contribs/application/src/main/java/org/matsim/application/RunScenario.java
similarity index 67%
rename from contribs/application/src/main/java/org/matsim/application/commands/RunScenario.java
rename to contribs/application/src/main/java/org/matsim/application/RunScenario.java
index 3221069de95..460d5585ee5 100644
--- a/contribs/application/src/main/java/org/matsim/application/commands/RunScenario.java
+++ b/contribs/application/src/main/java/org/matsim/application/RunScenario.java
@@ -1,12 +1,11 @@
-package org.matsim.application.commands;
+package org.matsim.application;
-import org.matsim.application.MATSimApplication;
import picocli.CommandLine;
import java.util.concurrent.Callable;
@CommandLine.Command(name = "run", description = "Run the scenario")
-public class RunScenario implements Callable {
+class RunScenario implements Callable {
@CommandLine.ParentCommand
private MATSimApplication app;
diff --git a/contribs/application/src/main/java/org/matsim/application/commands/ShowGUI.java b/contribs/application/src/main/java/org/matsim/application/ShowGUI.java
similarity index 51%
rename from contribs/application/src/main/java/org/matsim/application/commands/ShowGUI.java
rename to contribs/application/src/main/java/org/matsim/application/ShowGUI.java
index 443f6a5cccb..6400262eb95 100644
--- a/contribs/application/src/main/java/org/matsim/application/commands/ShowGUI.java
+++ b/contribs/application/src/main/java/org/matsim/application/ShowGUI.java
@@ -1,14 +1,14 @@
-package org.matsim.application.commands;
+package org.matsim.application;
-import org.matsim.application.MATSimApplication;
import org.matsim.run.gui.Gui;
import picocli.CommandLine;
+import java.io.File;
import java.util.concurrent.Callable;
import java.util.concurrent.Future;
@CommandLine.Command(name = "gui", description = "Run the scenario through the MATSim GUI")
-public class ShowGUI implements Callable {
+class ShowGUI implements Callable {
@CommandLine.ParentCommand
private MATSimApplication parent;
@@ -26,10 +26,27 @@ public Integer call() throws Exception {
name = name.substring(MATSimApplication.COLOR.length(), name.length() - 4);
}
- Future f = Gui.show(name, parent.getClass());
+ File configFile = null;
+
+ // Try to load default config file
+ if (parent.getDefaultScenario() != null && new File(parent.getDefaultScenario()).exists())
+ configFile = new File(parent.getDefaultScenario());
+
+ // override the default if present
+ if (parent.getConfigPath() != null && parent.getConfigPath().exists())
+ configFile = parent.getConfigPath();
+
+ Future f = Gui.show(name, parent.getClass(), configFile);
Gui gui = f.get();
+ // Set the current working directory to be used in the gui, when run from the command line
+ // If the gui is run from desktop, the working directory is not overwritten
+
+ // Assumption is that starting something from command line, the user expects that the working directory remains the same
+ if (!System.getProperty("MATSIM_GUI_DESKTOP", "false").equals("true"))
+ gui.setWorkingDirectory(new File(""));
+
while (gui.isShowing())
Thread.sleep(250);
diff --git a/contribs/application/src/main/java/org/matsim/application/analysis/LogFileAnalysis.java b/contribs/application/src/main/java/org/matsim/application/analysis/LogFileAnalysis.java
index 36345aa2a79..5000c232482 100644
--- a/contribs/application/src/main/java/org/matsim/application/analysis/LogFileAnalysis.java
+++ b/contribs/application/src/main/java/org/matsim/application/analysis/LogFileAnalysis.java
@@ -171,7 +171,6 @@ private void renderWarnings(BufferedWriter writer, Set warnings) throws
} else {
Map> grouped = warnings.stream().collect(Collectors.groupingBy(w -> w.module, Collectors.toList()));
- writer.write(String.format("Warnings found in %d module%s ❌
\n\n", grouped.size(), grouped.size() > 1 ? "s" : ""));
for (Map.Entry> e : grouped.entrySet()) {
@@ -188,9 +187,7 @@ private void renderWarnings(BufferedWriter writer, Set warnings) throws
writer.write("""