Starting Patchworks

There are a suite of applications available with your copy of the Patchworks software for data preparation, presentation and analysis of model output. All of these applications are explained in the User Guide, however in this tutorial we will take a look at Patchworks itself.


We will start Patchworks interactively using the Application Launcher tool. Select the Application Launcher from the Spatial Planning Systems folder in the Windows Start menu (see figure below).

After selecting the Application Launcher program option, the Application Launcher dialog will appear (Figure 1, “The Application Launcher dialog.”).

Figure 1. The Application Launcher dialog.

The Application Launcher is the starting point to launch the Patchworks model and all other Patchworks tools.

  1. Scroll to the very bottom of the list and select Patchworks.

The amount of memory required will change depending on the application being used or the complexity of the dataset. A scroller is provided to adjust the amount of memory available to the application. For our sample problem we can use just 400Mb.

  1. At the memory size box scroll or type in at least 400Mb.

  2. Choose Go to start Patchworks.


Setting the maximum amount of memory depends on the amount of available memory and on the operating system being used. If available the maximum amount of memory allowed for a 32bit system is 1500M however it is important to save at least 200M for the operating system itself. On a 64bit system the maximum depends on the amount of installed memory, but at least 200M must still be reserved for the operating system.

As Patchworks initializes it loads data from a number of files (polygon boundaries, stand dynamics). The data preparation for these files must be done in advance. At this stage the Patchworks model needs to know the initial settings to be used in the model, including where to find these necessary files.

All this information is included in a Patchworks INput file, known as the PIN file. A PIN file for the C5 dataset has been included with your sample dataset, all we need to do is find it! This file will tell Patchworks where the dataset files are located, what reports we would like to produce and what map layers should be available. A detailed discussion of PIN files is found in the section called “The PIN file”.

  1. Click on the folder icon to open a file chooser dialog.

Figure 2. The PIN file dialog.

Patchworks requires a PIN file to start the model.

  1. Select C:/Program Files/Spatial Planning Systems/Patchworks /sample/ analysis/ and click Open to continue.

  2. Select Finish in the Patchworks loading wizard to complete the process.


You can use the drag-and-drop to select the PIN file in the Windows file explorer and drop it on to the Input File field or on to the Patchworks Application Launcher. Drag-and-drop on to the Application Launcher works with several file types (PIN files, Beanshell scripts, SHP files, CSV and DBF files).

After you have clicked on the Finish button Patchworks displays a loading progress panel while the model is loading (Figure 3, “The Patchworks loading progress dialog.”). If errors are encountered during the loading process error messages will be displayed in a popup dialog and/or at the console window. [4].

Figure 3. The Patchworks loading progress dialog.

The Patchworks loading progress dialog will show all the files that Patchworks is loading. If there are any input dataset errors, this is the time where they will pop up. When the loading is complete, this box will disappear and the main Patchworks viewer will be presented.

[4] If you encounter any errors or have any problems with this tutorial please contact Technical Support.