quick start guide - zsystemszsystems.ca/lw2qsg.pdf · about this quick start guide this quick start...

of 50/50
Quick Start Guide L i v e W i r e 2 The Professional’s Data Analysis And Visualization Tool Z Systems, Inc. Winnipeg, Canada

Post on 26-Aug-2018

248 views

Category:

Documents

4 download

Embed Size (px)

TRANSCRIPT

  • Quick Start Guide

    L i v e W i r e 2

    The Professionals Data Analysis And Visualization Tool

    Z Systems, Inc. Winnipeg, Canada

  • Table of Contents About this Quick Start Guide............................................................................ 4

    What is LiveWire? ....................................................................................... 4 Whats Included? ........................................................................................ 4

    Installation ................................................................................................... 5 Automatic Installation ................................................................................. 5 Manual Installation...................................................................................... 5

    The Workspace .............................................................................................. 6 Saving your Workspace ............................................................................... 6 Opening a Workspace.................................................................................. 7

    The Navigation Tree ....................................................................................... 9 Tree Components ....................................................................................... 9 How to Access Features and Properties .........................................................10 The Tab Control.........................................................................................10 The Tool Bar .............................................................................................10

    The Worksheet .............................................................................................12 Adding Additional Worksheets......................................................................12 Deleting Worksheets ..................................................................................12 Focus is the Key ........................................................................................13 Moving Components...................................................................................13 Accessing Features and Properties................................................................13

    Annotations..................................................................................................14 Activating the Annotation Layer ...................................................................14 Adding Annotation Objects ..........................................................................14 Resizing Annotation Objects ........................................................................15 Moving Annotation Objects..........................................................................17 Displaying Annotations ...............................................................................17

    Working with Data Sets .................................................................................18 Importing Data From a File Explained ...........................................................18 Copying Data from Another Application .........................................................19 Data Generation and Curve Calculations........................................................20 Reloading Data..........................................................................................22 Data Synchronization .................................................................................22 Sorting Data Alphabetically .........................................................................24

    Record sorting .......................................................................................24 Group sorting.........................................................................................24 Channel sorting......................................................................................25

    Working with Graphs .....................................................................................26 Adding Graphs ..........................................................................................26 Controlling Graph Zoom..............................................................................27 Panning....................................................................................................29 Adjustable Aperture ...................................................................................30 Data Analysis ............................................................................................30 Accessing Features and Properties................................................................32 Multiple Selection of Graphs and Formatting ..................................................32 Copying Data from the Navigation Tree to a Graph .........................................36 Moving Groups of Data into a Graph .............................................................37

    Printing .......................................................................................................39 Introduction..............................................................................................39 Adjustable Margins ....................................................................................39 Adding Print Objects...................................................................................41

    2

  • Final Print .................................................................................................44 Hotkeys (keyboard shortcuts for common actions).............................................47

    General Components..................................................................................47 Graph Components ....................................................................................47 Axis Components.......................................................................................48 Frequency Plots .........................................................................................48

    Technical Support .........................................................................................49 Copyright.....................................................................................................50

    3

  • About this Quick Start Guide This quick start manual is meant to be a quick introduction to LiveWire. It does not cover all the features and capabilities of LiveWire. It does however give you a fast point of reference for common features. For information on all features or more detailed explanations, please consult the comprehensive LiveWire User Manual.

    What is LiveWire? LiveWire is a simple, yet powerful software tool designed to visualize and present time-based data. This application uses a single window split pane user interface. It supports the importation and exportation of industry standard data file formats, such as COMTRADE1 and EMTDC2. It also provides users with the ability to import and export general data formats such as comma separated variable files (*.csv) and text files (*.txt). LiveWire even provides the means to generate data from user-defined equations and import/export data from other applications using the clipboard.

    LiveWire has a very wide range of advanced features not available in similar software packages. Features like smart axis and dynamic aperture controls in both the graphs and plots allow the user to easily navigate through their data. Other features like enhanced tool tips present the user with thumbnail views of data sets. The ability to save and restore LiveWire workspaces (*.lww) provide the user with a sense of comfort and security that their worksheets and imported data files will not have to be regenerated, like many other data analysis packages. The capability to generate Bitmap images on a frame-by-frame basis, allow the user to add results and visual depiction to their reports quickly and effortlessly, without using additional software.

    Whats Included?

    1. 1 - LiveWire CD 2. 1 Quick Start Guide 3. 1 License key (if applicable, see note 1)

    Note 1: If LiveWire is part of a package, it may be licensed under the package License agreement. If so, LiveWire will install without requiring a License/Registration key.

    If LiveWire was not part of a package License agreement then a License/Registration key will be included. If there is any discrepancy then contact the Software Package provider or [email protected]

    1 Common Transient Data Exchange (COMTRADE) IEEE-C37.111 is fully supported for years 1991, 1996(draft), 1997(draft) and 1999 in both ASCII and BINARY and Multi-File spanning.

    2 Electromagnetic Transients for DC (EMTDC). This format uses information files and multi-file spanning to support up to 200 channels.

    4

  • Installation

    Automatic Installation

    1. Insert the LiveWire CD into your CD Rom drive. 2. LiveWire will automatically begin its self-install program. 3. Follow the on screen instructions to continue with the installation.

    Note 1: If installation does not automatically start, follow the manual installation. Note 2: You can hit cancel at any time to stop the installation procedure.

    Manual Installation

    1. Have the LiveWire CD in your CD Rom drive. 2. From the Windows taskbar, click Start Run.

    3. Type {your CD drive letter}:\setup.exe in the Open text box.

    4. Click Ok, then follow the on-screen instruction to install the program. Note 1: You have to determine the drive letter of your CD drive where the LiveWire CD is located and substitute {your CD drive letter}:\setup.exe

    5

  • The Workspace The LiveWire Workspace is an application window and its associated navigation tree window. LiveWire allows users to customize and create workspaces that can be saved and restored from files. As a default, a single worksheet is created in the main window and its associated tree item is created on the navigation tree. Each workspace can contain one or more worksheets. Each worksheet consists of a drawing surface that can be used to layout graphs and other components.

    Saving your Workspace Workspaces in LiveWire can be opened up in the same state they were saved in. This includes loaded data and graph layouts and properties. To save a workspace in LiveWire:

    From the LiveWire menu, click File Save Workspace

    6

  • Or click the button from the toolbar.

    Note 1: When saving a workspace that contains data, which was not imported but rather pastedinto Livewire, be sure to export that data before to ensure that the entire workspace will save properly. The workspace must have a location in memory to store that data.

    Opening a Workspace Saved workspaces (files with the extension .LWW) can be reopened into LiveWire. All data and graphs in their previously saved states will be reloaded. When a workspace is loaded it automatically replaces the existing one. To load a previous workspace in LiveWire:

    From the LiveWire menu, click File Open Workspace

    7

  • Or click the button from the toolbar.

    8

  • The Navigation Tree The Navigation tree is a tree structure that itemizes the worksheets and all the data loaded into LiveWire. The individual worksheet tree items are visual representations of the worksheets currently in LiveWire while the record tree items are visual representations of records of data currently loaded into LiveWire.

    Tree Components

    The Workspace item

    Represents the workspace The Worksheets item

    Represents all worksheets The Worksheet item

    Represents a single worksheet The Data item

    Represents all the data currently loaded in LiveWire The Record item

    Represents a record of data The Trace item

    Represents a single trace or Channel of analog data The Trace item

    Represents a single trace or Channel of analog data Note 1: Data loaded from a file are Blue Data pasted into LiveWire are Purple Data generated by LiveWire are Green

    9

  • How to Access Features and Properties The features and properties of the different tree components can be accessed using the menus.

    Right click on any tree item to bring up the menu associated with the object (data, worksheets) associated with that tree item.

    The Tab Control The bottom of the worksheet contains a tabbed control. Each tab represents a different worksheet in LiveWire. The highlighted tab is associated with the visible worksheet. The user can navigate between all the worksheets either by using the tabs or by clicking on the worksheet tree item.

    The Tool Bar Common operations in LiveWire can be performed quickly by using the shortcut buttons on the main tool bar.

    10

  • 11

  • The Worksheet The LiveWire worksheet is similar to a document; it represents a sheet of paper. This is the area where you will create components, such as graphs and plots, and analyze your data. By default the workspace creates one worksheet to start.

    Adding Additional Worksheets Additional worksheets can be added to the LiveWire workspace. The user can then switch between these multiple worksheets.

    Right click on the Worksheets tree item to pull up the Add Worksheet menu option.

    Or click the icon on the toolbar.

    Deleting Worksheets Worksheets can be deleted from the LiveWire workspace. All graphs will be unloaded and deleted.

    Right click on the Worksheets tree item to pull up the Remove Worksheet menu option.

    Or click the icon on the toolbar.

    12

  • Focus is the Key The tool bar and the keyboard are used to quickly perform common operations in LiveWire. The commands generated by these shortcut tools are sent to the component (graph, worksheet, navigation tree) in focus. Focus is established whenever you click on any part of LiveWire or any component within. For example to bring any graph in focus, left click once on the frame of the graph. All keyboard shortcut keys will be directed toward that graph until another component is pressed or manipulated with the mouse.

    Moving Components All components on the worksheet can be moved anywhere on the worksheet by clicking on them with the mouse and dragging them with the mouse button held down. For most components dragging the frame of the component does this.

    Accessing Features and Properties All features and properties of the worksheet can be accessed using context sensitive menus. The menu context is defined by the mouse pointer location.

    Right click anywhere on the worksheet Or by a double left click on the worksheet tab at the bottom

    Or by right clicking on the tree item associated with this worksheet.

    13

  • Annotations LiveWire has built in annotation support. Annotation objects are placed on a secondary layer that is transparent and sits right over top of the entire canvas.

    Activating the Annotation Layer This layer can be toggled on and off via buttons on the application toolbar.

    Adding Annotation Objects Annotation objects that can be added include:

    Text areas or sticky notes Imported images Lines Circles (filled/non filled) Squares (filled/non filled) Arrows (vertical/horizontal)

    These annotation objects can be created from either the annotation toolbar (visible when annotation layer is active),

    14

  • or by right clicking on the active annotation layer and selecting Add Annotation from the popup menu.

    Resizing Annotation Objects Any object on the annotation layer can be resized by simply left clicking on the object to bring up the green resize pads.

    15

  • By clicking and dragging any of the green resize pads the object will stretch.

    Upon releasing the mouse, the object will be resized.

    16

  • Moving Annotation Objects Objects can also be moved around anywhere on the annotation layer by simply using the mouse and perform a click, drag, and release operation on the object.

    Displaying Annotations Annotations may be toggled on and off at any time by toggling the show annotations button.

    17

  • Working with Data Sets LiveWire can import data in several formats such as:

    Comtrade (*.cfg) EMTDC (*.inf) PTI (PSS/E) (*.asc) Comma separated variable (*.csv) Text (*.txt;*.out)

    Textual data can be separated by common delimiters such as tabs, commas, spaces, etc. Note 1: see comprehensive user guide for detailed explanation of the data types.

    Importing Data From a File Explained The most common method of importing data will be explained here.

    Click on File > Insert Data From File and select the file(s) you wish to load

    18

  • Upon pressing OK in the file dialog box, new data entries in the Navigation Tree will be created.

    Copying Data from Another Application Data separated by common delimiters and in a text format can by copied from any application to LiveWire.

    In another application such as Microsoft Excel, copy the data using the applications copy command. This is typically found in Edit menus or by right clicking on selected data.

    19

  • In LiveWire, Right click anywhere on the worksheet to activate the menu. From the menu, select Paste data from clipboard.

    Note 1: Paste data from clipboard has 2 options, formatted and unformatted. - Formatted text is textual data having its first column being the domain. - Unformatted text is textual data with no domain values (all range data). The

    domain will be calculated from the sample size.

    Data Generation and Curve Calculations Independent data generation You can invoke Independent data generation by:

    Choose the Insert data from equation option available in the application menu or by right clicking on the Data item on the tree. A dialog will come up with user definable properties for generated data.

    1) Enter a name for the trace. 2) Enter an equation using a variable of your choice. 3) Enter start, end, and increment values.

    20

  • 4) Enter the variable used by your equation. 5) Press OK to commit the data or preview, to preview your trace. 6) The newly created data will appear on the Navigation tree in GREEN.

    Dependent data generation (curve calculations) Existing data whether it be generated or from a file can have mathematical operations applied to it. For example one could subtract 2 data sets, multiply them together, or even add 100 data sets together. You can invoke Dependant data generation by:

    Choose the Insert data from equation option available in the application menu or by right clicking on the Data item on the tree. A dialog will come up with user definable properties for generated data item.

    1) Enter a name for the trace. 2) Enter an equation using a variable and/or a trace(s) of your choice from the trace list. 3) Enter start, end, and increment values. 4) Enter the variable used by your equation if one is defined. 5) Choose an operator(s) to be applied. 6) Press OK to commit the data or preview, to preview your trace. 7) The newly created data will appear on the Navigation tree in GREEN.

    21

  • Reloading Data This is a special feature that updates the data in LiveWire when source File data has been changed. A popup box giving the option to reload the file will prompt the user.

    If the user chooses Yes, the data will automatically reload with the changes reflected in all graphs displaying the file dependant data. If the user chooses No, the unaltered data will remain in LiveWire. To force a manual reload, there is a reload button at the top of the application. It can be pressed at anytime to refresh all data.

    Data Synchronization Generated data sets are automatically synchronized to source files. When data loaded from a file has been updated, there is a mechanism inside LiveWire that updates all dependent data (data

    22

  • generated with an external data as one of the variables). Any graph containing dependent data will also be updated. The following illustrates data reloading and synchronization process: External Model LiveWire automatically detects changes when a file has been altered by an external mechanism such as a data logger or simulator.

    The synchronization of data has no bounds. You can have an unlimited number of dependencies and an unlimited number of dependant levels (trace A dependant on trace B dependant on trace C ). As soon as a reload occurs, a trickle effect will update all data starting from the parent (altered file) all the way down to all dependant children (generated data with dependencies). This process repeats itself until all generated data sets have been updated. Internal Model

    Changes in the loaded File Data triggers a regeneration of all Dependent data. Note: For a more detailed explanation and example, please see the LiveWire User Manual.

    23

  • Sorting Data Alphabetically Record sorting Right click on the Data node on the workspace tree and select the Sort records by name option.

    Group sorting Right click on a record node on the workspace tree and select the Sort Groups by name option.

    24

  • Channel sorting Right click on a group node on the workspace tree and select the Sort All option.

    25

  • Working with Graphs The non-specialized graphs in LiveWire (Bar, Digital, and Analog) are divided into 2 categories: Simple graphs Simple graphs provide basic view capabilities. They are used primarily for displaying data between a specific range. Advanced graphs Advanced graphs have all the capabilities of the Simple graphs plus built in specialized analysis features allowing the user to perform point by point analysis on data. The specialized graphs in LiveWire (X-Y, Polar, Harmonic) have very special analysis capabilities built in. These graphs are created in the same way as the non-specialized graphs and behave fundamentally the same. Note 1: For detailed information on all the graphs available in LiveWire, see the comprehensive LiveWire Users Manual.

    Adding Graphs To add a graph in LiveWire:

    Right click anywhere on the worksheet and choose a graph from the menu. The chosen graph will be created where the mouse was pressed.

    Or left click on any of the quick buttons on the tool bar and click anywhere on the

    worksheet. The graph associated with the quick button will be created where the mouse is pressed on the worksheet.

    26

  • Controlling Graph Zoom There are many different ways to zoom in and out of data within the graphs. The following explains a few of the more common techniques. General Zoom In/Out

    Select a desired graph by clicking on its plot area. From the surface of the graph, right-click to generate a pop-up menu. From the pop-up menu click Zoom Zoom In, or Zoom Out. Or press the + or - on the keyboard number pad.

    27

  • Box Zoom

    Select a desired graph by clicking on its plot area. From the surface of the graph, press and drag a box region over the desired area you would like to zoom. When you release, this box is used to define the new X and Y ranges of the graph.

    Vertical Zoom

    Select a desired graph by clicking on its plot area. From the surface of the graph, with the Shift key pressed, drag a region over the desired area you would like to zoom.

    28

  • Hor n

    izo tal Zoom

    Select a desired graph by clicking on its plot area. From the surface of the graph, with

    the Ctrl key pressed, drag a region over the desired area you would like to zoom.

    Reset Zoom

    Select a desired gra

    ph by clicking on its plot area. From the surface of the graph, right-click to generate a pop-up menu. From the pop-up menu click Zoom Reset All, or press the R key.

    pan data. This feature allows a user to view data over a precise region and move rough the rest with the same conditions. To pan, a slide control is located on the bottom of the

    graph.

    From the horizontal axis control region, using the slider, move through the data.

    Panning The advanced graphs have a special feature that is very useful to many users, and that is its ability toth

    29

  • Adjustable Aperture The aperture can be thought of as a window on the domain of a graph. If the aperture is wide open, the entire data domain is visible. In LiveWire, the size of the horizontal panning slider correlates to the size of the aperture with respect to the domain. The aperture can be adjusted on the fly using the mouse and panning slider control.

    From the horizontal axis control region, move the mouse pointer near the edge of the slider control. The mouse pointer will change when the adjustable aperture is active. Left click and drag the mouse to change aperture size.

    When you release, the grids and axis will be automatically recomputed.

    Data Analysis Markers The Markers provide a way to see the value of any given data point. This value is displayed on the top right corners of the advanced graphs. There are two markers in the advanced graphs, the X marker and the O marker. Both markers function the same way and relay the same type of information. The only differences are labeling and calculations between markers. For the marker readouts to display positive range differences, the X (blue) marker must precede the O (red) marker on the domain.

    There are a couple of ways to enable and/or disable the markers; the two most common ways are as follows:

    30

  • From the surface of the graph, right-click to generate a pop-up menu. From the pop-up menu click Preferences Show Markers, or press the M key.

    Or

    From the surface of the horizontal axis control region, right-click to generate a pop-up menu. From the pop-up menu click Axis Properties. From the axis properties dialog box, check the Show Markers box.

    Note 1: From the axis dialog box you can also set the position of each marker by typing in a domain value. Note 2: There are many other analysis tools available, which are discussed in the comprehensive user guide. Crosshairs LiveWire has an option to toggle a mode where by an interactive crosshair is visible as a mouse pointer. The data value at that mouse position will be displayed beside the crosshair.

    There are a couple of ways to enable and/or disable the crosshair; the two most common ways are as follows:

    From the surface of the graph, right-click to generate a pop-up menu. From the pop-up menu click Preferences Show Crosshair, or press the C key.

    Or

    From the surface of the graph, double click the graph to pull up the properties dialog and select the check box for Show Crosshair.

    31

  • Accessing Features and Properties The graph can be broken down into 4 main areas:

    Trace Graph Frame Axis

    Right click the mouse on these areas, menus will pop up corresponding to the various properties and features associated with that area.

    Multiple Selection of Graphs and Formatting To multiply select components, use the mouse and perform a left button click and drag to box a region encompassing the desired components.

    32

  • Aligning graphs To align the components, use the mouse and right click over any of the multiply selected components. Select the Align option from the menu.

    33

  • Format the spacing between graphs To format the spacing, use the mouse and right click over any of the multiply selected components. Select the Evenly space option from the menu.

    34

  • Moving multiply selected graphs Using the mouse, perform a left click and drag on any of the multiply selected components. The group as a whole will move.

    35

  • Copying Data from the Navigation Tree to a Graph To visualize any loaded data in LiveWire, one must copy the data from the tree and paste it into an appropriate graph. To perform a data drag and drop (copy/paste) from the tree to a graph:

    Using your mouse, select a trace from the data set object in the tree view, click and drag it over into the worksheet, and drop it on the desired graph.

    36

  • Or To perform a data menu driven (copy/paste) from the tree to a graph:

    From the tree, select a trace and right-click to generate a pop-up menu. From the pop-up menu click Copy as Curve.

    From the surface of one of the graphs, right-click to generate a pop-up menu. From the pop-up menu click Paste Curve.

    Moving Groups of Data into a Graph Hold either the Ctrl or Shift key down on the keyboard while selecting the desired traces from the tree. They will highlight as you select each one and be handled as a group. Now you can perform a drag and drop just as you did for single channels.

    The group of data, as a whole, will transfer into the graph.

    37

  • 38

  • Printing

    Introduction LiveWire allows the user to customize a printing template that is used to print all pages during a print job. Elements such as margins, page numbers, and images can be added in just a few minutes. LiveWire makes custom printing easy by breaking down the process into 3 easy steps.

    Set your margins Add custom printing elements Print!

    The customizable printing template is used for all printed pages and is saved along with the workspace and all worksheets. It can be accessed via the tree and the Print Layout node.

    Adjustable Margins Margins can be set graphically by clicking/dragging the margins.

    1) Go to the Print Layout

    2) Activate annotation layer

    39

  • 3) Drag margins by click and drag with the mouse

    OR The margins can be adjusted via the properties box.

    1) Right click on the Print Layout

    2) Select Properties from the menu

    40

  • 3) Manually enter a percentage for the margin

    Adding Print Objects If you adjust all four margins, the print layout will now consist of 8 separate cells that surround a center worksheet cell.

    41

  • Within the 8 bordering cells, print objects can be added that will be visible on every printed worksheet. Print objects can be added by using the built in menu system.

    1) Make sure the annotation layer is turned off.

    2) Right click the mouse over one of the bordering eight cells.

    42

  • 3) Select from the list of print objects

    4) Place object by drag and drop

    43

  • Before

    After

    Final Print When you have assembled your printing template, all printed documents will adopt this template during a print job. The following is an example of a fully constructed printing template.

    44

  • The next set of images depicts a worksheet during draft time and then what it looks like at print time when it adopts the global print template.

    The last set of images depicts a different worksheet during draft time and thane what it looks like at print time when it adopts the global print template.

    45

  • 46

  • Hotkeys (keyboard shortcuts for common actions)

    General Components Key Press

    Action

    Ctrl + N Create new workspace Ctrl + O Open existing workspace Ctrl + S Save workspace Ctrl + P Print workspace Ctrl + V Paste component from clipboard Ctrl + C Copy component to the clipboard

    Graph Components Key Press

    Action

    + Zoom in - Zoom out P Undo zoom N Redo zoom X Reset horizontal axis Y Reset vertical axis R Rest both axis G Enable/disable grid I Enable/disable tick marks K Enable/disable glyphs/hatch O Enable/disable offset component M Enable/disable markers Q Enable/disable x intercept W Enable/disable y intercept C Enable/disable crosshair H Toggle crosshair mode Tab Set next curve active Space

    Set next curve active

    47

  • Axis Components Key Press

    Action

    Move O marker to the left Move O marker to the right Move X marker to the left Move X marker to the right X Snap the X marker to the mouse O Snap the O marker to the mouse L Lock the markers F

    Toggle data marker readout

    Frequency Plots Key Press

    Action

    1 Display the magnitude plot 2 Display the phase plot

    48

  • Technical Support Z Systems is committed to providing you with comprehensive technical support. Before Contacting Technical Support Before you contact our technical support department, please try to resolve your problems by using this guide and/or the Z Systems, Inc. web site. Tips

    Your problem may be resolved by applying the most recent patch or upgrade of the software.

    Your product registration key is required to obtain technical support.

    Contact Information

    Company Headquarters: Z Systems, Inc. 102 545 Hervo st. Winnipeg, Manitoba Canada R3T 3L6

    Phone Number: (204) 453-1755

    Fax Number:

    (204) 474-1543

    Support E-Mail: [email protected]

    Company Web Site: http://www.zsystems.ca

    Please include a description of your problem. Also include a return address, daytime phone number, and/or any other relevant information.

    49

  • Copyright Copyright 2004 Z Systems, Inc. All Rights Reserved. The entire risk of the use or the result of the use of this software and the documentation remains with the user. No part of this document may be reproduced or transmitted in any means, electronic or mechanical, for any purpose, except as expressed in the Software License Agreement. Z Systems, Z Systems Logo, and LiveWire are trademarks of Z Systems, Inc. All other brand and product names are trademarks or registered trademarks of their respective owners.

    50