{"data":{"markdownRemark":{"html":"

You can start using the Simudyne SDK without defining any configuration, since sensible default values are provided. Later on you might need to amend the settings to change the default behavior. Typical examples of settings that you might amend:

\n\n

Where configuration is read from

\n

The Simudyne SDK reads the config from a simudyneSDK.properties file in the root directory of a project. If this file cannot be found, default values are set for all config. See an example or if you wish to understand a property consult the reference

\n

All config properties can also be overwritten dynamically in the model code. Use ModelContext.get(this).getConfig() to get the config for a specific Model, and setString(), setBoolean(), setLong() or setInt() to set config of a specific type.

\n

ModelConfig.java

\n
public class Housing implements Model {\n\t@Constant public boolean distributed = false;\n\n  public void setup(){\n    if (distributed) {\n    \tModelContext.get(this).getConfig().setString(\n        \"core-abm.backend-implementation\",\n        \"simudyne.core.graph.spark.SparkGraphBackend\");\n    }  \n  }  \n}
\n
\n

Best practice

\n Put all config in the properties file, and only override config in the code for values that change based on user input. (An example of this might be overriding if the model should run distributed based on a toggle input). This is so that the model can be compiled and the config changed without having to recompile.\n
\n

Custom simudyneSDK.properties

\n

A custom simudyneSDK.properties might look like this

\n\n

simudyneSDK.properties

\n
### SimudyneSDK Configuration file\n\n### NEXUS-SERVER ###\n\nnexus-server.port = 8080\nnexus-server.hostname = 127.0.0.1\n\n### CORE ###\n\n# core.prng-seed = 1640702558671097951\n\n### CORE-ABM ###\ncore-abm.max-messaging-phases = 50\n\n# For serialization-level, choose between : {NONE,CHECKED}\ncore-abm.serialization-level=NONE\ncore-abm.serialize.agents=true\ncore-abm.serialize.links=true\ncore-abm.serialize.accumulators=true\ncore-abm.local-parallelism=8
\n
\nThe above hostname will make sure that the server and console are ONLY available locally. If you wish to deploy to a server you should change the hostname either to the IP address, or more commonly 0.0.0.0\n
\n

Example simudyneSDK.properties

\n

For a full example see simudyneSDK.properties

","headings":[{"value":"Where configuration is read from","depth":2},{"value":"Custom simudyneSDK.properties","depth":2},{"value":"Example simudyneSDK.properties","depth":2}],"frontmatter":{"title":"Model Configuration","toc":null,"experimental":null}},"site":{"siteMetadata":{"title":"Simudyne Docs","latestVersion":"2.6"}}},"pageContext":{"absolutePath":"/home/vsts/work/1/s/content/2.5/reference/modelling/model-configuration.md","versioned":true,"version":"2.5","kind":"reference","pagePath":"/reference/modelling/model-configuration","chronology":{"prev":{"name":"Model Context","path":"/reference/modelling/model-context"},"next":{"name":"Global State","path":"/reference/modelling/globals"}},"lastUpdated":"2026-04-21T13:56:54.862Z"}}