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

Introduction

\n

This tutorial covers the basic steps to running the Simudyne SDK via a Python Subprocess and from a Jupyter Notebook. Models built in the Simudyne SDK are packaged as executable Java JAR files, meaning they can be run from the command line or from a subprocess in another application.

\n

Variations in Local Environment

\n

Note that Jupyter Notebook and the Python Subprocess libraries are not supported by Simudyne. This tutorial is just one example of how to run your models with an external tool. If the example does not function in your local environment, using the basic guidance provided on running any executable Java JAR file should be the foundation to arriving at your solution. \n

\n

Sections covered

\n

This tutorial is structured in 3 sections:

\n
    \n
  1. Creating & Running an executable JAR
    2. \n
  2. Python subprocess
    3. \n
  3. Jupyter Notebook
    4. \n
\n

1. Creating & Running an executable JAR

\n

Creating a JAR

\n

The first step is to package, you will need to build a fat jar which will carry your model, the Simudyne SDK and all the necessary dependencies.

\n

More information on how to package your JAR file please reference the CLI Model Runner

\n

To package your Simudyne SDK model, run the below command from the project root.

\n

Maven

\n
mvn -s settings.xml clean compile package
\n

Maven will create the jar and place it in the target directory (unless you have specified otherwise in your pom settings). Unless you have given it a specific name, the generated jar will be named <some-artifact-id>-<some-version>-jar.

\n

Running a JAR

\n

Running the JAR can be done from the command line by executing the below command (pointing to the location of the packaged JAR):

\n

Running a JAR

\n
java -jar target/sample-artifact-1.1.0.jar
\n

The example above is a general example, for more info please reference the Running the model section of the CLI Model Runner section.

\n

2. Python subprocess

\n

Once the Simudyne SDK model has been packaged as an executable JAR file, it is possible to call this file via a Python Subprocess. It is recommended to read through the Python Subprocess Documentation before beginning this section.

\n

Before starting with the Python subprocess, a new MainNoConsole.java should be added to your project as it is recommended to have the SDK run headless for ease of returning results.

\n

The following Java code can be added to your project and customized to your model and inputs:

\n

MainNoConsole.java

