CYME_502-Ref_EN_V1-2

(1)

January 2011

CYME 5.02

Reference Manual

(2)

(3)

© Copyright CYME International T&D Inc.

No part of this publication may be reproduced, or transmitted in any form or by any means without the written permission of CYME International T&D.

Possession or use of the CYME software described in this publication is authorized only pursuant to a valid written license agreement from CYME.

CYME makes no warranty, either expressed or implied, including but not limited to any implied warranties of merchantability or fitness for a particular purpose, regarding these materials and makes such materials available solely on an "as-is" basis.

CYME International T&D reserves the right to revise and improve its products as it sees fit. The information in this manual is subject to modification without notice.

While every precaution has been taken in the preparation of this manual, CYME assumes no responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.

CYME International T&D Inc. 1485 Roberval, Suite 104

St. Bruno QC J3V 3P8 Canada

Tel.: (450) 461-3655 Fax: (450) 461-0966

Canada & United States: Tel.:1-800-361-3627 Internet : http://www.cyme.com

E-mail: [email protected]

Other Trademarks: The names of all products and services other than CYME’s mentioned in this document are the trademarks or trade names of the respective owners.

(4)

(5)

CYME 5.02 – Reference Manual

5.8 Add Source ...107 5.8.1 Source Tab...107 5.8.2 Equivalent Tab ...109 5.8.3 Demand Tab...110 5.9 Add Network ...112 5.9.1 Network Tab ...112 5.9.2 Source Tab...114 5.9.3 Equivalent Tab ...115 5.9.4 Demand Tab...116 5.9.5 Limiting Tab...118 5.9.6 Harmonic Tab...118 5.9.7 Comments Tab...118 5.10 Assign Zone...119

5.10.1 Assign Sections or Nodes to a Zone...120

5.10.2 Zone Properties...120

5.11 Add Section ...121

5.12 Insert Section...122

5.13 Split Section ...122

5.14 Rotate Section ...123

5.15 Calculate Section Length...123

5.16 Rename Sections ...124 5.17 Reconfigure Sections ...125 5.17.1 Note on Reconductoring ...127 5.18 Open/Close...128 5.19 Connect ...129 5.20 Disconnect ...130 5.21 Move ...130

5.22 Rearrange One-Line Diagram ...131

5.23 Cut ...132

5.24 Copy...132

(8)

5.27 Delete...133

5.28 Properties ...133

Chapter 6 The Database Menu ...135

6.1 Overview ...135

6.1.1 Database Formats...135

6.2 Database Manager ...136

6.3 Create ...138

6.3.1 Single Database Configuration ...138

6.3.2 Single Database (Equipment Only) Configuration ...140

6.3.3 Separate Databases Configuration...140

6.4 Delete...141

6.5 Update Network ...141

6.6 Import...143

6.6.1 ASCII Files ...144

6.6.2 XML Files ...146

6.6.3 Previous Version of CYMDIST (prior to 4.1) ...147

6.6.4 CYME Database...148 6.6.5 Custom File(s) ...149 6.7 Export...149 6.8 Re-Index ...150 6.9 Pack ...151 6.10 Open Project...151 6.11 Save Project ...151 6.12 Delete Project ...152 6.13 Close Project ...152

6.14 Switch Status Update ...152

6.15 Load Database Maintenance...153

6.16 Default Equipment Mapping ...154

6.17 TCC Library ...155

6.17.1 Select ...155

6.17.2 Online Update ...155

Chapter 7 The Network Menu...157

7.1 Select Networks...157

7.1.1 Loaded Networks Group Box ...158

7.2 Network Reduction ...160

7.2.1 General Tab ...160

7.2.2 Device Restrictions Tab ...162

7.2.3 Node Restrictions Tab...162

7.3 Network Equivalent Calculation...163

7.3.1 Network Equivalent Example ...163

7.4 Network Types...165

7.5 Customer Types ...166

7.5.1 Load Flow Tab...166

7.5.2 Load Allocation Tab ...167

7.5.3 Properties Tab...168 7.6 Environments ...168 7.6.1 General Tab ...168 7.6.2 Reliability Tab...169 7.7 Load Growth ...170 7.7.1 Edit Factors ...170 7.7.2 Apply Factors ...171

(9)

Chapter 8 The Report Menu ...175

8.1 Reports Contextual Menus ...175

8.2 On Calculation ...176 8.3 General ...179 8.4 Equipment...179 8.5 Study Summary ...179 8.6 Validation Rules...180 8.7 Format...180 8.7.1 Cell Properties...180 8.7.2 Cell Style ...181 8.8 Properties ...181 8.9 Header/Footer...182 8.10 Save...182 8.11 Close...183 8.12 Close All...183

Chapter 9 The View Menu...185

9.1 Toolbars ...185 9.2 Status Bar ...185 9.3 Explorer Bars ...186 9.4 Zoom...187 9.5 Pan...188 9.6 Magnifier ...188 9.7 Result Box ...189 9.8 Network Explorer ...190

9.9 Image And Text Layers...191

9.10 Reports ...191

9.11 Background Map...192

9.12 Overview Map...192

Chapter 10 Display Options ...193

10.1 Display Layers Selection ...193

10.1.1 Symbols...194

10.1.2 Color Coding ...196

10.1.3 Tags and Text ...197

10.1.4 Tooltips ...198 10.2 View Properties...199 10.2.1 General Options ...199 10.2.2 Window Options ...200 10.2.3 Window Colors ...202 10.2.4 Window Sizes...203 10.2.5 Selection...204 10.2.6 Device Symbols...205

10.2.7 Automatic Coordinates Generation...206

10.3 Search...207

Chapter 11 The Customize Menu...209

11.1 Menu ...209 11.2 Toolbars ...210 11.2.1 Toolbar Tab ...210 11.2.2 Commands Tab...211 11.3 Shortcuts...212 11.4 Status Bar ...213 11.5 Result Box ...214 11.6 Keywords ...215

(10)

11.8 Validation Rules...219 11.9 Charts ...220 11.9.1 General Tab ...221 11.9.2 Background Tab ...223 11.10 Contour Plot ...224 11.11 Simplified View ...225 11.12 View Styles ...227

11.12.1 Characteristics of the Default View Styles ...228

