Projects and Scenarios

Owned by Mukta Sapkota
Last updated: 19 Oct 2023 by TeamcityVersion comment
4 min read

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 File » New » Project...;
  • 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 options available); and
  • Click OK.


Scenario types

  • MUSICX: This option creates a standard MUSICX scenario
  • MUSIC-link: This option creates a MUSIC model with embedded guidelines approved by local authorities. Please see here.
  • MUSIC-MSF Importer: This option is to import existing MUSIC model (MSF files) into MUSICX. Further details are here.

Saving a project

To save an open project, choose File » Save. 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 allows you 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 File » Save As... 

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 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 File » Close project. This closes the current project and prompts you to save your work (Figure below). Click the appropriate button.


Opening an existing project

To open an existing project, either:

  • Choose File » Open Project; or
  • 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

Creating a scenario

A project must contain at least one scenario. You are also prompted to create a scenario whenever you create a new project. You can create additional scenarios using any of the following methods:

  • Choose File » New » Scenario...;
  • Click New Scenario on the File toolbar; or
  • Click New Scenario (by menu) on the Project Explorer toolbar.

Opening a scenario

When a project only contains one scenario, that scenario is opened automatically when you open the project. However, you must open each scenario individually when a project contains more than one scenario. 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. 

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.
To duplicate a scenario, click Copy Scenario on the Project Explorer toolbar. MUSICX makes a copy of the current scenario and asks you to name the copy (as shown in Figure below). 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. 


Renaming a scenario

MUSICX 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.