Show / Hide Table of Contents

Creating packages: Overview

In most cases a SyncroSim package involves two parts: (1) an XML configuration file defining the inputs and outputs for a particular model, and (2) the code required to transform the model's inputs into outputs.

Note

This "Creating packages" tutorial build the basic helloworld package. The final package files can be downloaded from the following repositories:

  • R: https://github.com/ApexRMS/helloworld
  • Python: https://github.com/ApexRMS/helloworldPy

For a SyncroSim package, the model code can take many forms. For example:

  • New models are directly supported in any .NET language (e.g. C#, VB.Net, F#).
  • Existing models can be wrapped and take advantage of SyncroSim's automatic data management.
  • There are packages for both R and Python to make it easy to write models in these programming languages.

SyncroSim packages can be shared with others in one of two ways:

  • By making the package available as a file (with an extension of .ssimpkg).
  • By submitting the package to the SyncroSim Online Package Server, where approved packages are listed and then available for automatic download from within SyncroSim.

What's next?

  • Begin by building a package from scratch.
  • Next add a model to your package.
  • Then define data associated with the inputs and outputs of your package.
  • Finally add conda environments to your package.
Note

All of these articles assume that you are familar with the Windows or Unix command-line and with the SyncroSim Package Manager command-line utility. Some familarity with SyncroSim and XML is also assumed.

In This Article
Back to top Copyright 2007-2025 Apex Resource Management Solutions Ltd.
Generated by DocFX