11.13 Symbols ...229

11.14 Color Coding...230

11.14.1 Device ID Layer...231

11.14.2 Keyword Layer ...232

11.14.3 User Defined Filter Layer ...233

11.14.4 Zone Layer ...234

11.15 Tags and Text...235

11.16 Tooltips ...236

11.17 Random Colors...237

11.18 User Data Extensions ...237

11.18.1 Definition Tab ...239

11.18.2 Bindings Tab ...240

Chapter 12 The Window Menu ...243

12.1 New One-Line Diagram Window ...243

12.2 Cascade...243

12.3 Tile Vertically ...243

12.4 Tile Horizontally ...243

12.5 Close Window...244

12.6 Close All Windows ...244

12.7 Close All Charts ...244

Chapter 13 Advanced Customization...245

13.1 Reports ...245

13.1.1 Create a New Report Category...245

13.1.2 Delete a Report Category ...246

13.1.3 Add New Reports ...247

13.2 Keywords ...250

13.2.1 Create New Keywords ...251

13.2.2 Keyword Expressions...252

13.3 Symbols ...254

13.3.1 Symbol Components ...254

13.3.2 Edit a Symbol ...254

13.3.3 Create a Symbol...255

(11)

Chapter 1 Getting Started

1.1 Overview of CYME

The CYME power system analysis software is a robust, comprehensive suite of advanced simulation tools to assist transmission, distribution and industrial power engineers. In their daily endeavors. CYME has been designed to help address the complex and emerging challenges faced by electrical engineers in power network planning and operation. With the analytical capabilities of the CYME software, planning scenarios and case studies help accurately assess and substantiate the impact of modifications and reconfigurations to power networks in its present or future state, consequently producing an improved asset management. The continuous development and active enhancements make CYME both accurate and reliable. For 25 years, the CYME software is renowned for standing behind thousands of transmission, distribution and industrial projects around the world.

With an unified and straightforward interface the CYME software is distinguished for making its complex engineering calculation features easy to use for different projects. The seamless suite of applications of CYME provides numerous analysis functions sought by power engineers. It also covers a wide spectrum of analyses to allow simulations, performed on any network configuration, such as: power flow, short-circuit, transient stability, harmonics, contingency analysis, arc flash hazards, motor starting, protective device coordination, etc.

Furthermore, other software designed specifically for distribution, industrial and transmission power system engineers are offered. This includes cable ampacity calculations with sophisticated functions, grounding grid design and analysis, protective device coordination and creation/maintenance of distribution network model.

The CYME software provides powerful modeling capabilities that support the detailed modeling of any distribution, industrial or transmission network. Creating balanced and unbalanced networks, secondary grids, substations, nested networks, whether radial or meshed, three-, two- or single phased, is fully supported and can represented schematically or geographically. To bring the network representation even closer to reality, the modeling capabilities are supported by extensive industry-standard equipment and control libraries that can be enhanced by the user.