\n
import org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\nimport simudyne.core.exec.runner.ModelRunner;\nimport simudyne.core.exec.runner.RunnerBackend;\nimport simudyne.core.exec.runner.definition.BatchDefinitionsBuilder;\n\nimport java.util.HashMap;\nimport java.util.Map;\nimport java.util.stream.Collectors;\n\npublic class MainNoConsole {\n    private static final Logger logger = LoggerFactory.getLogger(\"main\");\n\n    public static void main(String[] args) {\n        try {\n            RunnerBackend runnerBackend = RunnerBackend.create();\n            ModelRunner modelRunner = runnerBackend.forModel(MyModel.class);\n\n            Map<String, String> _config;\n            Map<String, Object> _input;\n            if(args.length == 2) {\n                _config = getConfigMap(args[0]);\n                _input = getMap(args[1]);\n            }\n            else {\n                // Default config and input parameters\n                _config = getConfigMap(\"simudyne.core.export-path=output\");\n                _input = getMap(\"MyInputs\");\n            }\n\n            String _seed = System.getProperty(\"seed\", \"12345678910\");\n            String _runs = System.getProperty(\"runs\", \"1\");\n            String _ticks = System.getProperty(\"ticks\", \"100\");\n            long seed = Long.parseLong(_seed);\n            int n_runs = Integer.parseInt(_runs);\n\n            long n_ticks = Long.parseLong(_ticks);\n            _input.put(\"nSteps\", n_ticks);\n\n            long startTime = System.currentTimeMillis();\n\n            BatchDefinitionsBuilder runDefinitionBuilder =\n                    BatchDefinitionsBuilder.create()\n                            .forRuns(n_runs)\n                            .forTicks(n_ticks)\n                            .forSeeds(seed)\n                            .withInputs(_input);\n\n            logger.warn(\"Simulation Starting...\");\n            modelRunner.forRunDefinitionBuilder(runDefinitionBuilder).withConfigMap(_config);\n            modelRunner.run().awaitOutput();\n\n            logger.warn(\"Simulation Complete.\");\n\n            long endTime = System.currentTimeMillis();\n            logger.warn(\"time for simulation = \" + (double)(endTime - startTime) / 1000.0 + \" s.\");\n\n            System.exit(0);\n        } catch (Exception e) {\n            e.printStackTrace();\n        }\n    }\n\n    public static Map<String, String> getConfigMap(String str) {\n        Map<String, Object> _map = getMap(str);\n        return _map.entrySet().stream() .collect(Collectors.toMap(Map.Entry::getKey, e -> (String)e.getValue()));\n    }\n\n    public static Map<String, Object> getMap(String str) {\n        Map<String, Object> _map = new HashMap<>();\n        if(str.isEmpty())\n            return _map;\n\n        for(String s0 : str.split(\",\")) {\n            String[] s1 = s0.split(\"=\");\n            if(s1.length != 2)\n                throw  new IllegalArgumentException(\"Unknown input format, \" + s0);\n\n            _map.put(s1[0], s1[1]);\n        }\n\n        return _map;\n    }\n\n}
\n

Now that the SDK model has been configured for headless mode, the code for the Python subprocess can be defined.

\n

Below is a provided utils.py Python module that can be imported, and whose functions can be called to run the Simudyne SDK and return the results. As mentioned above, there have been attempts to account for changes in your local environment, but it's possible this code will not function 'out of the box' on your machine.

\n

The first step is to create a notebook_settings.json file:

\n
{\n  \"sdk_path\": \"%PathToYourProject%\",\n  \"maven_repo\": \"%PathToYourM2%/.m2/repository\",\n  \"java_cmd\": \"java\"\n}
\n

The following Python Module can be imported into your Jupyter Notebook and called to run your simulations and analyse your results.

\n

utils.py

\n
import glob\nimport pandas as pd\nimport numpy as np\nimport subprocess\nimport shutil\nimport os\nimport platform\n\n\n#Run SDK using Popen - checks operating system and returns results\ndef run_sdk(params, maven_repo, java_cmd='java', debug=True, delete_tempfile=True):\n\n    _pwd = os.getcwd()\n    os.chdir(params['notebook_settings']['sdk_path'])\n\n    _config_export_path_250 = 'simudyne.core.parquet-export-path'\n    _repos = get_repos_2_5_0()\n    _parquet_path = params['config'][_config_export_path_250] if _config_export_path_250 in params['config'] else 'output'\n\n    if os.path.isdir(_parquet_path):\n        shutil.rmtree(_parquet_path)\n\n    _sep = None\n    if platform.system() == 'Windows':\n        _sep = ';'\n    elif platform.system() == 'Darwin':\n        _sep = ':'\n    else:\n        raise ValueError('{0} not supported.',format(platform.system()))\n\n    _config = [java_cmd] + ['-D{0}={1}'.format(k, params['vm'][k]) for k in params['vm']] + ['-classpath',\n                                                                                             _sep.join(['target/classes'] + ['{1}/{0}'.format(i, maven_repo) for i in _repos]),\n                                                                                             'MainNoConsole',\n                                                                                             get_input(params['config']),\n                                                                                             get_input(params['input'])]\n\n    if platform.system() == 'Windows':\n        o = subprocess.Popen(_config, stdout = subprocess.PIPE, stderr=subprocess.STDOUT)\n        if o.stdout != b'':\n            _o = o.stdout.read().decode('utf-8').split('\\n')\n            if debug:\n                [print(s) for s in _o]\n\n        if o.stderr is not None:\n            _o = o.stderr.read().decode('utf-8').split('\\n')\n            if debug:\n                [print(s) for s in _o]\n\n    elif platform.system() == 'Darwin':\n        o = subprocess.run(_config, capture_output=True, check=False)\n        if o.stderr != b'':\n            _o = o.stderr.decode('utf-8').split('\\n')\n            if debug:\n                [print(s) for s in _o]\n\n        if o.stdout != b'':\n            _o = o.stdout.decode('utf-8').split('\\n')\n            if debug:\n                [print(s) for s in _o]\n\n\n    _res = get_res(output_folder=_parquet_path)\n\n    if delete_tempfile:\n        shutil.rmtree(_parquet_path)\n\n    os.chdir(_pwd)\n\n    return _res\n\n#Get map of inputs \ndef get_input(_map):\n    return ','.join(['{0}={1}'.format(a, str(b).lower() if type(b) == bool else b) for a,b in _map.items()])\n\n\n#Return results from output path\ndef get_res(output_folder='output'):\n    _sep = None\n    if platform.system() == 'Windows':\n        _sep = '\\\\'\n    elif platform.system() == 'Darwin':\n        _sep = '/'\n    else:\n        raise ValueError('{0} not supported.',format(platform.system()))\n\n    res = {}\n    for f in glob.glob('{0}/**/*/*.csv'.format(output_folder), recursive=True):\n        _f = f.split(_sep)\n        _name = _f[-2]\n        _run = _f[-1].split('.csv')[0]\n        if _run not in res:\n            res[_run] = {}\n\n        df = pd.read_csv(f)\n        df = pd.concat({i: pd.Series(df.loc[i]) for i in df.index}, axis=1).T\n        df['time'] = pd.to_datetime(df['time'])\n        res[_run][_name] = df\n\n    run_ids = res.keys()\n    dataset_ = np.unique([list(res[k].keys()) for k in res])\n\n    return res, np.sort(list(run_ids)), dataset_\n\n\n\n\ndef get_repos_2_5_0() :\n    return [\n        'simudyne/simudyne-nexus-server_2.12/2.5.0/simudyne-nexus-server_2.12-2.5.0.jar',\n        'org/scala-lang/scala-library/2.12.8/scala-library-2.12.8.jar',\n        'simudyne/simudyne-core-exec_2.12/2.5.0/simudyne-core-exec_2.12-2.5.0.jar',\n        'com/jcabi/jcabi-aspects/0.22.5/jcabi-aspects-0.22.5.jar',\n        'com/jcabi/jcabi-log/0.17/jcabi-log-0.17.jar',\n        'org/aspectj/aspectjrt/1.8.7/aspectjrt-1.8.7.jar',\n        'javax/validation/validation-api/1.1.0.Final/validation-api-1.1.0.Final.jar',\n        'mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.26.jar',\n        'simudyne/simudyne-console_2.12/2.5.0/simudyne-console_2.12-2.5.0.jar',\n        'com/typesafe/akka/akka-actor_2.12/2.6.10/akka-actor_2.12-2.6.10.jar',\n        'com/typesafe/config/1.4.0/config-1.4.0.jar',\n        'com/typesafe/akka/akka-stream_2.12/2.6.10/akka-stream_2.12-2.6.10.jar',\n        'com/typesafe/akka/akka-protobuf-v3_2.12/2.6.10/akka-protobuf-v3_2.12-2.6.10.jar',\n        'org/reactivestreams/reactive-streams/1.0.3/reactive-streams-1.0.3.jar',\n        'com/typesafe/ssl-config-core_2.12/0.4.2/ssl-config-core_2.12-0.4.2.jar',\n        'org/scala-lang/modules/scala-parser-combinators_2.12/1.1.2/scala-parser-combinators_2.12-1.1.2.jar',\n        'com/typesafe/akka/akka-remote_2.12/2.6.10/akka-remote_2.12-2.6.10.jar',\n        'com/typesafe/akka/akka-pki_2.12/2.6.10/akka-pki_2.12-2.6.10.jar',\n        'com/hierynomus/asn-one/0.4.0/asn-one-0.4.0.jar',\n        'org/agrona/agrona/1.7.2/agrona-1.7.2.jar',\n        'com/typesafe/akka/akka-slf4j_2.12/2.6.10/akka-slf4j_2.12-2.6.10.jar',\n        'com/typesafe/akka/akka-actor-typed_2.12/2.6.10/akka-actor-typed_2.12-2.6.10.jar',\n        'com/typesafe/akka/akka-http_2.12/10.1.3/akka-http_2.12-10.1.3.jar',\n        'com/typesafe/akka/akka-http-core_2.12/10.1.3/akka-http-core_2.12-10.1.3.jar',\n        'com/typesafe/akka/akka-parsing_2.12/10.1.3/akka-parsing_2.12-10.1.3.jar',\n        'com/github/pathikrit/better-files_2.12/2.17.1/better-files_2.12-2.17.1.jar',\n        'com/github/pathikrit/better-files-akka_2.12/2.17.1/better-files-akka_2.12-2.17.1.jar',\n        'com/fasterxml/jackson/core/jackson-core/2.9.9/jackson-core-2.9.9.jar',\n        'com/fasterxml/jackson/core/jackson-databind/2.9.9/jackson-databind-2.9.9.jar',\n        'com/fasterxml/jackson/dataformat/jackson-dataformat-avro/2.9.9/jackson-dataformat-avro-2.9.9.jar',\n        'com/fasterxml/jackson/core/jackson-annotations/2.9.9/jackson-annotations-2.9.9.jar',\n        'com/fasterxml/jackson/module/jackson-module-scala_2.12/2.9.9/jackson-module-scala_2.12-2.9.9.jar',\n        'com/fasterxml/jackson/module/jackson-module-paranamer/2.9.9/jackson-module-paranamer-2.9.9.jar',\n        'org/json4s/json4s-native_2.12/3.6.9/json4s-native_2.12-3.6.9.jar',\n        'org/json4s/json4s-core_2.12/3.6.9/json4s-core_2.12-3.6.9.jar',\n        'org/json4s/json4s-ast_2.12/3.6.9/json4s-ast_2.12-3.6.9.jar',\n        'org/json4s/json4s-scalap_2.12/3.6.9/json4s-scalap_2.12-3.6.9.jar',\n        'org/json4s/json4s-jackson_2.12/3.6.9/json4s-jackson_2.12-3.6.9.jar',\n        'commons-io/commons-io/2.6/commons-io-2.6.jar',\n        'com/beust/jcommander/1.72/jcommander-1.72.jar',\n        'simudyne/simudyne-core_2.12/2.5.0/simudyne-core_2.12-2.5.0.jar',\n        'org/apache/commons/commons-math3/3.6.1/commons-math3-3.6.1.jar',\n        'org/apache/commons/commons-lang3/3.7/commons-lang3-3.7.jar',\n        'commons-dbcp/commons-dbcp/1.4/commons-dbcp-1.4.jar',\n        'commons-pool/commons-pool/1.5.4/commons-pool-1.5.4.jar',\n        'com/google/guava/guava/29.0-jre/guava-29.0-jre.jar',\n        'com/google/guava/failureaccess/1.0.1/failureaccess-1.0.1.jar',\n        'com/google/guava/listenablefuture/9999.0-empty-to-avoid-conflict-with-guava/listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar',\n        'org/checkerframework/checker-qual/2.11.1/checker-qual-2.11.1.jar',\n        'com/google/errorprone/error_prone_annotations/2.3.4/error_prone_annotations-2.3.4.jar',\n        'com/google/j2objc/j2objc-annotations/1.3/j2objc-annotations-1.3.jar',\n        'com/typesafe/scala-logging/scala-logging_2.12/3.9.0/scala-logging_2.12-3.9.0.jar',\n        'org/scala-lang/scala-reflect/2.12.4/scala-reflect-2.12.4.jar',\n        'org/scala-lang/modules/scala-java8-compat_2.12/0.9.0/scala-java8-compat_2.12-0.9.0.jar',\n        'org/eclipse/collections/eclipse-collections-api/9.2.0/eclipse-collections-api-9.2.0.jar',\n        'org/eclipse/collections/eclipse-collections/9.2.0/eclipse-collections-9.2.0.jar',\n        'au/com/bytecode/opencsv/2.4/opencsv-2.4.jar',\n        'org/apache/arrow/arrow-vector/0.12.0/arrow-vector-0.12.0.jar',\n        'org/apache/arrow/arrow-format/0.12.0/arrow-format-0.12.0.jar',\n        'org/apache/arrow/arrow-memory/0.12.0/arrow-memory-0.12.0.jar',\n        'joda-time/joda-time/2.9.9/joda-time-2.9.9.jar',\n        'com/carrotsearch/hppc/0.7.2/hppc-0.7.2.jar',\n        'io/netty/netty-buffer/4.1.22.Final/netty-buffer-4.1.22.Final.jar',\n        'com/google/flatbuffers/flatbuffers-java/1.9.0/flatbuffers-java-1.9.0.jar',\n        'com/google/protobuf/protobuf-java/3.6.0/protobuf-java-3.6.0.jar',\n        'io/netty/netty-common/4.1.42.Final/netty-common-4.1.42.Final.jar',\n        'com/typesafe/akka/akka-stream-typed_2.12/2.6.10/akka-stream-typed_2.12-2.6.10.jar',\n        'simudyne/simudyne-core-abm_2.12/2.5.0/simudyne-core-abm_2.12-2.5.0.jar',\n        'org/apache/parquet/parquet-avro/1.11.1/parquet-avro-1.11.1.jar',\n        'org/apache/parquet/parquet-column/1.11.1/parquet-column-1.11.1.jar',\n        'org/apache/parquet/parquet-common/1.11.1/parquet-common-1.11.1.jar',\n        'org/apache/yetus/audience-annotations/0.11.0/audience-annotations-0.11.0.jar',\n        'org/apache/parquet/parquet-encoding/1.11.1/parquet-encoding-1.11.1.jar',\n        'org/apache/parquet/parquet-hadoop/1.11.1/parquet-hadoop-1.11.1.jar',\n        'org/apache/parquet/parquet-jackson/1.11.1/parquet-jackson-1.11.1.jar',\n        'org/apache/parquet/parquet-format-structures/1.11.1/parquet-format-structures-1.11.1.jar',\n        'javax/annotation/javax.annotation-api/1.3.2/javax.annotation-api-1.3.2.jar',\n        'com/googlecode/concurrentlinkedhashmap/concurrentlinkedhashmap-lru/1.4.2/concurrentlinkedhashmap-lru-1.4.2.jar',\n        'simudyne/simudyne-core-graph_2.12/2.5.0/simudyne-core-graph_2.12-2.5.0.jar',\n        'it/unimi/dsi/fastutil/6.5.7/fastutil-6.5.7.jar',\n        'simudyne/simudyne-core-abm-testkit_2.12/2.5.0/simudyne-core-abm-testkit_2.12-2.5.0.jar',\n        'io/eels/eel-core_2.12/1.2.4/eel-core_2.12-1.2.4.jar',\n        'com/sksamuel/exts/exts_2.12/1.49.0/exts_2.12-1.49.0.jar',\n        'com/univocity/univocity-parsers/2.4.1/univocity-parsers-2.4.1.jar',\n        'com/h2database/h2/1.4.196/h2-1.4.196.jar',\n        'io/dropwizard/metrics/metrics-core/3.1.2/metrics-core-3.1.2.jar',\n        'io/dropwizard/metrics/metrics-jvm/3.1.2/metrics-jvm-3.1.2.jar',\n        'io/eels/eel-hive_2.12/1.2.4/eel-hive_2.12-1.2.4.jar',\n        'io/eels/eel-orc_2.12/1.2.4/eel-orc_2.12-1.2.4.jar',\n        'org/apache/orc/orc-core/1.4.0/orc-core-1.4.0.jar',\n        'io/airlift/aircompressor/0.3/aircompressor-0.3.jar',\n        'org/slf4j/slf4j-log4j12/1.7.25/slf4j-log4j12-1.7.25.jar',\n        'org/slf4j/slf4j-api/1.7.25/slf4j-api-1.7.25.jar',\n        'log4j/log4j/1.2.17/log4j-1.2.17.jar',\n        'org/apache/hadoop/hadoop-common/2.7.5/hadoop-common-2.7.5.jar',\n        'org/apache/hadoop/hadoop-annotations/2.7.5/hadoop-annotations-2.7.5.jar',\n        'commons-cli/commons-cli/1.2/commons-cli-1.2.jar',\n        'xmlenc/xmlenc/0.52/xmlenc-0.52.jar',\n        'commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar',\n        'commons-codec/commons-codec/1.4/commons-codec-1.4.jar',\n        'commons-net/commons-net/3.1/commons-net-3.1.jar',\n        'commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar',\n        'javax/servlet/servlet-api/2.5/servlet-api-2.5.jar',\n        'org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar',\n        'org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar',\n        'org/mortbay/jetty/jetty-sslengine/6.1.26/jetty-sslengine-6.1.26.jar',\n        'javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar',\n        'com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar',\n        'com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar',\n        'org/codehaus/jettison/jettison/1.1/jettison-1.1.jar',\n        'com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar',\n        'javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar',\n        'javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar',\n        'javax/activation/activation/1.1/activation-1.1.jar',\n        'org/codehaus/jackson/jackson-jaxrs/1.8.3/jackson-jaxrs-1.8.3.jar',\n        'org/codehaus/jackson/jackson-xc/1.8.3/jackson-xc-1.8.3.jar',\n        'com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar',\n        'asm/asm/3.1/asm-3.1.jar',\n        'commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar',\n        'net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar',\n        'org/apache/httpcomponents/httpclient/4.1.2/httpclient-4.1.2.jar',\n        'org/apache/httpcomponents/httpcore/4.1.2/httpcore-4.1.2.jar',\n        'com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar',\n        'commons-lang/commons-lang/2.6/commons-lang-2.6.jar',\n        'commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar',\n        'commons-digester/commons-digester/1.8/commons-digester-1.8.jar',\n        'commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar',\n        'commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar',\n        'org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar',\n        'org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar',\n        'com/google/code/gson/gson/2.2.4/gson-2.2.4.jar',\n        'org/apache/hadoop/hadoop-auth/2.7.5/hadoop-auth-2.7.5.jar',\n        'org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar',\n        'org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar',\n        'org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar',\n        'org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar',\n        'org/apache/curator/curator-framework/2.7.1/curator-framework-2.7.1.jar',\n        'com/jcraft/jsch/0.1.54/jsch-0.1.54.jar',\n        'org/apache/curator/curator-client/2.7.1/curator-client-2.7.1.jar',\n        'org/apache/curator/curator-recipes/2.7.1/curator-recipes-2.7.1.jar',\n        'com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar',\n        'org/apache/htrace/htrace-core/3.1.0-incubating/htrace-core-3.1.0-incubating.jar',\n        'org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar',\n        'io/netty/netty/3.7.0.Final/netty-3.7.0.Final.jar',\n        'org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar',\n        'org/apache/avro/avro/1.8.2/avro-1.8.2.jar',\n        'com/thoughtworks/paranamer/paranamer/2.7/paranamer-2.7.jar',\n        'org/xerial/snappy/snappy-java/1.1.1.3/snappy-java-1.1.1.3.jar',\n        'org/tukaani/xz/1.5/xz-1.5.jar'\n    ]
\n

Once these files have been added and adapted to your environment and model you can begin testing in a Jupyter Notebook.

\n

Jupyter Notebook

\n

In this section we will build a simple example from scratch to demonstrate how to call your model.

\n

Pull up a blank Jupyter Notebook and import your utils.py module and define the params for your model as below:

\n

MyNotebook.ipynb

\n
from utils import *\n\n#Load notebook settings\nwith open('notebook_settings.json', 'r') as f:\n    notebook_settings = json.load(f)\n    \nseed = 12345678910\nlevel = 'WARN' #for the logger\n\n#create dict of VM and input parameters\nparams = {\n    'vm': {'seed': seed, 'runs': 1, 'ticks': 100, 'level': level},\n    'config': {'simudyne.core.export-path': 'Output_{0}'.format(seed)},\n    'input': {'input1': 1, 'input2': 100, 'input3' : 1000},\n    'notebook_settings' : notebook_settings\n}
\n

Now that you have set the notebook_settings.json, VM params, and model input params you can call your run_sdk() function and return your results dict with the data from your runs:

\n

MyNotebook.ipynb

\n
res, run_ids, dataset_ = run_sdk(params, notebook_settings['maven_repo'], java_cmd=notebook_settings['java_cmd'])
\n

To better understand the structure/contents of the res, run_ids, and dataset_ return variables, reference the get_res() function in your utils.py file.

\n

Conclusion

\n

Running the SDK from an external tool requires the ability to call a Java executable JAR file. We provided this example in Python using Jupyter notebook as this is a popular analysis tool with users of the Simudyne SDK. Other languages and applications have similar features in place for running subprocesses or making callouts to Java and should likely have no problem running your Simudyne SDK models as well.

","headings":[{"value":"Introduction","depth":2},{"value":"Sections covered","depth":3},{"value":"1. Creating & Running an executable JAR","depth":2},{"value":"Creating a JAR","depth":3},{"value":"Running a JAR","depth":3},{"value":"2. Python subprocess","depth":2},{"value":"Jupyter Notebook","depth":2},{"value":"Conclusion","depth":2}],"frontmatter":{"title":"SDK with Jupyter Notebook","toc":null,"experimental":true}},"site":{"siteMetadata":{"title":"Simudyne Docs","latestVersion":"2.6"}}},"pageContext":{"absolutePath":"/home/vsts/work/1/s/content/2.5/reference/experimental/jupyter_notebook.md","versioned":true,"version":"2.5","kind":"reference","pagePath":"/reference/experimental/jupyter_notebook","chronology":{"prev":{"name":"System Messaging","path":"/reference/experimental/system_messaging"},"next":{"name":"Configuration","path":"/reference/configuration"}},"lastUpdated":"2026-04-21T13:56:54.861Z"}}