deephaven.start_jvm

Utilities for starting the Deephaven JVM.

start_jvm(devroot=None, workspace=None, propfile=None, keyfile=None, verbose=False, skip_default_classpath=None, java_home=None, jvm_dll=None, jvm_maxmem=None, jvm_classpath=None, jvm_properties=None, jvm_options=None, config_file=None, config=None)

Starts a JVM within this Python process to interface with Deephaven.

This is a small convenience wrapper around jpyutil.init_jvm(). Additionally, the Configuration is loaded and and Deephaven classes are brought into Python.

Parameters

  • devroot – the devroot parameter for Deephaven. Defaults to the ILLUMON_DEVROOT environment variable, or /usr/illumon/latest

  • workspace – the workspace parameter for Deephaven. Defaults to the ILLUMON_WORKSPACE environment variable

  • propfile – the Configuration.rootFile parameter for Deephaven. Defaults to the ILLUMON_PROPFILE environment variable

  • keyfile – your private key file for authenticating to Deephaven

  • skip_default_classpath – if True, do not attempt to compute default java classpath

  • verbose – if True, print out the classpath and properties we have constructed

The rest of the parameters are passed through to jpyutil.init_jvm(). The values for jvm_classpath and jvm_properties may have been modified based on the values of other arguments.

Parameters

  • java_home – The Java JRE or JDK home directory used to search JVM shared library, if ‘jvm_dll’ is omitted.

  • jvm_dll – The JVM shared library file. My be inferred from ‘java_home’.

  • jvm_maxmem – The JVM maximum heap space, e.g. ‘400M’, ‘8G’. Refer to the java executable ‘-Xmx’ option.

  • jvm_classpath – optional initial classpath elements. Default elements will be appended unless skip_default_classpath is specified

  • jvm_properties – inserted into the dictionary generated by devroot, workspace, propfile, and keyfile.

  • jvm_options – A list of extra options for the JVM. Refer to the java executable options.

  • config_file – Extra configuration file (e.g. ‘jpyconfig.py’) to be loaded if ‘config’ parameter is omitted.

  • config – An optional default configuration object providing default attributes for the ‘jvm_maxmem’, ‘jvm_classpath’, ‘jvm_properties’, ‘jvm_options’ parameters.