Show / Hide Table of Contents

A quickstart guide to SyncroSim Studio

This quickstart tutorial will introduce you to basics of working with SyncroSim, using a simple demonstration model for generating sales forecasts of hybrid and electric vehicles. The steps we will lead you through include:

  • Installing a package
  • Creating a new library
  • Viewing and editing model datafeeds
  • Running a model
  • Analyzing the results

As you complete this introduction you will also become familar with the Library Explorer, the Run Monitor, and the Time-Series Chart Window.

Note

This Quickstart Guide uses SyncroSim Studio for Windows, and assumes that you've already installed the necessary software on your computer. Click here if you haven't yet installed the software.

Step 1 - Install the Demo Sales package

The first step in using SyncroSim is to install one or more SyncroSim packages. Each package specifies the model (i.e. calculations) to be run, including the format for all of the model's inputs and outputs.

For this demonstration we will use a simple package designed to generate sales forecasts, called the Demo Sales package. To install this package, go to the File menu and choose Local Packages. This will open the Package Manager window.

alt text

The Package Manager displays all the SyncroSim packages that are already installed on your local computer. If the Demo Sales package does not already appear in this list, click the Install from Server... button. This button will show you a list of all the available packages on the SyncroSim Online Package Server not yet installed on your local computer. Click the check-box for the demosales and then click OK.

alt text

You should now see the demosales displayed in the Package Manager shown in the first image above.

Step 2 - Download the Demo Sales Basic library

Having installed the demosales, you are now ready to open your first SyncroSim library. A library is a file (with extension .ssim) that contains all of your model inputs and outputs. Note that the format of each library is specific to the package for which it was initially created.

First, navigate to the landing page for SyncroSim Cloud, and click Explore to access all Public Libraries. Scroll down, or use the search bar, to find the Demo Sales - Basic library. Click on the Download icon to download a backup of the library, called "Demo Sales - Basic.ssimbak".

Next, open SyncroSim Studio. Under the File menu, select Open. From the File Explorer, navigate to the *Demo *Sales - Basic* template library and select this file to open.

alt text

When prompted, name the library Demo Sales, and Save it in your preferred file location.

The Demo Sales - Basic library will be extracted from the backup file and loaded into the Library Explorer. If the current library is not up to date, you will be prompted with an Update Library window. Click Apply to update.

Step 3 - Review the model inputs

Model inputs in SyncroSim are organized into scenarios, where each scenario consists of a suite of values, one for each of the model's required inputs.

Note

Normally you begin by creating a new scenario and then adding data to it. However, the Demo Sales - Basic library you downloaded from SyncroSim Cloud is a complete library and already contains two pre-configured scenarios with model inputs. These inputs correspond to sales data for electric and hybrid vehicles.

Library Explorer

As shown in the image above, the library you have just opened contains two scenarios, each with a unique ID. The first of these scenarios (with ID=1, as shown above in square brackets) is named Expected future sales - past trends continue; this scenario contains a suite of model inputs corresponding to the assumption that future car sales will continue as in the past. The second scenario (with ID=2) is named Expected future sales - increased demand for electric and contains model inputs corresponding to the alternative assumption that sales for electric vehicles will increase over time.

To view the details of the first of these scenarios:

  • Select the scenario named Expected future sales - past trends continue in the Library Explorer.
  • Double-click or right-click and choose Open from the context menu to view the details of the scenario.

This opens the Scenario Properties window.

Scenario Properties

The first tab in this window, called General, has three nodes: Summary, Pipeline, and Datafeeds. The Summary node displays some generic information for the scenario; the Pipeline node is used to tell SyncroSim which models to run and in which order; and the Datafeeds node lists all the existing datafeeds at the scenario-scope and displays which ones contain data. Next, the Demo Sales tab includes two nodes (Forecast Settings and Annual Sales) that display the values assigned to this scenario for each of the model's two input datafeeds.

The Annual Sales datafeed is shown below.

alt text

SyncroSim provides you with several alternatives for moving tabular and raster data in to and out of your library, including built-in support for import/export using Microsoft Excel. You can learn more about modifying data within SyncroSim in our Editing Data guide.

Note

The contents of each scenario are editable. You can also make a copy of a scenario using the Copy-Paste commands under the Edit menu. If you make changes to any of the contents of your library, select Save from the File menu to save your changes.

Step 4 - Run the model

You are now ready to Run one or more of your scenarios.

alt text

To Run a Model:

  • Select a scenario in the Library Explorer.
  • Click the Run alt text button in the toolbar.

When you click the Run button, the Run Monitor will appear and show you the status of the currently running scenarios. (You will also see a Progress Bar in the lower-left of the Main Window while the model is running.)

When the Run is finished, the Run Monitor will indicate that the scenario's status is Done.

alt text

Step 5 - Analyze the results

Once the Run is complete you are ready to analyze the results.

alt text

First, however, note the changes that have occurred in the Library Explorer. If you expand the nodes below the scenario you just ran you will see that it now has a new Results folder containing a new scenario. This scenario is called a results scenario. To visualize the results scenario properties, double-click it or right-click and choose Open from the context menu.

Note

Everytime you run a scenario, SyncroSim will create a new results scenario with a name that is date/time stamped. As with other scenarios, a results scenario is identified with a unique scenario ID in square brackets. These values are automatically generated by SyncroSim when the scenario is first created and cannot be edited. Each results scenario contains both the output for the run and a snapshot read-only copy of the model inputs at the time of the run.

Results Explorer

To analyze result scenarios in SyncroSim Studio you use the Results Viewer at the bottom left corner of the screen.

The image above shows the Results Viewer for our Demo Sales library. There are already two pre-configured charts available: Gross Revenue by Item and Units Sold by Region (Hybrid Type only). These charts were created using the Time-Series Charting tool, which is the only tool available in the Results Viewer for this type of library. For libraries that contain spatial data, an additional Maps tool also appears as a tab on the Results Viewer.

This tool can be used to create new charts or open existing charts. To create a new chart, you can click on the New symbol in the Results Viewer (see image below). For more information, see Creating a Chart. For this tutorial, you will open existing charts for visualizing the results of your model run.

Create a new chart

To open an existing Chart:

  • Select the Gross Revenue by Item Chart in the Charting tool as shown above.
  • Double-click it or click the Open button on the right side of the toolbar.

You can now view the results of running your scenario through the model from the demosales package. If you repeat Steps 4 and 5 again for the second scenario in your library, your charts will automatically compare the results of both scenarios.

alt text

Note

When you are analyzing the results of a run, you are actually analyzing one or more result scenarios. You can add or remove results scenarios by selecting a scenario in the Library Explorer and then choosing either Add to Results or Remove from Results under the scenario tab or by right-clicking on the scenario and selecting your choice from the context menu. Scenarios currently selected for analysis are highlighted in bold, and will display a red checkmark in the Library Explorer.

What's Next?

  • Learn about using SyncroSim with Conda by exploring the Conda Tutorial
  • Take a look next at the some of the How-To-Guides
  • Learn how to create your own SyncroSim Package
  • Find out more about using the R or Python Programming Languages with SyncroSim
In this article
Back to top Copyright 2007-2025 Apex Resource Management Solutions Ltd.
Generated by DocFX