Using packages

The first step in using SyncroSim is to load a SyncroSim package. Each package provides SyncroSim with a roadmap to the data and model calculations for your particular problem. Several packages exist already for SyncroSim, many of which are available for download from the SyncroSim Online Package Server. Once packages are installed, they will appear in the File > Local Packages as illustrated below. If a SyncroSim package doesn't already exist for your needs, you can easily create your own package.

Package structure

Each package provides SyncroSim with two things: (1) an XML configuration file specifying the format of all the inputs and outputs for the model, and (2) the actual code required for the model to transform its inputs into outputs. Once you install the SyncroSim package for a particular model, SyncroSim will then let you create library to store the inputs and outputs associated with that model.

Tip

Existing stand-alone models, written in any language, can also be deployed as SyncroSim packages. Generally this requires including additional code (e.g. in R, Python or C#) with the package to "wrap" the existing model, in order to translate the inputs and outputs between SyncroSim's structured format and the model's pre-existing format.

Adding a package to your library

You can then choose a SyncroSim package for your library by either right-clicking the library name and selecting Open, or double-clicking the library name, and navigating to General > Packages window. Selecting Add in the bottom-right corner will allow you to add any previously installed packages to your library. This choice will lock-in the structure of the library, such that the library can then store all of the input and output datasheets required by the package.

Note

As each package has different inputs and outputs, a library can only ever be used with the package for which it was created. Furthermore the library's package cannot be changed.

Choose a template library from SyncroSim Cloud

Optionally, you can also download a template library containing pre-configured data from SyncroSim Cloud, and customize it accordingly.

Creating packages

Follow a series of tutorials that guide you through the process of creating your first SyncroSim package.