Package Manager

The Package Manager lets you install, update, and remove SyncroSim Packages. To access the Package Manager, choose Packages... from the File menu. There is also a command-line version of the Package Manager.

Note

The Package Manager shows a list of the currently installed Packages.

Installing a Package

There are three ways to install a new Package:

1. Using the SyncroSim Online Package Server

To install a Package directly from the SyncroSim Online Package Server, click the Install... button in the lower-left of the Package Manager. This will open the Install Package dialog where you can choose from a list of Packages to install. Select the Packages you want to install and click OK.

Note

The Install Package dialog shows a list of the Packages that are not currently installed.

2. Installing from a Package File

You can also install a Package that you have previously downloaded and saved to a file from the SyncroSim Online Package Server or elsewhere. SyncroSim Packages are always single files with the extension .ssimpkg. To install a Package from a file, click the Install from File... button in the upper-right of the Package Explorer screen. Navigate to the Package you want to install and click OK.

3. Installing from a Package Folder

The final way to install a Package is by pointing SyncroSim to a local folder containing an XML configuration file, known as the package.xml file, as well as any model scripts or additional files required by the Package. This method allows Package developers to deploy a Package to SyncroSim without the extra step of bundling it into a .ssimpkg file. It also allows users to install custom Packages by pointing SyncroSim to local GitHub repositories or working folders. To install a Package from a folder, click the Install from Folder... button in the upper-right of the Package Explorer screen. Navigate to the Package folder you want to install and click OK.

Updating a Package

If a more recent version of one of your installed Packages is available on the SyncroSim Online Package Server, you can update it automatically. To see if there is an update for one of your Packages, click the Update... button. This will open the Update Package dialog where you can choose from a list of Packages to update. Select the Packages you want to update and click OK.

Removing a Package

You can remove one of your installed Packages by selecting it and clicking the Remove button.

Warning

Removing a Package will prevent SyncroSim from opening any existing Libraries that depend on this Package. If this happens, however, you can always re-install the Package.

Note

If you try to install, remove, or update a Package that is currently in use by the system, that Package will Queued for processing the next time you start SyncroSim. When there is at least one queued Package, the Queues... button will be visible in the lower-right of the Package Manager window. If you click this button, the Queued Packages window will appear and let you remove Packages from the installation and removal queues.