How To: Use DSim Outside of DSim Desktop

One of the advantages of DSim Desktop is that it sets up the terminal shell used for running DSim so that you do not have to worry about the details involved in making that happen. Once you have become proficient on how DSim works within DSim Desktop, you may want to run DSim in a terminal shell outside of DSim Desktop, so that it can be included in your own scripts. This article explains what is needed to run DSim outside of DSim Desktop.

Procedure

1. Navigate to the DSim installation folder:

• Windows: C:\Users\<username>\AppData\Local\metrics-ca\dsim\<version>
• Linux: $HOME/metrics-ca/dsim/<version>

2. In your shell, run the shell_activate script appropriate for it.

• .\shell_activate.ps1 for PowerShell
• source shell_activate.bash for Bash

This activates DSim for the current shell only.

3. Optionally, you can activate DSim for future shell sessions by including the appropriate script in your PowerShell profile or .bashrc configuration file.

4. Set the environment variable DSIM_LICENSE to point to your license file.

a) If you want to use DSim from both inside and outside DSim Desktop, name the license file dsim-license.json, put it in the default location below, and:

• In Windows, set DSIM_LICENSE to: C:\Users\<user>\AppData\Local\metrics-ca\dsim-license.json
• In Linux, set DSIM_LICENSE to: $HOME/metrics-ca/dsim-license.json

b) If you want to use DSim from only outside DSim Desktop, name the license file with a .json extension, put it where you want, and set DSIM_LICENSE to point to it.

See Licensing to generate your license file.

5. Use the DSim commands in the DSim User Manual as if you're working on-prem.