A MUSICX model consists of two parts - a project and one or more scenarios. A project is a collection of one or more scenarios. It identifies the project name (also the file name), description, and any scenarios associated with the project. You can only have one project file open at a time, and you should not open the same project file using more than one copy of MUSICX.
A scenario is the representation of a node-link network in MUSICX and, describes the major processes in a catchment that are modelled. You can create multiple scenarios to:
- Break complex projects into distinct parts; or
- Duplicate existing scenarios to conduct what-if scenario without disrupting the original.
Projects
Creating a new project
To create a new project, do one of the following:
- Choose ;
- Click New Scenario on the File toolbar; or
- Press Ctrl+N on your keyboard.
You can only have one project file open at a time. Do not try to open the same project file using more than one copy of MUSICX because you may lose your work.
In the resulting window (Figure below), enter the following:
- The scenario name. Once again, provide a meaningful name or accept the default. All the scenarios in a project must have unique names;
- Choose the desired kind of scenario (refer to Scenario Types for the different types available); and
- Click OK.
Saving a project
To save an open project, choose . This saves a project file with the extension *.mxproj. If it is the first time you are saving your project, the Save As dialog opens and gives you the opportunity to choose the location and name of your project file. By default, the name of the file is the name of your project. If you wish to save a different version of your file, choose
Note: Despite the *.mxproj file extension, MUSICX project files are *.zip archives. Because of this, you should be careful when sending project files as email attachments, or when downloading project files from web-based sources using the HTTP protocol. Email filters often do not allow *.zip files when they cannot interpret the contents, and both servers and browsers often unpack *.zip archives after downloading them.
Closing an open project
To close an open project, choose . This closes the current project and prompts to save your work (Figure below). Click the appropriate button.
Opening an existing project
To open an existing project, either:
- Choose File » Open Projector
- Click Open Project on the File toolbar.
This opens the standard Windows™ open dialog. Note that opening a new project prompts you to save any open project.
Copying projects
You can duplicate existing projects by copying them. In your local machine's File Explorer, select the desired project, right-click and choose Copy. In the target location, right-click and choose Paste.
Scenarios
Scenario types
Four scenarios have been described in this guide:
- A schematic scenario is primarily concerned with modelling longer time-scales;
- An operations scenario is primarily concerned with shorter time-scales. It utilises facilities for forecasting and working with unaccounted differences, and typically makes heavy use of the Tabular Editor; and
- A catchments scenario which deals with the management of upland catchment processes. It is usually constructed using the Geographic Wizard for catchments which is a structured sequence of steps that guides you through the construction process.
- A single catchment scenario builder allows to build a simple catchment scenario to be used for testing purposes.
It is important to choose the correct type of scenario before you start building your model. Although a project can contain several scenarios, a scenario type is fixed once it is created and cannot be changed later. Note that scenarios are independent of each other; a change in one scenario does not impact another scenario.
The operations described for a project (above) are also available for scenarios. In addition, you can also import and compare scenarios.
Note: The Scenario Import and Scenario Difference tools can only be used for scenarios that have been created in the version you are currently using, or in previous versions.
Working with scenarios
Scenario management
Various menu items allow you to manage scenarios at a high-level.
- When running different scenarios, you can use scenario input sets to set values for input parameters. Choose Edit » Scenario Input Sets...;
- Tools » Export summary... allows you to save a text archive of the chosen scenario to a .csv file; and
- Feature Table (accessible via Edit » Feature Table...) provides an overview of the selected scenario, and can be used to edit component parameters.
Creating a scenario
Note: You can only create a schematic or catchments scenario using the method outlined below. To create a forecasting scenario, refer to Forecast scenarios.
A project must contain at least one scenario. Whenever you create a new project, you are also prompted to create a scenario. You can create additional scenarios using any of the following methods:
- Choose
- Click New Scenario on the File toolbar; or
- Click New Scenario (by menu) on the Project Explorer toolbar.
To create an Operations scenario, first create a Schematic scenario. Then, choose Tools » Rivers Operations
Opening a scenario
When a project only contains one scenario, that scenario is opened automatically when you open the project. However, when a project contains more than one scenario, you must open each scenario individually. To view a scenario that is contained within a project, double click the scenario name from the list in the Project Hierarchy. This opens the appropriate editor for the selected scenario, and changes the scenario name to a bold appearance so that you know it is the current, or active scenario.
You can also select a scenario from the list of loaded scenarios on the View menu. Selecting a scenario from the list makes it active.
Source supports backward compatibility for projects created in Source after v3.1.0.
Note: You must upgrade a project if it was created in Source v3.1.0 or earlier. If you open these projects in later versions of Source, an error message (shown in Figure 5) will appear prompting you to save in v3.1.0. Follow the steps outlined in the dialog to automatically upgrade the project to the current version of Source.
Figure 5. Opening a project, error
Copying a scenario
You can duplicate existing scenarios, provided they are part of the same project. You may want to do this if you wish to experiment with variations without affecting your original scenario.
Note: To copy only certain network elements, refer to Copying network elements.
To duplicate a scenario, click Copy Scenario on the Project Explorer toolbar. Source makes a copy of the current scenario and asks you to name the copy (as shown in Figure 6). You can either accept the proposed name or supply one of your own. Keep in mind that scenario names must be unique within a project.
The new (copied) scenario will be a duplicate of the original at the time of the copy.
Figure 6. Copy Scenario
Renaming a scenario
Source automatically gives new scenarios the default name of "Scenario #n" , where n is a number. To rename a scenario:
- Select the scenario in the Project Hierarchy; and
- Once the scenario name is selected, pause then click again. When the entry is highlighted, you can enter a new name. Remember that scenario names must be unique within a project.
Linking scenarios
You can link two scenarios using a Connecting Models. Note that some components of the first scenario may not pass on to the second, linked scenario.
Comparing Scenarios
The full version of Source has functionality for determining the difference between scenarios. For more information please see Troubleshooting and Debugging.
Copying network elements
When copying a partial scenario, the effect on each network element is different, see Nodes and Links - Copying and pasting.
Audit Log
The audit log keeps track of the changes made to a project over time. This is particularly important for projects that are worked on by multiple people. It contains a combination of software generated information on model changes and provides an opportunity for users to annotate the purpose of those changes with a commit message when the project is saved.
Figure 7. Audit Log Commit Message
Commit messages are used to group software generated logs in a way that makes sense to users working on the project. If the same issue is being worked on in multiple concurrent sessions, you can select Merge with current task to group the logs under the previous commit message.
Figure 8. Audit Log Viewer
A large audit log attached to a project can become a processing burden, especially in the case of large projects. Audit logging is on by default, but can be disabled in Edit »Project Options» Audit Log Settings by toggling off Enable Logging.
Figure 9. Project Options, Audit Log Settings
Click Clear Audit Log to delete all existing entries in the audit log. This can be useful if you have finished one stage of modelling (eg. building your model) and now want to monitor the changes made to the project from this point forward. Before clearing the log you can export the existing entries by opening the Audit Log Viewer (select View » Audit Logs...), right-click on a cell and choose Copy All and paste contents into a text file or Excel file.
It is possible to permanently turn on the audit log, by toggling on Force Comment on Save. You will no longer be able to toggle Enable Logging, and Clear Audit Log will also be disabled. This is a permanent project change, and you will receive several warning messages asking you to confirm before the change is made.