A fully customizable workspace caters for the user-friendliness and suitability for different needs of each user. The graphical representation of the network components and the display of results in tags and and reports can be built and modified to supply the level of detail needed. Such customization is made possible due to the availability of CYME`s large keyword collection which outputs from equipment data and settings to different simulation results.

Innovative engineering technologies, industry practices and standards are at the core of the CYME algorithms, flexible user interface and extensive libraries. The quality and wide-ranging capabilities of the CYME software can provide engineers engineers and their team the engineering solutions required to meet their analytical needs.

(12)

1.2 About this Manual

This document is the CYME Reference Manual. It explains how to get started with the software, describes The CYME Interface (Chapter 2) and goes on with a description of the menus of the application and the commands available.

Note that the Equipment menu is described at length in the Equipment Reference Manual (this includes the definition of equipment and their settings for use in the field).

The analyses found under the Analysis menu are described in a number of separate Users Guides. See the Help > Users Guide menu command to see which ones are available with your license and to display the related manuals..

Finally, Chapter 13 Advanced Customization provides explanations about how to use some of the functions that allow adapting the software to your needs.

1.3 Computer System Requirements

CYME requires an IBM PC or compatible computer using Microsoft Windows 2000, XP, Vista, 7; or Microsoft Server 2003 or 2008. The minimum hardware requirements are:

• A Pentium IV-based computer.

• A minimum of 1024 MB of extended memory. • 1 GB of hard disk space.

• Any mouse, monitor and printer or plotter supported by Windows.

1.4 Databases used by CYME

CYME uses databases to save the equipment, network and project data. Studies are saved in separate files (extension *.xst), not in a database. You are free to create multiple versions of these databases, so as to keep projects separate. The databases are briefly described below.

Note: Use the menu Database > Database Manager (section 6.2) to tell CYME which Network and Equipment databases to use (Database Configuration). Database type support - CYME version 5.02 and later supports the MS Access database type. With the CYME Server Database module, it also supports: MS SQL Server (2000, 2005, 2008), and Oracle (9, 10 and 11). CYME Server Database module is included with CYMDIST and is an optional add-on module to the CYME software.

In order to work on a study with CYME, it accesses the databases to: 1. Display the one-line diagram of the network,

2. Keep track of loads and equipment connected to the network’s sections, and 3. Record modifications to the network.

Please refer to Chapter 6 The Database Menu for further information on working with databases.

(13)

1.4.1 Network Database

The Network database contains information describing, for each network, the connectivity of the sections, the conductors and the equipment types used, the settings of individual equipment, the loads, the shunt capacitors and the reactors connected to every section, and the interconnections between networks, if any.

The networks stored in the database are supposed to represent the actual situation at some point in time (usually the present). Copies of these networks are used in studies as the starting point.

Note: Networks that are created in a study will not be stored in the network database, only in the study, until you use the command Update Network (section 6.5).

1.4.2 Equipment Database

The Equipment database contains the electrical characteristics of all the equipment that is available for connection to the network.

1.4.3 Project Database

The Project database is available if you have the CYME Advanced Project Manager module installed. Normally, the Project database will be the same as the Network database and it contains the modifications to the network for a specific project. The option to keep the project data tables separate from the network ones is presented to the user at the Database > Create menu command (see 6.3).

1.5 Map Formats Supported

Using the Background Map optional module, CYME directly imports the AutoCAD .DXF and .DWG maps, and ESRI Shapefiles .SHP. See 2.3.8 Background Map Tab. If multiple georeferenced map files are available, a function of CYME allows keeping a link with the map files in order to display them. The Automatically load the maps from the database function found in the Background Map Advanced Options dialog box will permit loading only the maps fitting the area visible on the main display.

Other map formats are supported by this function of CYME that makes a copy of the file(s) and changes the format to MapServer’s .GDS. The following map formats are handled:

• Atlas GIS (.BNA) • AutoCAD (.DXF)

• Digital Chart of the World (.VPF) • ArcInfo Shape (ESRI) (.SHP) • MapInfo (.MIF)

• Metafiles (.wmf, .emf)

• Microsoft Bitmap raster (.BMP) • Tagged Image File (.tif) • UK Ordnance Survey (.NTF) • US Geological Survey (.OPT, .STD)

(14)

1.6 Running

CYME

Unless you have created a “shortcut” icon for CYME, you will run CYME from the “Start” menu: Start > Programs > CYME\CYME shortcut.

The title bar shows the version number of the application, followed by the revision number. When your study is saved, the file name with the path is indicated next. Finally, the name of the active study window is also indicated. For example, CYME version 5.02., with the study saved and with one line “main” window active, appears as follows:

The Main Menu and Toolbar will be displayed, although most of the icons will be disabled until you open a study. See New Study and Open Study in the File menu (sections 4.1 and 4.2).

Note: The path to the cyme.exe on your computer may be different.

Note: Several editor and analysis commands are now directly accessible as public functions through the CYME COM Interface optional module. Users may write subroutines in Basic / Visual Basic / VB.NET / C / C++ / C# to access the functionality of CYME without opening the editor. Thus, enabling CYME to run as a background application. For more information, please contact CYME.

1.7 Getting

Help

1.7.1 Help Files and Contextual Help

The software comes with help files on the basic functions and on the analysis modules that are found under the Help menu. You can display the Reference Manual (which is this manual) and the Equipement Reference Manual detailing the parameters of the equipment and their settings. A third menu item, Users Guides. provide access to the manuals about the analysis modules for which you have a licence. You can hit the F1 key to display this Reference Manual on your screen.

You can also display the help file text related to a dialog box by clicking on the Help icon located at the top right hand corner of the dialog box.

Hovering your mouse over a round icon in a dialog box will display additional information about a specific field in this dialog box.

(15)

1.7.2 CYME Manuals Available

The manuals are available through the Help menu of the program. The ones you will have access to depend on the modules installed with CYME. Note that some manuals are available only upon request to the CYME Technical Support service.

Two basic manuals are available. The Reference Manual (this document) describes the user interface and the functions other than the analyses. (You can display this Reference Manual by hitting the F1 key on your keyboard.) The Equipment Reference Manual details the parameters of each equipment and how to set them in the field.

Note that the Users Guides provide more in-depth guidance about the equipment settings, relevant to the analyses described. See the Help > Users Guide menu command to see which ones are available with your license.

Other complementary manuals are:

• The Knowledge Base Manual includes a listing of the error messages that can be reported by CYME with their possible causes and solutions.

• The CYMVIEW – User Manual describes this complementary application that allows viewing the CYME-generated graphics and charts and customizing their appearance. • The CYME Database Reference and the CYME Import/Export manual.

1.7.3 Tutorials

Tutorial guides are integrated into the Help menu, helping users who are in search of guidelines on the use of the software. Select the Help > Tutorials menu option to display the following dialog box.

Select a subject matter in the List of tutorials to see the files that are available. Each tutorial document describes how to use a CYME module or function, or consists in a step-by-step exercice. Most tutorials are accompanied by a CYME self contained study file on which you apply the steps described in the related document.

The documents are Adobe PDF files while the studies are CYME self contained studies. Make your selection by activating the check boxes next to the file names. Click the Start Tutorial button to display the PDF file on your screen and to load and display the self-contained study in

(16)

1.7.4 Error Messages

Errors can be encountered in dialog boxes, in the user-interface or in the reports (simulation, input data, etc. A six-digit error code is being provided in a tabbed report appearing in the Reports window of the application (see 2.1.5). Users can either click on the hyperlink in reports, or click on the Help button in the Errors dialog boxes to access the Knowledge Base manual that provides a listing of the possible causes and solutions to each problem.

1.7.5 Revision Number

Select Help > About CYME to view the program’s version number, list of applications included with protection key, revision level, and date issued. You may need this information when requesting help from the CYME customer support team.

1.7.6 Read Me File

The Read Me file contains a listing and short description of the updates since the last revision. Display it using the Help > Read Me menu command.

(17)

1.7.7 On-Line Information

The CYME web page address is: www.cyme.com. Latest news and overview information about our software and services can be consulted there.

The Help > CYME on the Web > CYME Home Page menu option will quickly display the CYME web page in your Internet browser.

The Help > CYME on the Web > CYME Forum menu option displays the CYME Discussion Forum Login Page in your Internet browser. Once registered to the Forum, you will have access to our knowledge base, post your question(s) and read questions and answers compiled by our in-house experts.

To register to the Forum, click on the Register hyperlink and follow the instructions. Once you will have filled in the registration page and clicked the button Submit, a message is sent to CYME. A confirmation message will be returned to you once your request is accepted. You will be able then to access the forum topics related to the software you have purchased. 1.7.8 CYME Technical Support

Select the menu command Help > Technical Support to open a customer support e-mail form (dialog box) to report technical problems to the CYME Support Team. Use this form to attach your opened study and supporting database, system setup information and send it to our customer support team.

To The default ([email protected]) is the e-mail address of the CYME support team.

(18)

From To provide information about the sender. The sender’s e-mail address, full name, and company are required as a minimum.

Note: The e-mail address indicated here will be used as the return address by the CYME Customer Support team.

Subject: Subject line that summarizes the support request. Body of e-mail Enter your requests / comments.

Attach a file To select the attachment file(s) to be sent with the support e-mail.

Click on the Add button to select from your local drive(s) the file(s) you want to attach to the message. To remove a file thus added, highlight its name in the list and click Remove.

As a complement, enable the checkboxes besides the CYME files you wish to send. These will be automatically attached when you will click the Send button:

y Cymdist.ini: application startup settings

y System Information: status of your PC’s configuration (hardware and software) and resource usage

y Self-Contained Study: a ‘stand alone’ copy of the currently loaded study. Note that the study filename will be renamed to “network.sxst” for diagnostic purposes. See 4.7 Save Study As Self Contained.

y Customization files: files defined in the File > Preferences dialog box, Configuration Files tab. (see 4.15.1).

(19)

Advanced>> To configure the local mail host settings (SMTP or MAPI).

To test your mail configuration setting, click Test Connection Click OK to accept your changes or Cancel, to discard them.

Note: You may need to ask your network administrator for your local mail host settings.

Note: The command File > Send To Mail Recipient (see 4.17) can be used as an alternate way to contact the CYME customer support group.

1.7.9 How to Reach CYME by Phone and Fax

You can reach the CYME customer support team by phone or by fax. Tel: (450) 461-3655, International & Canada Tel: (800) 361-3627, USA & Canada

Fax: (450) 461-0966, International & Canada Fax: (781) 229-2336, USA

e-mail: [email protected]

1.8 Auto-recovery

Mode

The Auto-Recovery mode saves the list of modifications should an undesired interruption of the program or the computer occurs. The last auto-saved copy of the study will be available to help user recuperate as much work done as possible.

In the File > Preferences dialog box (see 4.15), users can specify the Recovery folder in which current study modifications are saved for auto-recovery purpose. Each modification made from the last saved study will be kept.

Should the user desires to recover the work after an improper closing of their previous CYME session, the program will open the right study file, or load the networks from the correct database and the corresponding modifications.

(20)

1.9 A Few Terms

Section: A length of conductor (3-, 2-, or 1-phase) to which equipment and load may be attached. A section is the basic building block of networks. Feeder: A set of connected sections that originate from a substation.

Network: Set of connected sections making up an installation such as a substation, a secondary network or a feeder/group of feeders or a combination of these elements.

Study: A sequence of modifications made to a selected network(s) for planning or analysis. A network in a study is either a copy of one stored in the Network database or it is a new one created during the study.

Modifying a network during a study does not affect the original network in the Network database. To copy your modification to the network database, use the Database > Update Network command (section 6.5). Active

Section:

The section that is to be affected by a command. To identify it easily, assign it a unique color via View > Display Options. Set the selection color and width in the Selection group found at the View Properties tab (see 10.2). To learn how to select sections and components, please refer to section 2.6.1 Component Selection.

Lateral: A section connected to what is considered to be the main feeder. It often incorporates fewer phases or smaller conductors. It is pertinent to the Edit > Reconfigure Sections command (section 5.17).

Study File: An electronic computer file containing information on a study. These files are normally saved in the project directory and have the extension *.XST (*.SXST for self contained studies)

Node: A circular marker use as a connection point between sections and feeders. (Refer to 3.1 Section Structure and 3.3 Node Properties.

(21)

Chapter 2 The CYME Interface

2.1 Overview of the Graphical User Interface (GUI)

2.1.1 Main Display Screen (OLD Display)

This is the area where the network selected is displayed. You may have several different views loaded; then, this area will be tabbed to let you access those different views.

The standard view is a Multiple Network View in which are displayed all networks that were loaded (see 7.1 Select Networks). Networks might be displayed in this view or represented as a symbol depending on their initial settings; while nested views will always be displayed as symbols in this view mode. Their content can be displayed as a separate view by double-clicking on their symbol in the main display, by clicking on the Step Into button located at the top right hand corner of the main display or by clicking on the associated tab at the bottom of the main display. In the nested view mode, only one network type can be viewed at a time; other types of networks cannot be shown or added in this view. The View button provides a faster access to various display options, including Simplified Views (see 11.11), layers and access to the View Properties options of the Display Options dialog box (see 10.2).

(22)

Each view invoked is tabbed into the main display for easy access and display. You can define display parameters of each of these views. Refer to Chapter 10 Display Options and 11.11 Simplified View to learn about defining and using views. CYME supports two default view styles: georeferenced and schematic.

Finally, a global view thumbnail window, the Overview Map, located at bottom right hand corner of the main display screen shows the whole network loaded. (see section 9.12). A blue rectangle shows the area zoomed in. If you have two or more views of your network running, each will contain its own overview map.

2.1.2 Main Menu

Located at the very top of the window it groups all of the commands available with the software key(s) you have installed on your computer, in pull-down menus. Most of the commands are disabled until you open a study. See 2.2 Menus for an overview of the menu categories available in CYME.

Also, the Main Menu can be customized to show only the commands that are useful to the user (see the command Customize > Menu (section 11.1).

2.1.3 Toolbars

The Toolbars are located just below the Main Menu, and feature icons representing the most frequently used editing, navigation and analysis functions of CYME. Each icon has a corresponding command in the Main Menu. Note that most of the icons are disabled until you open a study.

To see the list of toolbars available, select the View > Toolbars menu option or right-click anywhere in the Toolbar area at the top of the window to display a menu. Checkmarks appear next to the names of the toolbars already displayed.

All Toolbars are described in section 2.5. Toolbars can be moved anywhere in the display.

Icons may be rearranged, removed or re-inserted in the any of the toolbars, and the users can build their own (see 11.2 Toolbars).

(23)

2.1.4 Explorer Bar

This configurable area is composed of moveable tabbed multi purposed commands and information interface that is presented in a tabular / tree structure. The commands available here can also be accessed via menu commands.

More than one Explorer Bar window can be displayed at a time, refer to section 2.3 to learn more about this. Within each Explorer Bar view, you can attach or detach (hide) any of the tabs available.

To display the Explorer Bars or customize its contents, select the View > Explorer Bars menu option (see 9.3).

2.1.5 Reports

This area is a configurable tabbed window that is displayed when reports are requested. See Report > On Calculation (chapter 8.2). This window can be floating or docked as desired. 2.1.6 Status Bar

Located at the bottom of the screen, it consists in two lines of text that identify information about the active database, the parameters of the selected section or node, and the cursor XY coordinates. The first line can be customized for the users; see 11.4 Status Bar.

2.1.7 Dialog Boxes

The dialog boxes contents depend on the CYME applications key installed on your computer. Tabs in dialog boxes are displayed appropriately based on the available licenses; thus avoiding confusion in distinguishing which data are required from which that are not. The example below shows the same window shown with the CYMHARMO module installed and the bottom one without.

The Select Network dialog box, all the Equipment dialog boxes (Equipement menu), several analysis dialog boxes and a few others can be resized to allow the proper display of item IDs with multiple characters. Note that all resized and repositioned dialog boxes are saved upon

(24)

mouse cursor will change to a double-tipped arrow. Left click on an edge and drag with your mouse.

The left hand pane only of the Section Properties dialog box can be displayed by clicking on the Collapse button appearing in that dialog box, thus hiding the Settings group boxes. Clicking on the Expand button appearing in the reduced dialog box will show all the dialog box elements again.

Note that floating toolbars can be reshaped and that floating report windows can be resized as required.

2.2 Menus

The Main Menu at the top of the CYME screen gives access to all CYME commands. Menu commands are enabled or disabled depending on whether there is an opened study or not. Additional menu options will be available if you have optional modules installed.

Each menu item contains sub menu options. To displays the sub menu click on the word with the left mouse button.

File Here you will find the commands that pertain to the general operation of the program, the opening and saving studies, exporting studies data, as well as printing graphics and reports. This menu also contains the commands for setting up general characteristics of the network, such as the system of units for length, the frequency and average earth resistivity. (These parameters affect the calculation / characteristics of your networks and should NOT be changed without due consideration.) The commands of The File Menu are described in Chapter 4.

In this menu, as well, you will find access to the following tools: the Symbol Editor (see 4.19.1), the Graphic Viewer (see 4.19.2), and the optional Energy Profile Manager. For the latter, please refer to the Energy Profile Manager User Guide to learn about the functionality. Edit This menu contains the commands for finding and editing line sections.

All graphic editing tools are found here. Note that the items in this menu are active only when a study is open.

(25)

Database The commands in this menu pertain to the utilization of the databases used by CYME. This menu allows you creating your database configurations, incorporating the ones needed, updating as well as activating them for a given study. It also comprises commands to update your database based on the work done on the networks.

Most of the commands in this menu are available whether there is a study opened or not.

Chapter 6 describes the commands of The Database Menu.

Equipment Use this menu to manage the equipment in your active database (add, delete, or modify). The equipment database is an inventory of equipment (such as transformers), which is available for connection in the network.

The active database is updated as soon as you click OK. You can access this menu with or without an opened study.

The Equipment menu options are covered at lenght in the Equipment Reference Manual.

Network The Network Menu includes commands to load the available networks from the active database: feeders, networks and nested networks. It also provides the means to manage your network as a whole and define your load models names and various overall characteristics such as the customer types and environment.

The commands found in this menu are described at Chapter 7. Analysis This menu provides access to all of your analysis functions.

It includes all the basic analysis functions available with the CYME license. If optional analysis modules are acquired, the user will be able to access the additional programs via this menu.

Each analysis is covered at length in one of the User Guides available. See the Help > Users Guide menu command to see which ones are available with your license and display them.

Report The Report Menu includes the commands for requesting reports of calculation results, for customizing the tabular report formats, and for saving the reports to files. Reports can be based on simulation data or on equipment parameters. More details in Chapter 8.

View The View Menu includes the commands that govern what you see on the screen (and what you do not want to see!). This includes the display of the elements of the program’s user interface. It also includes access to the Display Options commands for the user to adjust the display of the elements within the one-line diagrams.

It is also from this menu that you can attach a map as the background to help you visualize the geography of the network circuits in your study.

The View menu is described more in details in Chapter 9. See also Chapter 10 Display Options.

(26)

Customize The commands in The Customize Menu allow the user to modify the CYME interface, such as the icons that appear in the toolbars, the commands to be included in the menus, the calculation results to be displayed, etc.

This menu also includes access to more advanced customization functions such as the view styles, the keywords, the validation rules, the filters, etc.

The various commands available are described in Chapter 11.

Window The Window Menu offers you the ability to open additional windows in which to view the networks in your study, perhaps with a different magnification, or to design another view with which to display your networks. See section 11.11 Simplified View, 11.12 View Styles and Chapter 10 Display Options to learn more about this.

Other standard Windows commands are available in this menu as well (Tile, Cascade, etc.).

More details in Chapter 12.

Help From this menu, you can display an electronic version of this Reference Manual and of the Users Guides available in the form of Help Files, the Readme file for this version, access the CYME web page and Forum on the Internet, open the customer support e-mail form, and display the details about the revision number currently installed. Chapter 1.7 Getting Help describes the Help menu options along with other ways available to obtain assistance from the CYME team.

To minimize the OLD display window. A title bar for each OLD display minimized will be displayed at the bottom left hand corner of the main display. Click on in this title bar to restore the view.

To tile the OLD display windows into the main display area. To dismiss the OLD display window from the main display area.

(27)

2.3 Explorer

Bar

The Explorer Bar is an area that groups a number of frequently used functions organized under different tabs. You can have several Explorer Bar views, and within an Explorer Bar view, you can show or hide anyone of the available tabs. Right click in a free part of the tab area and select Add from the contextual menu. If you right click on a tab, you will be offered the choice to Remove it from the display or to Detach and display it in a separate bar. See also View > Explorer Bars to learn how to create your own view (section 9.3). You can also reposition the tabs directly on the display. Left click on the tab to move and drag it while keeping the mouse button down.

The tabs available are: Databases, Symbol Bar, Network, Detailed View, Display, Switch Monitoring, Abnormal Conditions, Background Map and Equipment Search. If you have the Advanced Project Manager module installed, a tab named “Projects” will be available as well. 2.3.1 Databases Tab

The Databases tab provides a quick access to the most frequently used database functions of the application and lists the database configurations that you have created.

Create Clicking on this shortcut displays the CYME Database Wizard to create a new database configuration based on existing or new database files. Same as Database > Create. See 6.3.

Import Displays the CYME Database Utilities Wizard with which you can import data into a supported CYME 5.02 database type (existing or new).

Same as Database > Import. See 6.6.

Export Displays the CYME Database Utilities Wizard with which you can export database data to other formats.

Same as Database > Export. See 6.7. Database

configurations

A tree-like list of the databases configurations created appears right below the New, Import and Export shortcuts.

(28)

If you right click on any of the database names in that list, a contextual menu will appear with all or some of following commands:

Connect/ Disconnect

To select the database configuration you wish to work with, select the option Connect. The icon of the database that is set as the active one will be green and its name will appear in bold, while the icons of the other databases in the list will appear in grey.

You can also use the Database > Database Manager menu option to achieve this (with more options). See section 6.2 for details.

Only one database can be active at any given time. Delete Same as Database > Delete. See section 6.4 for details.

Rename To change only the name of configuration that you select in the list (active or not).

Import Same as the Database > Import file command (see 6.6), except that the target database will be the one already specified for the configuration which name was highlighted in the list when you invoked the command.

Export Same as the Database > Export file command (see 6.7), except that the source database will be the one already specified for the configuration which name was highlighted in the list when you invoked the command.

Properties Displays the Database Connections Properties dialog box to modify your database connection settings that were originally set using the Database > Create dialog box (see 6.3).

You can also use the Database Manager dialog box (Database > Database Manager menu command) to do those modifications. (See 6.2).

(29)

2.3.2 Symbol Bar Tab

The Symbol Bar tab enables you to build or modify your network in a drag and drop environment via an equipment list. CYME supplies four default groups.

The General group comprises the network and equipment components commonly used to build networks. The Sources group comprises generators and dynamic resources used (for example) in distributed generation models. The Switching and Protection group and the Harmonics group include equipment of these types.

You can also create and add your own equipment group using the Add Group option of the bar’s contextual menu.

Other default groups are made available here with the Transient Analysis optional module installed.

When building/modifying a network, the symbol bar is used by dragging and dropping the icons onto the main display. In most cases, once an icon is dropped onto the Main Display area, the Properties dialog box will be displayed. When adding new equipment onto a section, double click on the section to display the Properties dialog box in order to adjust the settings of the equipment. Note that you can drag and drop equipment onto the network in any order (not necessarily in their connection order) and connect them later on.

Finally, you can create symbol bar items composed of one or several elements that you can drag and drop on the main display when building a network featuring repetitive elements. See 2.3.2.1 Create Network/Device Template.

(30)

Right-clicking on any of the symbols in any of the groups of the Symbol Bar tab will display a contextual menu.

Add Group Displays the Customize Group dialog box (with no selection) to create your own customized group of elements (chosen in any category listed). Type in a group Name and Select your items to include in your new group.

Click OK to create a new Symbol Bar. Remove

Group

Selecting this option will immediately remove the group from the Explorer Bar (no deletion confirmation prompt).

Customize Group

Displays the Customize Group dialog box where you can add or remove elements (chosen in any category listed).

Remove Item To remove an item for the view. For items created by the user, the command will permanently remove the item.

Restore Default

This command will restore all symbol bars to their default configuration.

(31)

2.3.2.1 Create Network/Device Template

The Create Network/Device Template contextual menu command eases the building of networks comprising repetitive elements. The templates are stored in the Symbol Bar tab of the Multi-explorer bar as an item that can be used for network building via a simple drag-and-drop. The user can also allocate a symbol and a connection mode to each template created.

For the creation of network templates, the user selects sections with the multiple selection tool and the group cut/copy/paste commands. A group of elements can thus be selected and be made a template. Select the element or group of elements and do a right-click to display the contextual menu; select the Create Network Template option in that menu.

The network templates can be dropped onto a node of the network displayed for immediate connection or placed in an empty area of the display to be connected later.

The Create Device Template contextual menu command allows the creation of templates of devices that feature complex settings or devices with specific loads or devices complemented with instruments. The device templates are added to the Symbol Bar as an item that can be placed on the network as any other device. They can be dragged and dropped onto a node or a section for immediate connection.

The templates can be added to any existing group in the Symbol Bar interface and are available for inclusion in groups created later.

(32)

2.3.3 Network Tab

The Network tab provides a quick access to some useful commands related to the loading and display of the networks, which includes feeders, substations, secondary networks and sub-networks. This functionality is very useful when you have a large and complex network to work on.

The Network tab pane displays a tree list of the networks by categories of the database that is currently Connected (see 2.3.1 Databases Tab). When you right click in the background of the pane, a contextual menu will be displayed with the options to Expand All the groups or Collapse All.

With the Auto-locate function of that menu activated, a double click on any of the names of the loaded networks center its head node in the display. Double click on the name of a network that is not loaded to load and display it. A “network” icon ( ) appears besides the name of a loaded network, while a “database” icon ( ) appears next to the name of a network present in the database but not loaded in memory.

(33)

A Search command is available at the bottom of the list to quickly find the network you are looking for. Type in its name or a part of the name and click on the Search icon ( ). Clicking on that icon again will highlight the next instance containing the characters typed in. Note that this command is not case sensitive.

Other commands are available for the individual networks in the list. The commands are accessed through a contextual menu that is displayed by right-clicking on the name of the network you wish to take action on.

Locate Zooms in and centers the display on the corresponding head node of the network highlighted in the list.

Report Displays a tabular report containing a list of the IDs of all sections, equipment and lines composing the network selected, along with the lengths (when applicable) and the coordinates.

Section IDs and Equipment IDs are hyperlinked; when you click on an ID, the element will be highlighted and centered on the main display and the corresponding Properties dialog box will be displayed.

Load Unload

To load a network, right click on the name and select Load. Note that CYME will load the network based on the Tracing Mode currently active in the Select Networks dialog box (see 7.1). So if one of the options Load Network with all or with minimum dependencies is active, the program will display only the network selected for loading but will load all networks that have a dependency with the one selected for loading.

You can also load all the networks in a group by selecting the Load option from the contextual menu obtained when right clicking on the name of that group in the tree list.

The Unload option will unload the network selected from the memory and remove the network from the display. Note that the Unload option will not appear in the contextual menu if you have modified that

(34)

before being able to unload it from the memory. The name of the network unloaded remains in the list with a “database” icon ( ) to the left of the name indicating this status.

The Network Selection dialog box will be displayed upon loading a network if the option Show network selection dialog when loading from the Network Tab is enabled. This option is located at the Editor tab of the File > Preferences dialog box (see 4.15.5).

Hide (Show)

Does not unload the network but removes it from the display. You can hide a network that has been modified.

Delete This command deletes the network from the database. You can recuperate the network data with the modifications made using the menu command Edit > Undo Modif. The data will be definitely deleted once you will have used the command Database > Update Network (see section 6.5)

Properties Displays the Network Properties dialog box corresponding to the network selected in the list. Refer to chapter 5.9 Add Network for explanations about the dialog box and its tab windows. Double-clicking on the name of a network that is marked as loaded will have the same effect.

2.3.4 Detailed View Tab

The Detailed View tab can be seen as a continuation of the Network tab as it displays the list of the devices, interconnections, loops and phase merging components of the loaded networks (i.e. active database) in the form of a tree list.

Short-cut buttons Auto Locate

(active) (inactive)

With the Auto-locate function of that menu activated, click on any of the device names to center it in the display. Double-clicking on a device name will also display the corresponding Properties dialog box.

(35)

Using Section Id

Using Device Number

With this option activated in the contextual menu, the elements in the list will be identified by the corresponding section identifier. With the

icon visible, the effect is the same.

When this option is de-activated in the contextual menu, the elements in the list will be identified by the corresponding device number. This is the same than having the icon visible.

Group by filter To create User-defined filters to apply to the Detailed View list. The filters that appear in the Detailed View tab are activated through the User Defined Filters dialog box. You can add filters to the overall list (they will be added at the bottom) or add them to groups.

When the program identifies elements that fit a filter’s parameters, its ID is copied into a group identified by the filter name. Click on the icon next to a global filter to reveal the list of devices, and take further action on any one using the contextual menu.

Note: The User-defined filters can be also used elsewhere in CYME. See Customize > Filters (section 11.7) to learn how to create new filters or modify existing ones.

(36)

New Group of Favorites

With this functionality, you can keep a list of the devices or group of devices you most often access or use.

Opens the New Favorite Group dialog box where you will type in the name of the new group you wish to create. Clicking OK will add the name of the group to the list.

To add elements to the group, highlight the IDs of the item and select Add to Favorites from its contextual menu. You can add several items at a time by keeping the SHIFT or the CTRL key depressed while making your selection in the list and accessing the contextual menu.

Adding an element to a Favorites Group does not remove it from the main list.

Contextual menu

A right click in the background of the pane displays a contextual menu containing the options listed above plus the following ones.

Expand All / Collapse All

To unfold (display) all the layers and show all components / To return to the roots of the trees and hide all components. You can also use the “ ” and the “ ” icons to expand or collapse the selected branch of the list.

Evaluate all filters

With this option enabled ( ), each time a modification is made in the network and each time a simulation is run, CYME reapplies the active filters to the network to identify all the elements that fit the parameters of each filter.

When the option disabled, the user can reapply any filter by clicking on its name in the Detailed View tab’s list.

(37)

A right click on a group name in the tree list (including global filters) will provide access to a number of the functions listed above, to the Group Properties dialog box (discussed at length at chapter 3.4), and to some or all of the following functions:

Group by Keyword

To create sub-groups within a category based on a keyword. In the example shown below, the keyword “Phase” was selected. You can remove the grouping by selecting the option “Reset”.

Apply fault Applicable to Nodes, Lines and Cables, this option will open the Short-Circuit Analysis dialog box to allow the execution of a short-circuit analysis of any of the Conventional, ANSI or CEI type. Refer to the CYMDIST Basic Analysis Users Guide or the the CYMFAULT Reference Manual and Users Guide for more details about how to perform the analyses.

Highlight Will place on the one-line display a circle around all devices included in the group (or a subgroup within a group) from which the contextual menu was invoked.

The icon of that category will show when the highlight command is on for that category ( )

(38)

Report Displays a tabular report containing information about the devices included in the category selected.

A right click on an item of the list opens its contextual menu, and depending on the item’s type and status, you will be able to perform various operations: locate, load, unload, hide, show, delete, connect, disconnect, etc. To that effect, refer to chapter 3.2.4 Section and Nodes Contextual Menus to learn about the various options.

It also gives access to the related Section Properties dialog box, to edit the settings of the device, see its failure history, etc.

For the devices, the contextual menu also contains a Display options sub menu that will give access to the parameters relevant to the device. Selecting one of the options in this sub menu will display the Display Options child dialog box corresponding to the selection for that device, so the user can edit the parameters right away.. See the example below. Refer to Chapter 10 Display Options for details.

(39)

Finally, the item contextual menu may contain a Tag > Properties option that will display a dialog box is composed of the same Text and Options tabs that you will find in the corresponding Tags and Text dialog box of the Display Options, however for that specific element in the one-line display, rather than globally for that type of element. You also have the possibility to display that specific tag or not.

2.3.5 Display Tab

The Display tab provides a quick access to the functions found at the Display Layers Selection tab of the View > Display Options dialog box (see section 10.1 for details on the options).

Click on the icon to select the layer to utilize and on the icon to see the items contained in the layer selected. The icon displays the associated dialog box for changing the settings.

Note: The settings made via this interface are temporary. To save your changes for subsequent sessions, you need to save the changes by clicking the Save button in the Display Options dialog box where you will have made your changes.

(40)

2.3.6 Switch Monitoring Tab

With the functionality at the Switch Status Monitoring tab you can verify and monitor the status of switching devices available on the network. The monitoring portion of this control displays the switch status changes read from a file. Users can quickly apply the new status to the networks loaded in the view.

The Switch Monitoring tab window is composed of three columns:

Type Type of switching devices. It is possible to filter the devices you want to see in the list. Click on the Filter icon ( ) at the top of the column to display the Switch Monitoring dialog box and select the types of devices for which you need to see the information.

When a filter is applied, the Filter icon shows a checkmark ( ).

ID Identification of the device. Clicking on the ID link of the device zooms in the display and centers it on the device in question.

(41)

Phase Click on the Filter icon ( ) at the top of the column to display the devices you want to see based on their phase.

Status Click on a cell to toggle the status of the device between Open and Closed. It is possible to filter the devices you want to see in the list. Click on the Filter icon ( ) at the top of the column to display the Switch Monitoring dialog box and select the devices you want to see based on their status.

Double-clicking on the header of a column orders the list in ascending or descending order based on the contents of that column.

(42)

2.3.7 Abnormal Condition Tab

The Abnormal Condition tab window will list all the abnormal conditions present in the network after running an analysis.

This control is updated automatically after a simulation. All abnormal conditions are listed by device type along with a symbol which color indicates the type of condition and with a hyperlink on the device ID for quickly locating the device in the view.

You can sort the list in ascending or descending order by double-clicking on the column headers.

Choose the colors via View > Display Options; click on the Modify button in the Symbols group box (see 10.1.1) to display the Symbols – Default symbols dialog box, and go to the Abnormal Conditions tree item in the list. The dialog box will display the parameters you can set for each condition.

2.3.8 Background Map Tab

The Background Map functionality is an optional CYME module.

The Background Map module allows displaying a map behind the One Line Diagram. A map may consist of one or more “layers” or “sheets” (individual map images). CYME can display native AutoCAD file formats, ESRI Shapefile or other formats supported by MapServer (converted to .gsf files).

Maps may be loaded in an opened study or imported into a database. The list of loaded maps will be saved in the study and reloaded the next time it is opened if the option Save background map file is checked at the Options Tab of the File > Properties dialog box (see 4.18.2).

A list of maps can also be imported into a database. When loading networks from a database containing maps, the maps in the area visible on the main display will be automatically loaded.

The user can quickly activate this tab window using the View > Background Map menu command or by clicking on the Background Map icon of the Display toolbar (see 2.5.7).

(43)

2.3.9 Equipment Search Tab

The Equipment Search tab window is used to search the TCC curve library to find all protective devices/instruments which names contain a given value or string. The results are presented in a tree view according to their type. The elements in each category is then grouped according to other criteria:

• Fuses: grouped by Manufacturer, then by Model. • LVCBs: grouped by Type, then by Manufacturer. • Reclosers: grouped by Type, then by Control Type.

• Overcurrent Relays: grouped by Type, then by Manufacturer • Motor Relays: grouped by Manufacturer.

A green dot on a folder icon indicates that at least one device/instrument is already present in the CYME database. No dot on a folder icon indicates that no device/instrument contained in that folder is in the CYME database.

A green dot next to a device/instrument name indicates that this element is part of the CYME database. To view its properties, right click on the icon and select Properties from the contextual menu. The properties will displayed in a read-only dialog box. To edit the properties, go to the corresponding menu item in the Equipment menu.

A red dot indicates that the element is not part of the CYME database. To include it, right click on it and select Create from the contextual menu. By default, CYME proposes the same syntax than the ID present in the TCC library.

Upon clicking OK, if the ID already exists in the CYME library, the user will be prompted to type in a new ID, as all device/instruments IDs are unique in the CYME database. Once the item is created, a green dot appears next to its name in the list.

You can drag and drop any item showing a green dot on the one-line diagram to create the device/instrument on a section. In the case of an instrument, the related Properties dialog box will be displayed. In the case of a device, the Section Properties dialog box will displayed.

Refer to the Equipment Reference Manual for details about the properties and settings of the devices and instruments.

(44)

2.4 Advanced Project Manager

The Advanced Project Manager is an extensive tool that supports the collaborative and detailed preparation of a project that consists in modifications to the network with related simulations. Its interface is a tab displayed in the Explorer Bar. You can display it the same way as any tab of Explorer Bar.

The Advanced Project Manager allows saving the modifications to the network part of the project as a separate multi-level structure rather than in the network database. The user can link a selection of simulations to projects or sub-projects. These include: voltage drop, short-circuit, load allocation, load growth/load flow and contingency analysis. Also, the network displayed, the database used, the map and the TCC settings database can be linked to a project.

The Advanced Project Manager is an optional feature that is used together with the Network Forecaster module (also optional).

Refer to the Network Forecaster User Guide for more information on the use of the Advanced Project Manager.

(45)

2.5 Toolbars

Toolbars appear directly beneath the main menu. They contain icons that are shortcuts to frequently used menu commands. To control which toolbar to display, use the menu command View > Toolbars (see 9.1); or right-click on an empty part of the toolbar area to display a contextual menu that will allow you to select the toolbars you wish to see.

To customize the contents of the toolbars, use the menu command Customize > Toolbars (see 11.2).

Just like for the menus, the commands are enabled or disabled depending on whether there is an opened study or not.

2.5.1 Main

NEW STUDY. Click on the button to open a new study (blank window) with the temporary title, « New » – "Main" window). Equivalent menu command: File > New Study. Click on the Load Networks button in this toolbar to display the Select Networks dialog box and get started with existing networks (see 7.1).

LOAD NETWORK(S). Displays the Load Networks dialog box that allows you to select the networks to load and view from the active database into the window. Equivalent menu commands: Network > Select Networks (see 7.1).

OPEN STUDY. Displays a list of existing studies. Double-click on the one you want to open. Equivalent menu command: File > Open Study (see4.2).

MERGE STUDY. Displays a list of existing studies. Double-click on the one you want to open and merge with the study currently active. Equivalent menu command: File > Merge Study.

SAVE STUDY. Updates the existing study file, or, if the study is new, creates a study file with the name you specify. By default, study files have the extension *.XST and the self-contained studies have an *.SXST extension. Equivalent menu command: File > Save Study.

PRINT. Prints what you see in the active window section (one-line, report or chart). Equivalent menu command: File > Print.

PRINT PREVIEW. Displays each page of the active window area (one-line, report or chart) as it will look when printed. Equivalent menu command: File > Print Preview (see 4.13).

Use the File > Page Setup to set the layout of your one-line print out (see 4.10). See also Report > Format for the layout setting commands available for reports (see 8.7).

CYME_502-Ref_EN_V1-2

CYME 5.02

Reference Manual

© Copyright CYME International T&D Inc.

Table of Contents

Chapter 1 Getting Started

1.1

Overview of CYME

1.2

About this Manual

1.3

Computer System Requirements

1.4

Databases used by CYME

1.5

Map Formats Supported