Project Window

From SysCAD Documentation
Jump to navigation Jump to search

Navigation: User Guide ➔ Windows ➔ Project Window

Application Window Message Window Graphics Window Access Window Explorer Window Trend Window TagList Window Project Window

Latest SysCAD Version: 16 February 2024 - SysCAD 9.3 Build 139.34893


Introduction

The project structure is outlined in the Project Window.

To access the Project Window: Command Path: View - Project

The Project Window consists of five tab pages:

Files This is used to list all associated files for the current project.
Environment This is used to list the Location of project files
Conversions This is used to list all the engineering units available to the user.
RefTags This is used to list all the variables referenced by the PID controllers or Pgm files.

Notes:

  1. Caution: If you click on the X button on the top right hand corner of the dialog box, it is equivalent to the Close Project command, NOT the close dialog box. If you do not want to close the project, click on the cancel button when you are asked if you want to save the project.
  2. In Build139, user can right click on any of the file path or document in the Files or Environment list to get the "Open Containing Folder" popup option, clicking on this will activate the "Windows File Explorer", showing the folder or file of interest. If the document can be edited, then "Edit xxxxx" will also be visible on the right click popup.
    PrjWindowFiles139.png
  3. For the models list, please use the Explore Window.

Files List

Click on the Files Tab will open up the list of files generated or used by SysCAD for the opened project. The files in this window are grouped together for easy reference. A typical example is as follows:

PrjWindowFiles137.png RelativePath2.png
  • Most of the files in this window are for user information only.
  • Referenced text files such as Reaction and Control files are set up for direct editing.
  • The file structure also lists all units that are calling the reference text file.
  • If any reports are present, the excel file can be opened from this window as well.
  • Button Small 1.png: Double click on Project Report.xlsm will open the file in excel for editing.
  • Button Small 2.png: Double click on Oxidising.rct will open the file for editing. Double click on Autoclave2 will open the Access Window for the unit that uses the Oxidising.rct.
  • Button Small 3.png: Double click on Autoclave.mp will open the file for editing. Double click on Non_Oxidising_Leach will open the Access Window for the unit that uses the Autoclave.mp.

Note: The file list is not automatically updated, use the Refresh button to rebuild the list.

Models List

For the models list, please use the Explore Window.

Environment List

The environment page of the Project Window shows a list of relative path names used for folder/file paths.

PrjWindowEnvironment137.png BaseFiles: Basefiles folder. Must have write access.
BaseFilesUser : BasefilesUser folder. Must have write access. Stores User defined graphics symbols, conversions and ini files.
CfgFile : The name of the configuration file used by the project. (Path of the configuration file)
CfgFiles : The location of configuration file used by the project. (Path of the folder).
PrjFile : The name of the project starting file. (Path of the project file)
PrjFiles : The name of the project. (Path of the project folder).
ProgFiles : The location of the SysCAD executable and program files.
TemporaryFiles : Error logs, ini files, Local drive with write access
WorkFolder : Local drive with write access
TextEditor : Path of the text editor, used to write PGM files and so on.
ReactionEditor : Path of the reaction editor, used to write RCT files.


Conversion List

PrjWindowConversions137.png

The conversion units list displays all the Conversion types and units that are available in SysCAD. This list indicates the SI units and Default display units for each Conversion family. The Conversion family name is shown in square brackets next to the descriptive name.

The conversion table is stored in ..\SysCADxxx\Basefiles\Default.93.db3.

To add/modify the existing engineering units (excluding SI units), refer to Conversions Table for instructions.

In the example screenshot:

  1. The Conversion units displayed in the project will be taken from the 'Metric' group.
  2. The SysCAD SI unit for Mass Ratio is kg/kg.
    • This is also the current default Metric Conversion unit for mass ratio (shown in bold).
  3. Conversion units that are displayed with the word 'Hidden' to the right will not be visible in the 'Change Conversion' display.
  4. Available from Build 139.33513. Right click on the conversion will display some pop-up menu options, the options displayed may include the following:
    • Manage Conversion: Opens the "Manage Conversion Defaults and Display" dialog box.
    • Reset the units to preset defaults - available when selecting the group heading (e.g. Mass Ratio)
    • Set "unit" as Default
    • Hide/Show "unit"
    • Copy for PGM. For example, when declaring variables with conversion information in a PGM file, we may add ("MRatio", "kg/t") to the variable. To copy this, right click on "kg/t" and select "Copy for PGM", then paste into the PGM file: ("MRatio", "kg/t")

Please see Conversions for more information on this topic.

RefTags List

PrjWindowRefTag137.png


The RefTag list is for user information only, it builds and displays a list of all the reference tags used in the projects. These include any read/write (GET/SET) tags used by models (e.g. PID controller, PGM files - General controller).

NOTES:

  1. The list is built during the first iteration of a project solve or project run. Therefore, if the project has not yet been solved, the list will not appear. To display the list, after the project solve/run has been started, press on the refresh button on the following dialog box.
    • In this example, we can read that P704.Ti is an input variable for the Autoclave2_Steam controller (measured value). The controller output then manipulates the Steam_1.QmReqd (the steam 1 mass flowrate required) variable.
  2. The referenced tags are also indicated by displayed coloured triangles on the relevant access window or Trend window, as described in Controlled and Referenced Variables.