Getting Started

Main Page > Technical Documentation > Getting Started

File Structure

The file structure for a SwashSim simulation project consists of the following:
 * A project file (*.ssim): This file contains project settings, such as simulation duration and random numbers seeds, and file paths to supporting parameter and data files.
 * A network data file (*.nwf): This file contains the information pertaining to the physical definition of the network (links, nodes, etc.).
 * A signal data file (*.xml): This file contains the signal phasing and timing information for all signal controllers present in the network.

All of these files are in an XML (eXtensible Markup Language) format. XML is a simple text-based format. Thus, these files can be opened outside of the SwashSim program in any text editor application and manually viewed and edited, if desired. After you have installed the program, double-click on the SwashSim icon on your desktop or within the ‘Start’ menu. Alternatively, you can navigate to the installation folder and double-click on ‘SwashSim.exe’ to start the program.

Starting/Opening Project From the start screen, select either ‘New Project’ or ‘Open Project’. If you select ‘New Project’, you will then need to select the desired facility type, and then click the ‘OK’ button (see Figure below). Alternatively, you can double-click on a facility type with the left mouse button and the main input screen will then be loaded. If you select ‘Open Project’, you will be presented with a dialog for selecting a project file (see Figure below).

Saving a Project