Skip to main content

Update your Engine

To update your Engine, download the installer for the new version, shut down your existing Engine, and then run the installer on your simulation machine. The installer upgrades your existing Engine in place, and your configuration is kept.

Step 1 - Download the installer​

Two versions of the Engine are usually available:

  • Latest: The latest production release. Recommended for most users.
  • Pre-release: An early access release that includes upcoming features. It is intended to give users access to upcoming features for the purpose of evaluation and feedback.

You can download the installer in either of the following ways. Both give you the same file, so use whichever is more convenient.

Option 1: From the web app​
  1. Log in to the gridmo web app and select Downloads from the menu on the left.
  2. Under Engine installers, click Download on the version you want.
  3. If you downloaded the installer on a different computer, copy it to the simulation machine where your Engine is located.
screenshot of the Downloads page in the gridmo web app showing the Engine installers
Option 2: From the Engine​

When a new version is available, your Engine will show an Update Engine button below the gridmo logo.

  1. Click Update Engine. A window will open showing your current version and the versions available to download.
  2. Select the version you want and click Download.
  3. The installer will download in your web browser.
screenshot of the gridmo Engine with the Update Engine button highlighted and the Update Engine window open

Step 2 - Shut down your Engine​

You must shut down your Engine before running the installer. There are two ways to shut down the Engine:

  • Option 1: Allow current Tasks to finish running
    • Click the Run new Tasks slider button on the Engine so the Engine status is 'PAUSED'. The Engine will be prevented from launching new Tasks.
    • Wait until the Engine is running zero Tasks. The Engine will display '0' workers running in the 'Status' section.
    • Close the Engine using the X in the top right corner.
  • Option 2: Immediate shut down
    • Close the Engine using the X in the top right corner. Note that this will cancel all in-progress Tasks.
caution

All Tasks in a simulation must be run on the same Engine version. A simulation cannot be split across Engine versions, so if a simulation is still in progress when you update, its remaining Tasks will fail once they start on the new version. Wait for any in-progress simulations to finish before updating your Engine.

Step 3 - Run the installer​

Make sure your Engine has been shut down (see Step 2), then on the simulation machine, double click the installer (.msi file) you downloaded in Step 1 and follow the prompts.

If you encounter errors during the update​

If any errors are identified during the update, we recommend running the Launch gridmo setup wizard located within the gridmo Engine installation directory to launch the Engine configuration wizard (click for details). The Engine will auto-detect your existing configuration file and some values will be pre-filled.

Once the Engine configuration wizard is complete and closed, double click the gridmo Engine shortcut on desktop to launch the new version of the gridmo Engine.