SIMarchitect Installation Guide

From OpenMBD
Jump to: navigation, search

This page is a guide to installing SIMarchitect to MATLAB. This requires MATLAB version 2015b or higher. Note: Older MATLAB versions may work, but have not been tested.

Install

Note: If another version of SIMarchitect has been installed prior to this installation, it must be deleted. To do this properly, follow the Uninstall Guide.

1. Download the desired version of SIMarchitect from the repository.

2. Unzip this file in the desired location on your PC. To unzip, enter that password that has been delivered by the SIMarchitect administrator. This location will be the path that is added to MATLAB for use of SIMarchitect.

3. Open MATLAB version 2015b or higher and navigate to the path where SIMarchitect has been placed.

4. Type SIMarchitect in the command window of MATLAB (case-sensitive). This will initialise the installation of SIMarchitect and add a file under general/library/functions called SIMarchitect_root.m.

SIMarchitect root.png


5. To run SIMarchitect, type SIMarchitect in the command window again and the start-up window will open.

For a guide on using SIMarchitect, go to SIMarchitect Tutorial.

Uninstall Guide

To uninstall SIMarchitect, or remove a previous version, follow these steps:

1. Close all MATLAB/Simulink and SIMarchitect windows.

2. Navigate to the SIMarchitect programme files location (outside MATLAB) and go to location *SIMarchitect root*/general/library/functions.

3. Find the file SIMarchitect_root.m and delete this.

4. Next open MATLAB and delete the location of SIMarchitect from the path. Do this by either using command path to see a list of active path locations and use rmpath to remove these locations. Or, navigate to the location using the MATLAB 'Current Folder' window. When the SIMarchitect root path is located, right-click and select 'Remove from path' -> 'Selected Folders and Subfolders'. This removes all SIMarchitect components from the MATLAB path.

5. Optional: Delete the SIMarchitect folder in totality. This is not necessary, but may have preference to keep the file structure organised.