Project Configuration (cfg File) 9.3

From SysCAD Documentation
Jump to navigation Jump to search
Warning! Page you're reading is outdated or was archived and very likely is referring to older version of the software. Please navigate to the most recent version instead.

Navigation: User Guide -> Project Configuration (cfg File) 9.3

Model Selection General Configuration Species Configuration 9.3 Calculation Configuration Size Configuration

Related Links: Species Table, Editing SysCAD Database

This page is for SysCAD 9.3 Build 136. For SysCAD 9.3 Build 137 or later, please see Project Configuration (cfg File)


Introduction

The project.cfg (model configuration) file is edited by the user to customise each SysCAD project or project group. When the Edit Project Configuration command is activated, the following pop up window will be loaded.

WARNING: This is only available when a SysCAD project is NOT loaded.

The window will display the configuration files that have been used or edited recently.New will create a completely new configuration file and folder.Copy will create of copy of the currently highlighted configuration file.Browse will allow you to browse for an existing configuration file.Remove will remove the currently highlighted configuration file from the list.Allows the user to edit the Species Database associated with the highlighted configuration file.Allows the user to edit the Conversions Table.Allows the user to check if there are any errors in the highlighted configuration file.This will allow the user to edit the configuration file.Click on the done button to close the Project Configuration dialog.EditConfiguration.png
About this image


To edit the configuration file, select the file to be edited from the Project Configurations Dialog box as shown above, press Edit or double click with the left mouse button. The dialog window shown in the section Model Selection will appear.

Video Links

The following videos show different aspects of the Configuration file:

  • This tutorial video shows you how to copy an existing configuration to create a new project group in SysCAD.
  • This tutorial video shows you how to add a species to the Configuration file. It also explains some of the Configuration functionality.

Location of Configuration Files

  1. SysCAD always expects projects to be located in the same folder as the configuration file that they are using. This is not strictly enforced, and the user may store the project and the configuration files in separate locations. (This is not recommended, as it can lead to confusion).
  2. The user may check which configuration file the project is using by accessing the View - Project command. Please see Project Window - Files List for details.

Creating a New Configuration File

To create a new configuration file, click on the NEW button in the configuration editor shown above. The following dialog box will become visible:

Create new cfg 9.3.jpg
  1. Enter the required name of the configuration file.
  2. If the check box Project Set Same as Config Name is ticked, then the project folder will be the same as the Configuration file name. the Folder path is correct. This is the default option and reduces confusion with folder names.
  3. The Files Folder is the name of the folder in which the configuration file and the species database will be stored. By default this is called CfgFiles.
  4. You may enter a description for the project in the Description field.
  5. The default for the root folder will be within SysCAD Projects, but you may browse and change this to any path.
  6. Additional options are available to choose the Network Solution (ProBal or Dynamic) and which groups of models to include.
  7. Click OK when finished.


EXAMPLE: If you changed the config name to Gold Projects in the above configuration file dialog box, then the following folders and files will be created:

  • A folder under SysCAD Projects called Gold Projects, containing a sub-folder called CfgFiles.
  • Files called SysCAD.93.db3 and Gold Projects.cfg will be created and stored in the CfgFiles sub-folder.
  • The species database will only contain steam, water and sulfuric acid at this stage.

Copying an Existing Configuration File

You may also use an existing configuration file as a template and save it as another file:

  1. Highlight the configuration file you would like to copy and press the COPY button.
  2. You will see a dialog box almost identical to the one above. The only difference will be instead of the words Create New Configuration at the top of the window, you will see Create Copy of C:\SysCAD 93 Projects\Gold Project\CfgFiles\Gold Project, where Gold Project is the configuration file that you are copying.
  3. Enter the required name of the configuration file.
  4. If the check box Project Set Same as Config Name is ticked, then the project folder will be the same as the Configuration file name. the Folder path is correct. This is the default option and reduces confusion with folder names.
  5. The Files Folder is the name of the folder in which the configuration file and the species database will be stored. By default this is called CfgFiles.
  6. You may enter a description for the project in the Description field.
  7. The default for the root folder will be within SysCAD Projects, but you may browse and change this to any path.
  8. Click OK when finished.

EXAMPLE: If you changed the config name to Gold Project 2 in the above configuration file dialog box, then the following folders and files will be created:

  • A folder under SysCAD Projects called Gold Project 2, containing a sub-folder called CfgFiles.
  • Files called SysCAD.93.db3 and Gold Project 2.cfg will be created and stored in the CfgFiles sub-folder. The configuration file and the database will be identical to the configuration file and database in Gold Project, the original project. Therefore, they will contain all of the species that are available in Gold Project.

TUTORIAL:

Please also see a short video clip describing how to copy a Configuration file for the SysCAD tutorial - Copy an existing Configuration for a new Project Group

Model Selection

The image below shows 2 different views of the Model Selection access window:

ModelSelection.png

You may view the available models by:

  1. DLL (Dynamic Link Library), as shown on the left; or
  2. Group, as shown on the right.

NOTE: Not all models are available to all users. Please check your license agreement to see what models are available for use. Refer to Models for a list of the standard models available to users with standard licenses.

Select Unit Models

This window allows the user to select the required models for use in projects. You may select (marked by the blue tick) or de-select models as required. Each dll (Dynamic Link Library) group shown in the above window contains a number of models, as indicated by the + box on the right hand side. By clicking on this + box, the user can expand the tree view and see the models available in each dll group. This is shown for the Separ1 group.

  1. To select ALL of the models in a group click on the group and a blue tick will appear.
  2. To de-select an entire group, click on it and the blue tick will disappear.
  3. To select (or de-select) only some models in a group, click on the + box so that the view is expanded and you can see all of the models in the group. You may then select individual models.
  4. When only some models in a group are selected, this is indicated by the blue tick having a grey background Button Small 1.png.
Edit Configuration - Units.png

Required species

Certain unit models require specific species to be present for the models to operate correctly. These include:

  • The Bayer species models;
  • The Potash models;
  • Certain alumina models, such as the Precipitator; and
  • Various client specific models.

Once you have selected the models for the project you may click on the Show Required Species button and you will see a list of all of the species that MUST be included in the project. If any of the listed species are NOT included in the project configuration, then SysCAD will give you a warning. After the Next>>> button is pressed, any required species which have not been included in the project configuration will have a red triangle next to them in the list of species on the left hand side of the Species tab page. Refer to Species Configuration.

Notes:

  1. If any of the listed species are NOT included in the project configuration, then the SysCAD will not allow you to open any projects using this configuration file.
  2. For most non-alumina and non-Potash projects the required species shown will be H2O(l) and H2O(g) only.

Based on the models selected, a second dialog box with varying number of tab pages will appear for further customisation when the Next>>> button is pressed. Refer to General Configuration.