HYSYS GetStart PDF

Copyright Notice
The copyright in this manual and its associated computer program are the property of AEA Technology - Hyprotech Ltd. All rights reserved. Both this manual and the computer program have been provided pursuant to a License Agreement containing restrictions on use. Hyprotech reserves the right to make changes to this manual or its associated computer program without obligation to notify any person or organization. Companies, names and data used in examples herein are fictitious unless otherwise stated. No part of this manual may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any other language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical manual or otherwise, or disclosed to third parties without the prior written consent of AEA Technology Engineering Software, Hyprotech Ltd., Suite 800, 707 - 8th Avenue SW, Calgary AB, T2P 1H5, Canada. 2000 AEA Technology - Hyprotech Ltd. All rights reserved. HYSYS, HYSYS.Plant, HYSYS.Process, HYSYS.Refinery, HYSYS.Concept, HYSYS.OTS, HYSYS.RTO and HYSIM are registered trademarks of AEA Technology Engineering Software - Hyprotech Ltd. Microsoft Windows, Windows 95/98, Windows NT and Windows 2000 are registered trademarks of the Microsoft Corporation. This product uses WinWrap Basic, Copyright 1993-1998, Polar Engineering and Consulting.
Documentation Credits
Authors of the current release, listed in order of historical start on project: Sarah-Jane Brenner, BASc; Conrad, Gierer, BASc; Chris Strashok, BSc; Lisa Hugo, BSc, BA; Muhammad Sachedina, BASc; Allan Chau, BSc; Adeel Jamil, BSc; Nana Nguyen, BSc; Yannick Sternon, BIng;Kevin Hanson, PEng; Chris Lowe, PEng Since software is always a work in progress, any version, while representing a milestone, is nevertheless but a point in a continuum. Those individuals whose contributions created the foundation upon which this work is built have not been forgotten. The current authors would like to thank the previous contributors. A special thanks is also extended by the authors to everyone who contributed through countless hours of proof-reading and testing.
Contacting AEA Technology - Hyprotech

AEA Technology - Hyprotech can be conveniently accessed via the following: Website: Technical Support: Information and Sales: www.software.aeat.com support@software.aeat.com Info@software.aeat.com
Detailed information on accessing Hyprotech Technical Support can be found in the Technical Support section in the preface to this manual.
Table of Contents
1 Welcome to HYSYS .......................................... 1-1
1.1 1.2 1.3 Hyprotech Software Solutions ........................................... 1-1 Use of the Manuals ........................................................... 1-5 Technical Support ........................................................... 1-11
Installing HYSYS .............................................. 2-1

2.1 2.2 2.3 2.4 Basic Requirements .......................................................... 2-1 Installing HYSYS ............................................................... 2-2 The Standalone Key Version of HYSYS ........................... 2-4 The Network Key Version of HYSYS ................................ 2-9
Get Started ....................................................... 3-1

3.1 3.2 3.3 Starting HYSYS................................................................. 3-1 Steady State Case ............................................................ 3-5 Dynamics Case ............................................................... 3-15
iii
iv
Welcome to HYSYS
1-1
1 Welcome to HYSYS
We are pleased to present you with the latest version of HYSYS the product that continually extends the bounds of process engineering software. With HYSYS you can create rigorous steady-state and dynamic models for plant design and trouble shooting. Through the completely interactive HYSYS interface, you have the ability to easily manipulate process variables and unit operation topology, as well as the ability to fully customize your simulation using its OLE extensibility capability.
1.1
Hyprotech Software Solutions
HYSYS has been developed with Hyprotechs overall vision of the ultimate process simulation solution in mind. The vision has led us to create a product that is:
Integrated Intuitive and interactive Open and extensible
Integrated Simulation Environment

In order to meet the ever-increasing demand of the process industries for rigorous, streamlined software solutions, Hyprotech developed the HYSYS Integrated Simulation Environment. The philosophy underlying our truly integrated simulation environment is conceptualized in the diagram below:
Figure 1.1
1-1
1-2
The central wedge represents the common parameters at the core of the various modelling tools:
model topology interface thermodynamics

The outer ring represents the modelling application needs over the entire plant lifecycle. The arrows depict each Hyprotech product using the common core, allowing for universal data sharing amongst the tools, while providing a complete simulation solution. As an engineer you undoubtedly have process modelling requirements that are not all handled within a single package. The typical solution is to generate results in one package, then transfer the necessary information into a second package where you can determine the additional information. At best, there is a mechanism for exchanging information through file transfer. At worst, you must enter the information manually, consuming valuable time and risking the introduction of data transfer errors. Often the knowledge you gain in the second application has an impact on the first model, so you must repeat the whole process a number of times in an iterative way. In a truly integrated simulation environment all of the necessary applications work is performed within a common framework, eliminating the tedious trial-and-error process described previously. Such a system has a number of advantages:
Information is shared, rather than transferred, among applications. All applications use common thermodynamic models. All applications use common flowsheet topology. You only need to learn one interface. You can switch between modelling applications at any time, gaining the most complete understanding of the process.
The plant lifecycle might begin with building a conceptual model to determine the basic equipment requirements for your process. Based on the conceptual design, you could build a steady-state model and perform an optimization to determine the most desirable operating conditions. Next, you could carry out some sizing and costing calculations for the required equipment, then do some dynamic modelling to determine appropriate control strategies. Once the design has become a reality, you might perform some on-line modelling using actual plant data for "what-if" studies, troubleshooting or even on-line optimization. If a change at any stage in the design process affects the common data, the new information is available immediately to all the other applications no manual data transfer is ever required.
1-2
Welcome to HYSYS
1-3
While this concept is easy to appreciate, delivering it in a useable manner is difficult. Developing this multi-application, informationsharing software environment is realistically only possible using Object Oriented Design methodologies, implemented with an Object Oriented Programming Language. Throughout the design and development process, we have adhered to these requirements in order to deliver a truly integrated simulation environment as the HYSYS family of products:
HYSYS Product For information on any of these products, contact your local Hyprotech representative. Description Process Design - HYSYS.Process provides the accuracy, speed and efficiency required for process design activities. The level of detail and the integrated utilities available in HYSYS.Process allows for skillful evaluation of design alternatives. Plant Design - HYSYS.Plant provides an integrated steady-state and dynamic simulation capability, offers rigorous and high-fidelity results with a very fine level of equipment geometry and performance detail. HYSYS.Plant+ provides additional detailed equipment configurations, such as actuator dynamics. Refinery Modeling - HYSYS.Refinery provides truly scalable refinery-wide modeling. Detailed models of reaction processes can be combined with detailed representations of separation and heat integration systems. Each hydrocarbon stream is capable of predicting a full range of refinery properties based on a Refinery Assay matrix. Operations Training System - HYSYS.OTS provides real-time simulated training exercises that train operations personnel and help further develop their skills performing critical process operations. Increased process understanding and procedural familiarity for operations personnel can lead to an increase in plant safety and improvements in process performance. Real-Time Optimization - HYSYS.RTO is a realtime optimization package that enables the optimization of plant efficiency and the management of production rate changes and upsets in order to handle process constraints and maximize operating profits. Conceptual Design Application - HYSYS.Concept includes DISTIL which integrates the distillation synthesis and residue curve map technology of Mayflower with data regression and thermodynamic database access. HYSYS.Concept also includes HX-Net, which provides the ability to use pinch technology in the design of heat exchanger networks. Conceptual design helps enhance process understanding and can assist in the development of new and economical process schemes.
HYSYS.Process
HYSYS.Plant
HYSYS.Refinery
HYSYS.OTS
HYSYS.RTO
HYSYS.Concept
1-3
1-4
Intuitive and Interactive Process Modelling

We believe that the role of process simulation is to improve your process understanding so that you can make the best process decisions. Our solution has been, and continues to be, interactive simulation. This solution has not only proven to make the most efficient use of your simulation time, but by building the model interactively with immediate access to results you gain the most complete understanding of your simulation. HYSYS uses the power of Object Oriented Design, together with an Event-Driven Graphical Environment, to deliver a completely interactive simulation environment where:
calculations begin automatically whenever you supply new information, and access to the information you need is in no way restricted.
At any time, even as calculations are proceeding, you can access information from any location in HYSYS. As new information becomes available, each location is always instantly updated with the most current information, whether specified by you or calculated by HYSYS.
Open and Extensible HYSYS Architecture

HYSYS is the only commercially available simulation platform designed for complete User Customization.
The Integrated Simulation Environment and our fully Object Oriented software design has paved the way for HYSYS to be fully OLE compliant, allowing for complete user customization. Through a completely transparent interface, OLE Extensibility lets you:
develop custom steady-state and dynamic unit operations specify proprietary reaction kinetic expressions create specialized property packages.
With seamless integration, new modules appear and perform like standard operations, reaction expressions or property packages within HYSYS. The Automation features within HYSYS expose many of the internal Objects to other OLE compliant software like Microsoft Excel, Microsoft Visual Basic and Visio Corporations Visio. This functionality enables you to use HYSYS applications as calculation engines for your own custom applications. By using industry standard OLE Automation and Extension the custom simulation functionality is portable across Hyprotech software updates. The open architecture allows you to extend your simulation functionality in response to your changing needs.
1-4
Welcome to HYSYS
1-5
1.2
Use of the Manuals
HYSYS Electronic Documentation

The HYSYS Documentation Suite includes all available documentation for the HYSYS family of products.
All HYSYS documentation is available in electronic format as part of the HYSYS Documentation Suite. The HYSYS Documentation CD-ROM is included with your package and may be found in the Get Started box. The content of each manual is described in the following table:
Manual Description Contains the information needed to install HYSYS, plus a Quick Start example to get you up and running, ensure that HYSYS was installed correctly and is operating properly. Provides in depth information on the HYSYS interface and architecture. HYSYS Utilities are also covered in this manual. Contains all information relating to the available HYSYS fluid packages and components. This includes information on the Oil Manager, Hypotheticals, Reactions as well as a thermodynamics reference section. Steady state operation of HYSYS unit operations is covered in depth in this manual. This manual contains information on building and running HYSYS simulations in Dynamic mode. Dynamic theory, tools, dynamic functioning of the unit operations as well as controls theory are covered. This manual is only included with the HYSYS.Plant document set. Details the many customization tools available in HYSYS. Information on enhancing the functionality of HYSYS by either using third-party tools to programmatically run HYSYS (Automation), or by the addition of user-defined Extensions is covered. Other topics include the current internally extensible tools available in HYSYS: the User Unit Operation and User Variables as well as comprehensive instruction on using the HYSYS View Editor. Provides step-by-step instructions for building some industry-specific simulation examples. Contains a more advanced set of example problems. Note that before you use this manual, you should have a good working knowledge of HYSYS. The Applications examples do not provide many of the basic instructions at the level of detail given in the Tutorials manual. Provides quick access to basic information regarding all common HYSYS features and commands.
Get Started
Users Guide
Simulation Basis
Steady State Modeling
Dynamic Modeling
Customization Guide
Tutorials
Applications
Quick Reference
1-5
1-6
Use of the Manuals
Contact Hyprotech for information on HYSYS training courses.
If you are new to HYSYS, you may want to begin by completing one or more of the HYSYS tutorials, which give the step-by-step instructions needed to build a simulation case. If you have some HYSYS experience, but would still like to work through some more advanced sample problems, refer to the HYSYS Applications. Since HYSYS is totally interactive, it provides virtually unlimited flexibility in solving any simulation problem. Keep in mind that the approach used in solving each example problem presented in the HYSYS documentation may only be one of the many possible methods. You should feel free to explore other alternatives.
Viewing the On-Line Documentation

HYSYS On-Line Documentation is viewed using the Adobe Acrobat Reader, which is included on the Documentation CD-ROM. Install Acrobat Reader on your computer following the instructions on the CD-ROM insert card. Once installed, you can view the electronic documentation either directly from the CD-ROM, or you can copy the Doc folder (containing all the electronic documentation files) and the file named main.pdf to your hard drive before viewing the files. Manoeuvre through the on-line documentation using the bookmarks on the left of the screen, the navigation buttons in the button bar or using the scroll bars on the side of the view. Blue text indicates an active link to the referenced section or view. Click on that text and Acrobat will jump to that particular section.
Attaching the On-line CD Index

One of the advantages in using the HYSYS Documentation CD is the ability to do power searching using the Adobe Acrobat Query tool. By selecting the Query button or selecting Query from the Search submenu of the Tools menu, you can search simultaneously through all the manuals for keywords.
For more information on the search tools available in Adobe Acrobat Reader, consult the Help files provided with the Reader.
In order to make use of this powerful searching tool, you must attach the index file to Acrobat using the following procedure: 1. To open the Index Selection view you must do one of the following:
Select Indexes from the Search submenu in the Tools menu. Press CTRL SHIFT X
2. Press the Add button. This should open the Add Index view.
1-6
Welcome to HYSYS
1-7
3.
Ensure that the Look in field is currently set to your CD-ROM drive label. There should be two directories visible from the root directory: Acrobat and Doc.
Figure 1.2
4.
Open the Doc directory. Inside it you should find the Index.pdx file. Select it and press the Open button.
Figure 1.3
5.
The Index Selection view should display the HYSYS Documentation Index to be attached. Press the OK button and you may begin making use of the Query tool.
Other Acrobat features include a zoom-in tool in the button bar, which allows you to magnify the text you are reading. If you wish, you may print pages or chapters of the online documentation using the FilePrint command under the menu.
1-7
1-8
Use of the Manuals
Conventions used in the Manuals

The following section lists a number of conventions used throughout the documentation.
Keywords for Mouse Actions

As you work through various procedures in the manuals, you will be given instructions on performing specific functions or commands. Instead of repeating certain phrases for mouse instructions, keywords are used to imply a longer instructional phrase:
Keywords Point Action Move the mouse pointer to position it over an item. For example, point to an item to see its Tool Tip. Position the mouse pointer over the item, and rapidly press and release the left mouse button. For example, click Close button to close the current window. As for click, but use the right mouse button. For example, right-click an object to display the Object Inspection menu. Position the mouse pointer over the item, then rapidly press and release the left mouse button twice. For example, double-click the HYSYS icon to launch the program. Position the mouse pointer over the item, press and hold the left mouse button, move the mouse while the mouse button is down, and then release the mouse button. For example, you drag items in the current window, to move them. Whenever you pass the mouse pointer over certain objects, such as tool bar icons and flowsheet objects, a Tool Tip will be displayed. It will contain a brief description of the action that will occur if you click on that button or details relating to the object.
These are the normal (default) settings for the mouse, but you can change the positions of the left- and right-buttons.
Click
Right-Click
Double-Click
Drag
Tool Tip
A number of text formatting conventions are also used throughout the manuals:
Format When you are asked to invoke a HYSYS menu command, the command is identified by bold lettering. When you are asked to select a HYSYS button, the button is identified by bold, italicized lettering. Example File-Save indicates opening the File menu and choosing the Save command.
Cancel identifies the Cancel button on a particular view.
1-8
Welcome to HYSYS
1-9
Format When you are asked to select a key or keys to perform a certain function, keyboard commands are identified by words in bold and small capitals (small caps). The name of a HYSYS View (or window) is indicated by bold lettering. The name of a Group within a view is identified by bold lettering. The name of Radio Buttons and Check Boxes are identified by bold lettering. Note that blank spaces are acceptable in the names of streams and unit operations. Material and energy stream names are identified by bold lettering. Unit operation names are identified by bold lettering. HYSYS unit operation types are identified by bold, uppercase lettering. When you are asked to provide keyboard input, it will be indicated by bold lettering.
Example "Select the F1 key."
Session Preferences Initial Build Home View. Ignored Column Feed, CondenserDuty Inlet Separator, Atmospheric Tower HEAT EXCHANGER, SEPARATOR, "Type 100 for the stream temperature."
Bullets and Numbering

Bulleted and numbered lists will be used extensively throughout the manuals. Numbered lists are used to break down a procedure into steps, for example: 1. 2. 3. Select the Name cell. Type a name for the operation. Press ENTER to accept the name.
Bulleted lists are used to identify alternative steps within a procedure, or for simply listing like objects. A sample procedure that utilizes bullets is: 1. Move to the Name cell by doing one of the following:
Select the Name cell Press ALT N

2. Type a name for the operation.
Press ENTER to accept the name.

Notice the two alternatives for completing Step 1 are indented to indicate their sequence in the overall procedure.
1-9
1-10
Use of the Manuals
A bulleted list of like objects might describe the various groups on a particular view. For example, the Options page of the Simulation tab on the Session Preferences view has three groups, namely:
General Options Errors Column Options
Callouts
A callout is a label and arrow that describes or identifies an object. An example callout describing a graphic is shown below.
Figure 1.4
HYSYS Icon
Annotations
Annotation text appears in the outside page margin.
Text appearing in the outside margin of the page supplies you with additional or summary information about the adjacent graphic or paragraph. An example is shown to the left.
Shaded Text Boxes

A shaded text box provides you with important information regarding HYSYS' behaviour, or general messages applying to the manual. Examples include:
The resultant temperature of the mixed streams may be quite different than those of the feed streams, due to mixing effects.
Before proceeding, you should have read the introductory section which precedes the example problems in this manual.
The use of many of these conventions will become more apparent as you progress through the manuals.
1-10
Welcome to HYSYS
1-11
1.3
Technical Support
There are several ways in which you can contact Technical Support. If you cannot find the answer to your question in the manuals, we encourage you to visit our Website at www.software.aeat.com, where a variety of information is available to you, including:
answers to frequently asked questions example cases and product information technical papers news bulletins hyperlink to support email.
You can also access Support directly via email. A listing of Technical Support Centres including the Support email address is at the end of this chapter. When contacting us via email, please include in your message:
Your full name, company, phone and fax numbers. The version of HYSYS you are using (shown in the Help, About HYSYS view). The serial number of your HYSYS security key. A detailed description of the problem (attach a simulation case if possible).
We also have toll free lines that you may use. When you call, please have the same information available.
1-11
1-12
Technical Support
1.3.1
Calgary, Canada
Technical Support Centres

support@software.aeat.com (email) (403) 520-6181 (local - technical support) 1-888-757-7836 (toll free - technical support) (403) 520-6601 (fax - technical support) 1-800-661-8696 (information and sales)
AEA Technology Engineering Software Hyprotech Ltd. Suite 800, 707 - 8th Avenue SW Calgary, Alberta T2P 1H5
Barcelona, Spain (Rest of Europe)

AEA Technology Engineering Software Hyprotech Europe S.L. Pg. de Grcia 56, 4th floor E-08007 Barcelona, Spain support@software.aeat.com (email) +34 93 215 68 84 (technical support) 900 161 900 (toll free - technical support - Spain only) +34 93 215 42 56 (fax - technical support) +34 93 215 68 84 (information and sales)
Oxford, UK (UK clients only)

AEA Technology Engineering Software Hyprotech 404 Harwell, Didcot Oxfordshire, OX11 0RA United Kingdom support@software.aeat.com (email) 0800 7317643 (freephone technical support) +44 1235 434351 (fax - technical support) +44 1235 435555 (information and sales)
Kuala Lumpur, Malaysia

AEA Technology Engineering Software Hyprotech Ltd., Malaysia Lot E-3-3a, Dataran Palma Jalan Selaman , Jalan Ampang 68000 Ampang, Selangor Malaysia support@software.aeat.com (email) +60 3 470 3880 (technical support) +60 3 471 3811 (fax - technical support) +60 3 470 3880 (information and sales)
Yokohama, Japan
AEA Technology Engineering Software AEA Hyprotech KK Plus Taria Bldg. 6F. 3-1-4, Shin-Yokohama Kohoku-ku Yokohama, Japan 222-0033 support@software.aeat.com (email) 81 45 476 5051 (technical support) 81 45 476 5051 (information and sales)
1-12
Welcome to HYSYS
1-13
1.3.2
Calgary, Canada
Offices
Yokohama, Japan Tel: 81 45 476 5051 Fax: 81 45 476 3055
Tel: (403) 520-6000 Fax: (403) 520-6040/60 Toll Free: 1-800-661-8696 Newark, DE, USA Tel: (302) 369-0773 Fax: (302) 369-0877 Toll Free: 1-800-688-3430 Oxford, UK Tel: +44 1235 435555 Fax: +44 1235 434294 Oudenaarde, Belgium Tel: +32 55 310 299 Fax: +32 55 302 030 Hovik, Norway Tel: +47 67 10 6464 Fax: +47 67 10 6465 Kuala Lumpur, Malaysia Tel: +60 3 470 3880 Fax: +60 3 470 3811
Houston, TX, USA Tel: (713) 339-9600 Fax: (713) 339-9601 Toll Free: 1-800-475-0011 Barcelona, Spain Tel: +34 93 215 68 84 Fax: +34 93 215 42 56 Dsseldorf, Germany Tel: +49 211 577933 0 Fax: +49 211 577933 11 Cairo, Egypt Tel: +20 2 720 0824 Fax: +20 2 702 0289 Seoul, Korea Tel: 82 2 3453 3144 5 Fax: 82 2 3453 9772
1-13
1-14
Technical Support
1.3.3
Agents
Tel: (281) 492-2774 Fax: (281) 492-8144 Tel: 86 10 6499 3956 Fax: 86 10 6499 3957 Tel: 886 2 809 6704 Fax: 886 2 809 3095 Tel: 57 1 258 44 50 Fax: 57 1 258 44 50 Tel: 91 124 346962 Fax: 91 124 346355 Tel: 27 11 465 3800 Fax: 27 11 465 4548 Tel: 61 7 544 81 355 Fax: 61 7 544 81 644 Tel: +421 7 4488 8286 Fax: +421 7 4488 8286 Tel: 62 21 567 4573 75/62 21 567 4508 10 Fax: 62 21 567 4507/62 21 568 3081 Tel: 66 2 381 1020 Fax: 66 2 381 1209 Tel: +401 330 0125 Fax: +401 311 3463 Tel: 52 5 546 5440 Fax: 52 5 535 6610 Tel: 55 11 533 2381 Fax: 55 11 556 10746 Tel: 54 11 4555 5703 Fax: 54 11 4551 0751 Tel: 58 2 264 1873 Fax: 58 2 265 9509 Tel: +7 095 202 4370 Fax: +7 095 202 4370
International Innotech, Inc. Katy, USA International Innotech, Inc. Beijing, China International Innotech Taipei, Taiwan KBTECH Ltda. Bogota, Colombia KLG Systel New Delhi, India Logichem Process Johannesburg, South Africa Process Solutions Pty. Ltd. Peregian, Australia Protech Engineering Bratislava, Slovak Republic PT. Danan Wingus Sakti Jakarta, Indonesia Ranchero Services (Thailand) Co. Ltd. Bangkok, Thailand S.C. Chempetrol Service srl Bucharest, Romania Soteica De Mexico Mexico D.F., Mexico Soteica Do Brasil Sao Paulo, Brazil Soteica S.R.L. Buenos Aires, Argentina Soteiven C.A. Caracas, Venezuela ZAO Techneftechim Moscow, Russia
Internet
Website: www.software.aeat.com Email: info@software.aeat.com
1-14
Installing HYSYS
2-1
2 Installing HYSYS
2.1 Basic Requirements
Requirement Microsoft Windows 2000/NT 4.0/98/95 Approximately 90 MB of free disk space is required. The GREEN security key used with the "standalone key" version of HYSYS can only be attached to a serial communications port of the computer running the application (do not plug in a serial mouse behind the security key). The BEIGE security key used with the "network key" version of HYSYS must be attached to the parallel communications port of a computer on the network. Minimum usable: SVGA (800x600). Recommended: SVGA (1024x768). Required. Note that a mouse cannot be plugged into the back of the green serial port key used with the "standalone" version of HYSYS. System Component Operating System Disk Space
Serial Port
Parallel Port
Monitor/Video
Mouse
2-1
2-2
Installing HYSYS
2.2
Installing HYSYS
The following instructions are written assuming installation on Windows 2000/NT 4.0 or Windows 95/98. The HYSYS installation program creates files only in the directory specified to it during the installation setup procedure. 1. 2. Shut down all other operating Windows programs on the computer before starting the installation process. Insert the HYSYS software CD into the CD-ROM drive of the computer.
Note that for computers which have the CD-ROM Autorun feature enabled, steps #3 and #4 will be automatically performed.
3. 4. From the Start Menu, select Run In the Run dialog box, type: d:\setup.exe and click on the OK button (where d: corresponds to the drive letter of the CD-ROM drive). Select Prcoess or Plant to install either of these products. You must have a valid Product Install Code to install any selected product.
Figure 2.1
5.
2-2
Installing HYSYS
2-3
6.
Follow the on-screen instructions to proceed with installation. The Product Install Code (PIC) requested by the installation program is located on a sticker affixed to the CD case. The PIC controls whether a Standalone Key version (see Chapter 2.3 - The Standalone Key Version of HYSYS) or Network Key version (see Chapter 2.4 - The Network Key Version of HYSYS) is installed.
Figure 2.2
2-3
2-4
The Standalone Key Version of HYSYS
2.3
The standalone key version of HYSYS checks for the presence of a GREEN AEA Technology hardware security key on the serial (COM) port of the computer running the software. If you are using a BEIGE Rainbow Technologies Inc. NetSentinel-C security key refer to Section 2.4 - The Network Key Version of HYSYS.
Connecting the Security Device

The arrow on the label indicates the proper orientation of the key (the arrow must point towards the computer). The key can be plugged into either a 9-pin or 25-pin serial port. AEA Technology ships a 9 to 25-pin converter with the key but a standard modem cable can also be used. The ports on the rear of many PCs are unlabelled. For the serial ports (9 or 25-pin) the "pins" of the connector are visible. For the parallel port and the video port where the monitor is plugged in, a "socket" type connector can be seen. To prevent damage, all equipment should be switched off when connecting/disconnecting devices from ports on the computer. The security key has limited pass-through capabilities. Certain other serial peripherals may be connected to the back of the key to allow non-concurrent use of the security key and the peripheral. Do not plug a serial mouse into the back of the key. The mouse will operate, but HYSYS will be unable to find the key.
Do not plug a serial mouse into the back of the green AEA Technology security key.
2.3.1
HYSYS Installation to a Network Server
The following discussion is optional and applies to both the standalone key and network key versions of HYSYS.
If HYSYS is to be run on a relatively large number of computers, it may be advantageous to install the software on a network server rather than on individual computer hard disks. The disadvantage of installing the software on a network server is that HYSYS startup will be slower as the program is loaded over the network from the hard disk of the server into the memory on the local computer.
Except for the fact that it searches for a security key on the network, rather than on a serial port of the local computer, the network key version of HYSYS is identical to the standalone key version.
2-4
Installing HYSYS
2-5
Installing HYSYS onto a server follows exactly the same process as outlined in the previous section. Simply choose the network drive instead of the local drive when on the Select Components screen. To prevent accidental modification or deletion of files, it is recommended that HYSYS users be allowed read-only access to the software. Each HYSYS user should then configure an individual preferences file as follows and store that file on their local hard disk (or write-enabled network drive). To run HYSYS on users computers, 1. 2. Create a shortcut to HYSYS.EXE (on the desktop or in the Start menu). Set the Start In directory to a directory on the local hard disk (e.g. C:\AEA Technology\HYSYS). On startup, HYSYS will search this directory for the user's preferences file (HYSYS.PRF). In this directory, create the subdirectories CASES, PAKS and USER. Start HYSYS and, from the menu bar, select Tools, then Preferences. Go to the Files tab of the Session Preferences view and select Locations. Configure the Default Files and Paths as is shown in the accompanying Figure 2.3. These are suggestions only and some modification may be required depending on the circumstances.
Figure 2.3
3. 4. 5. 6.
7.
Select the Save Preference Set button, and direct the file save operation to the HYSYS working directory on the local disk.
2-5
2-6
2.3.2
Potential Problems Starting the Standalone Key Version of HYSYS
HYSYS displays the message "Error X: This Security Key has an Invalid Serial Number. (Error sub-code X)"
The HYSYS software is coded to operate with either a single security key or a group of security keys in use at your organization. Check the Product Install Code label on the CD case for the number of the security key for which the Product Install Code was produced. If the security key number on the label matches that on the key being used, contact AEA Technology for resolution of the problem. If the security key number on the label does not match that of the key, but you believe that this key is one of a group of keys that are interchangeable, contact AEA Technology for resolution of the problem. When contacting AEA Technology, provide both the security key number and the Product Install Code.
HYSYS displays "Error X: Cannot find a Security Key on a serial port of this computer. (Error sub-code X)".
Use the following checklist to diagnose the problem: 1. Check that the green AEA Technology security key is correctly connected to the serial port of the computer. The arrow on the key must point towards the computer. If it is pointing away from the computer, it is plugged into the parallel port (connecting the key to the parallel port may de-program the key). While the key can connect directly to a 25-pin serial port, a converter (supplied with the key) is required to attach the key to a 9-pin serial port. A standard external modem cable can also be used for this purpose. Consider the possibility that the fault lies in the cable, if one is being used. 2. 3. Ensure that a serial mouse is not plugged into the back of the key. The mouse will work, but HYSYS will not find the security key. Check for another operating Windows program that is configured to use the serial port. There does not need to be an external device (e.g. modem) actually connected to the port for this to be the problem. A recurring problem which fits this description is monopolization of the serial port by the hotlink software for personal digital assistants (PDA) like the Palm Pilot.
2-6
Installing HYSYS
2-7
4.
If HYSYS still cannot see the security key, the two possibilities that remain are that the key has been de-programmed (they are quite robust and this rarely occurs) or the serial port of the computer is non-functional (disabled, misconfigured or suffering from a hardware problem). If the opportunity exists, this is a good time to install the software and key on another computer(s). If HYSYS still cannot see the key on a second computer, there is a good possibility that the key is non-functional. Another valid test is to check the key on another computer that has other AEA Technology software installed that also uses the same kind of key (most AEA Technology "standalone" software uses the same green hardware key). Even if not configured to work with this new key, the software will display an error message making it obvious whether or not the key was found. If the key is found by the software, the error message will be similar to Invalid Serial Number or This security key is not licensed to run this program. If the software does not see the key, the error message will be of the form, Could not find security device. If the key cannot be found by AEA Technology software on several computers, you should contact AEA Technology Technical Support for further information. If HYSYS is able to see the security key on another computer, then the problem on the first computer lies with the serial port. Contact your companys IT personnel for assistance in solving this problem. Because these problems are machine specific, AEA Technology's Technical Support staff can be of limited assistance. These cases and are best handled by on-site personnel.
Security Key Tips for IT Personnel

An excellent test (Win 2000/NT/98/95) to determine if the serial port is functional is to disconnect the normally used mouse and attach a serial mouse to the port. If Windows reports that a mouse could not be found on startup, then the port is not working. If Windows does find the mouse, the port itself may still be disabled, preventing its use by other peripherals, so that needs to be checked (in the CMOS setup). Windows will "override the disable" on the port if it finds a mouse there. It is not a valid test to disconnect a working serial mouse on a powered-up Windows computer, connect the security key in its place, and start HYSYS. Windows will still be holding the port for exclusive use by the mouse, so HYSYS will not find the key in this situation. To test the key on a serial port which normally services a serial mouse, restart the computer with the key in place of the
2-7
2-8
mouse. Use keyboard commands to initiate HYSYS (Ctrl-Esc opens the "Start" menu, then use the arrow keys to manoeuvre through the menus, and Enter to select the software). As portable computers become more prevalent, a recurring problem reported to AEA Technology Technical Support involves the infrared (IR) communications port common to many portables. Most portables can have either the single serial port OR the IR port enabled, but not both. Check the CMOS setup or the manufacturer's configuration utility to confirm that the serial port is enabled and the IR port disabled. 5. Very rarely, the key and the serial port are proven to be working properly, but HYSYS is still unable to find the key. In this instance, try starting the software with a command line option that tells it on which COM port the key is located. Open Windows Explorer and navigate to the HYSYS directory. Right-click on HYSYS.EXE and select "Create Shortcut" from the menu. Once the shortcut has been created, right-click on it and select "Properties" from the menu. Go to the "Shortcut" page and modify the "Target:" to the format:
"C:\Program Files\AEA Technology\HYSYS\HYSYS.EXE" -c2
The path may be different on your computer. Note the location of the double-quotes required because of the space in "Program Files". Use -c1 for COM1, etc. Initiate HYSYS by double-clicking on the shortcut. The main HYSYS item in the Windows Start Menu is also a shortcut, located in the Windows directory. This shortcut can be modified instead, if desired. 6. If all else fails, the addition of a very inexpensive serial expander card may be the solution to the problem (for desktop computers, of course). This has solved several unexplained problems in accessing what appear to be perfectly functional on-board serial ports.
2-8
Installing HYSYS
2-9
2.4
The Network Key Version of HYSYS
Except for the fact that it searches for a security key on the network, rather than on a serial port of the local computer, the network key version of HYSYS is identical to the standalone key version. Because of the added complexity involved in setting up the central resource that manages the multi-user network key, it is recommended that the setup of the network key version of HYSYS be undertaken by your organization's IT personnel.
The network version of HYSYS uses a BEIGE Rainbow Technologies Inc. NetSentinel-C security key to allow centralized management of licenses required to run the application. The key is attached to the parallel port of a computer on the network (the "keyserver" computer). Keyserver software is run on that computer to manage requests from HYSYS users on the network for access to licenses on the key. If you are using a GREEN AEA Technology hardware security key refer to Section 2.3 - The Standalone Key Version of HYSYS. On program startup, the network key version of HYSYS inquires from the keyserver computer over the network if a license is available. If a license is available, it is allocated to that user, and the number of available licenses on the key is decreased by one.
2.4.1
Quick Start - Using the Network Key in Local Mode
A useful feature with the network key version of HYSYS is the ability to use the network key as a "standalone" (single-user) HYSYS key. That is, the key can be used to enable the operation of HYSYS on a single computer. No network connection or keyserver software is required. On Windows 2000/NT computers, it is necessary to install the NetSentinel System Driver Software - see Section - Install the NetSentinel System Driver Software for more information. Once the network key is attached to the parallel port of the computer, start the network key version of HYSYS with the command line option "-local" to enable local mode. To do this perform the following steps.
2-9
2-10
1. 2. 3. 4.
Open the Windows Explorer and navigate to the HYSYS directory. Right-click on HYSYS.EXE and select Create Shortcut from the menu. Once the shortcut has been created, right-click on it and select Properties from the menu. Go to the Shortcut page and modify the Target to the format:
C:\Program Files\AEA Technology\HYSYS\HYSYS.EXE" -local The path may be different on your computer. Note the locations of the double-quotes required because of the space between Program and Files. If there are no spaces in the path name quotes are not required. Initiate HYSYS in local mode by double-clicking on the shortcut. The main HYSYS item in the Windows Start Menu is also a shortcut, located in the Windows directory. This shortcut can be modified instead, if desired.
2.4.2
Setting Up the Network Key for Normal Operation
The following discussion assumes the use of a Windows 2000/NT/98/ 95 computer as the keyserver computer (the computer with the network key attached to it). For other operating systems, please consult the Rainbow Technologies website at http://www.rainbow.com. Because the keyserver computer must be operational for HYSYS users to run their software, the best choice for the keyserver computer is a one that is left on continually. The most trouble-free installation will result from a keyserver computer used only for the keyserver function. This avoids conflicts with other software. Note that the keyserver computer does not need to be a powerful or fast computer. The powerful personal computer of a HYSYS user is one of the poorer choices for the keyserver computer. This computer can be switched off behind locked doors for the weekend, rebooted after lockup in another software program (terminating HYSYS users), or require reconfiguration to suit the needs of a new software program, causing difficulties for existing programs (like the keyserver software).
2-10
Installing HYSYS
2-11
Install the Key on the Key Server Computer

To avoid damage to the computer or key, the computer should be powered down before installation of the network key. Install the key on the parallel port (printer port) of the computer that will be performing the keyserver function. The key has an arrow on it, indicating which end should be plugged into the computer. It is possible to cascade two or more Rainbow NetSentinel-C keys on the same port if those two keys have different family codes. The family code is an identifier burned into the key by the manufacturer. A utility program from Rainbow Technologies for interrogating a NetSentinel-C key for the family code is available from AEA Technology Technical Support (support@software.aeat.com).
Install the NetSentinel System Driver Software

The Rainbow NetSentinel System Driver software is required only on computers that have the network key attached. This will generally be only the keyserver computer, but could include computers on which HYSYS is run in "local" mode (see Section 2.4.1 - Quick Start - Using the Network Key in Local Mode). The System Driver software enables communication with the key, either by the keyserver software or by HYSYS itself, when run in "local" mode. Windows 2000/NT computers require the System Driver software. On Windows 98/95, the System Driver software may or may not be required. Try operation without the System Driver software, but if the keyserver software or HYSYS in local mode is unable to find the key, load the System Driver software as the first diagnostic step. To install the System Driver software on Windows 2000/NT, run SETUPX86.EXE located in the \NETDISK\DRIVERS\WIN_NT subdirectory of the HYSYS software CD. To install the System Driver software on Windows 98/95, run SSNTW9X.EXE located in the \NETDISK\DRIVERS\WIN_9X subdirectory of the HYSYS software CD.
2-11
2-12
Install and Run the NetSentinel Keyserver Software

There are two choices of keyserver software that can be run on the keyserver computer. Do not run both of them. The following table describes the capabilities of each.
KeyServer Software Configuration Can be run on Windows 2000/NT/98/95. NSRVGX.EXE Concurrently supposts TCP/IP, IPX/SPX, NetBIOS and NetBEUI as network protocals. Provides an interface screen indicating usage of licenses Can be run on Windows 2000/NT. Concurrently supposts TCP/IP, IPX/SPX, NetBIOS and NetBEUI as network protocals. NSSRVICE.EXE Because it runs as a service, it does not require a network logon of the computer. Does NOT provide an interface screen indicating usage of licenses.
To Install NSRVGX.EXE
1. Copy NSRVGX.EXE from the \NETDISK\SERVERS\WIN32 subdirectory of the HYSYS software CD to a location on the hard disk of the keyserver computer.
Known problems with NSRVGX.

The directory path to NSRVGX cannot contain spaces, or the application will fail to start, displaying ERROR: Extra command line parameter ignored.... On Windows 98/95 computers, the screen-saver must be disabled to prevent a conflict resulting in extremely slow performance by the keyserver software
2.
Execute NSRVGX.EXE. The following table lists all available command line options. NSRVGX.EXE displays a copyright message as it loads. The program will load minimized. To view connection information, maximize the server. To unload NSRVGX.EXE, close the program.
3.
2-12
Installing HYSYS
2-13
NSRVGX.EXE Command Line Options

Option Description Overrides the default "Find_Server" UDP broadcast mask to limit the search over TCP/IP to within a specified subnet mask. (The default is set at 255.255.255.255.) Changes the server's department name from NETINEL to <name>. Sets the maximum number of licenses that can be in use at any one time on this server to <nnn>. The default is 150. /H:<nnn> Your effective license limit is the smaller of (1) the number you set here and (2) the sum of the limits of the keys connected to this server. Specifying a limit higher than what the attached keys support has no effect. Specifying a limit lower than what the attached keys support effectively disables some licenses. Sets the maximum number of servers running this server's department name and using this server's protocol to <nnn>. The indicated value ranges from 1 to 5, and is used to determine the range of server names. A value of 5, for example, causes servers to be named NETINEL0 through NETINEL4. Sets the name displayed by the monitor for this server to <name>. The default is your computer's Ethernet address (NetBIOS) or IPX node number (NetWare). Suppresses the copyright message when the server is being loaded. Defines the number of retry operations when searching for servers running over TCP/IP. The default is 3. Sets the number of threads devoted to handling TCP/IP clients to <nnnn>. Values range from 0 to 4; the default is 4. Specifying /SI:0 disables all TCP/IP support. Defines the number of entries in the sub-license table. Applies to the NetSentinel-C only. Sets the number of threads devoted to handling NetBIOS/NetBEUI clients to <nnnn>. Values range from 0 to 4; the default is 4. Specifying /SN:0 disables all NetBIOS/NetBEUI support. Enables strict license time-out enforcement. If this option is set, active licenses are immediately revoked and made available for reuse if no query is performed within the key's configured time-out interval. Subsequent use of the handle yields an error. By default, a timed-out license is revoked only if a handle is requested and no other licenses are available.
/BI:<mask>
/DN:<name>
/MS:<nnn>
/N:<name>
/Q /RI:<num>
/SI:<nnnn>
/SL:<nnnn>
/SN:<nnnn>
/ST
2-13
2-14
Option
Description Sets the number of threads devoted to handling IPX/ SPX (NWLINK) clients to <nnnn>. Values range from 0 to 4; the default is 4. Specifying /SW:0 disables all IPX/SPX (NWLINK) support. Sets a password of up to 12 characters. If the server is set with a password option, that password will be required by the monitor, whenever licenses are being deleted. If the server is not set to require a password, the server will delete all licenses from the monitor without requiring a password. Sets the timeout value in seconds for each retry operation when searching for servers running over TCP/IP. The default is 5.
/SW<nnnn>
/W:<password>
/TI:<num>
To Install NSSRVICE.EXE
1. Copy NSSRVICE.EXE from the directory \NETDISK\SERVERS\WIN32 to the Windows NT\System32 directory. To install the service, run the NSSRVICE.EXE executable with "/i" command line option, i.e. NSSRVICE /i. After installation, a registry entry for the NetSentinel service is created under: KEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services 4. By default, the service is configured to run automatically the next time the system is restarted. No user logon is required, unless desired. Configuration can be made via Control Panel -> Services-> NetSentinel.
2.
3.
Service Event Logging

Status information pertaining to this service is reported to the application log. Upon successful startup of the service, information such as server version, protocol stacks, and available keys is logged as two separate events in the application log. Access Event Viewer in the Administrator Tools group to view this information.
2-14
Installing HYSYS
2-15
NSSRVICE.EXE Command Line Options

(used when installing the service in addition to /i).
Option Description Overrides the default "Find_Server" UDP broadcast mask to limit the search over TCP/IP to within a specified subnet mask. (The default is set at 255.255.255.255). Changes the server's department name from NETINEL to <name>. Sets the maximum number of licenses that can be in use at any one time on this server to <nnn>. The default is 150. /H:<nnn> Your effective license limit is the smaller of (1) the number you set here and (2) the sum of the limits of the keys connected to this server. Specifying a limit higher than what the attached keys support has no effect. Specifying a limit lower than what the attached keys support effectively disables some licenses. Sets the maximum number of servers running in this server's department name and using this server's protocol to <nnn>. The indicated value ranges from 1 to 5, and is used to determine the range of server names. A value of 5, for example, causes servers to be named NETINEL0 through NETINEL4. Sets the name displayed by the monitor for this server to <name>. The default is your computer's Ethernet address (NetBIOS) or IPX node number (NetWare). Defines the number of retry operations when searching for servers running over TCP/IP. The default is 3. Sets the number of threads devoted to handling TCP/IP clients to <nnnn>. Values range from 0 to 4; the default is 4. Specifying /SI:0 disables all TCP/IP support. Defines the number of entries in the sub-license table. Applies to the NetSentinel-C only. Sets the number of threads devoted to handling NetBIOS/NetBEUI clients to <nnnn>. Values range from 0 to 4; the default is 4. Specifying /SN:0 disables all NetBIOS/NetBEUI support. Enables strict license time-out enforcement. If this option is set, active licenses are immediately revoked and made available for reuse if no query is performed within the key's configured time-out interval. Subsequent use of the handle yields an error. By default, a timed-out license is revoked only if a handle is requested and no other licenses are available.
/BI:<mask>
/DN:<name>
/MS:<nnn>
/N:<name>
/RI:<num>
/SI:<nnnn>
/SL:<nnnn>
/SN:<nnnn>
/ST
2-15
2-16
Option
Description Sets the number of threads devoted to handling IPX/ SPX (NWLINK) clients to <nnnn>. Values range from 0 to 4; the default is 4. Specifying /SW:0 disables all IPX/SPX (NWLINK) support. Lets a password of up to 12 characters. If the server is set with a password option, that password will be required by the monitor, whenever licenses are being deleted. If the server is not set to require a password, the server will delete all licenses from the monitor without requiring a password. Sets the timeout value in seconds for each retry operation when searching for servers running over TCP/IP. The default is 5. Installs the service. Uninstalls the service. Displays the version number
/SW:<nnnn>
/W:<password>
/TI:<num> S/I /U /V
2.4.3
HYSYS Installation to a Network Server
The following discussion is optional and applies to both the standalone key and network key versions of HYSYS.
If HYSYS is to be run on a relatively large number of computers, it may be advantageous to install the software on a network server rather than on individual computer hard disks. The disadvantage of installing the software on a network server is that HYSYS startup will be slower as the program is loaded over the network from the hard disk of the server into the memory on the local computer. Installing HYSYS onto a server follows exactly the same process as outlined in the previous section. Simply choose the network drive instead of the local drive when on the Select Components screen. To prevent accidental modification or deletion of files, it is recommended that HYSYS users be allowed read-only access to the software. Each HYSYS user should then configure an individual preferences file as follows and store that file on their local hard disk (or write-enabled network drive).
Except for the fact that it searches for a security key on the network, rather than on a serial port of the local computer, the network key version of HYSYS is identical to the standalone key version.
2-16
Installing HYSYS
2-17
To run HYSYS on users computers, 1. 2. Create a shortcut to HYSYS.EXE (on the desktop or in the Start menu). Set the Start In directory to a directory on the local hard disk (e.g. C:\AEA Technology\HYSYS). On startup, HYSYS will search this directory for the user's preferences file (HYSYS.PRF). In this directory, create the subdirectories CASES, PAKS and USER. Start HYSYS and, from the menu bar, select Tools, then Preferences. Go to the Files tab of the Session Preferences view and select Locations. Configure the Default Files and Paths as is shown in the accompanying Figure 2.4. These are suggestions only and some modification may be required depending on the circumstances.
Figure 2.4
3. 4. 5. 6.
7.
Select the Save Preference Set button, and direct the file save operation to the HYSYS working directory on the local disk.
2-17
2-18
2.4.4
Potential Problems Running the Network Key Version of HYSYS
While using TCP/IP as the network communications protocol, HYSYS.Network is unable to connect to the network security key.
Unless directed to do otherwise, HYSYS generates a general broadcast message on startup, in search of the keyserver computer. Depending on the IP address of client and keyserver computer, broadcast mask in use and router configuration on the network, this general broadcast message may not be received at the keyserver computer. To resolve this problem, HYSYS can be configured to send a directed message to the IP address of the keyserver. To do this, create a text file called HYSYS.INI in the main HYSYS directory (e.g. C:\Program Files\AEA Technology\HYSYS) containing the following two lines (making the appropriate IP address substitution). [RainbowKey] BroadcastAddress=192.139.200.134 Note the square brackets on the first line and the lack of any spaces on the second line. This fix will not impact on WINMON's (the monitor tool installed with the network key version of HYSYS) failure to communicate with a network keyserver.
While using IPX/SPX as the network communications protocol, HYSYS.Network is unable to connect to the network security key.
Check to see if routers between the client and keyserver computer are filtering SAP broadcast messages with an ID of 0361.
There is a suspicion that other operating copies of the keyserver software on the network are interfering with the ability of HYSYS.Network to connect to its network key.
Unless directed to do otherwise via a command line option, the keyserver software initiates with the default "department name" of NETINEL.
2-18
Installing HYSYS
2-19
It is necessary for each keyserver to have a unique identifier. To ensure this, the keyserver software broadcasts a message on startup requesting that like-department-named keyservers respond. If no other keyservers respond, an initiating copy of the keyserver software using the default "NETINEL" department name would take the unique name NETINEL0. If a previously operating NETINEL0 had responded to the broadcast message generated by this copy of the keyserver software on startup, this second keyserver would have taken the name NETINEL1. There can be a maximum of five keyservers with the same department name visible to each other on the network (the defaults would be NETINEL0 - NETINEL4). Unless directed to do otherwise, when HYSYS initiates, it begins its search for its network key by interrogating NETINEL0, followed by NETINEL1 and so on up to NETINEL4. The network key technology used by HYSYS is used by other non-AEA Technology software. It is possible that another "NETINEL" named keyserver cannot be added to the network for use with the HYSYS key because there are already five operating keyservers. It is also possible (although unlikely) that some configuration issue on the network allows, for example, a NETINEL0 keyserver to be initiated servicing the HYSYS key while at the same time there is a pre-existing NETINEL0 keyserver servicing another key on the network. To move away from the default "NETINEL" department name for HYSYS.Network, modifications must be made to the keyserver software, the monitor software (WINMON.EXE) and to HYSYS itself. Use the command line option "/dn:" to specify a non-default department name for the keyserver software on startup. The easiest way to reconfigure WINMON.EXE to search for non-default department-named keyservers is to directly edit the configuration file MAPFILE.TXT. To direct HYSYS to search for non-default named keyservers, create a text file called HYSYS.INI in the main HYSYS directory (e.g. C:\Program Files\AEA Technology\HYSYS) containing the following two lines (making the appropriate substitution for the work "HYSYS", if desired). [RainbowKey] DepartmentName=HYSYS
2-19
2-20
Note the square brackets on the first line and the lack of any spaces on the second line. Multiple entries can be make in the [RainbowKey] section of the HYSYS.INI file, as follows. [RainbowKey] DepartmentName=HYSYS BroadcastAddress=192.139.200.134
HYSYS displays the message "Error X: No more users are allowed on this Network Security key or there are no valid operating AEA Technology network Security Keys. Use one of the supplied Rainbow Technologies key monitoring programs for further information. (Error sub-code -10)"
Other software also uses the third-party network keys used with HYSYS. Every AEA Technology NetSentinel-C key has an Algorithm ID of 498D (one of the parameters displayed in the WINMON interface). When HYSYS started up and searched on the network for operating copies of the keyserver software, it found one of two possible things. 1. It didn't find any copies of the keyserver software that were servicing 498D keys, but it did find one or more that were servicing non-498D keys. It did find a 498D key, but all of the licenses on the key were in use.
2.
HYSYS displays the message "Error X: Cannot find a Security Key Server on the network. No operating copies of the necessary Security Key Software can be found. (Error sub-code -12)
When HYSYS started up, it looked for operating copies of the appropriately department-named keyserver software on the network, but didn't find any. Running WINMON.EXE at this point, on the same computer, should yield the same results, assuming that HYSYS and WINMON are configured to search for keyservers of the same department name. Check the first two items in this trouble-shooting section for reasons as to why this may be happening.
2-20
Installing HYSYS
2-21
HYSYS displays the message "Error X: A AEA Technology network Security Key was found that has an Invalid Serial Number. No more licenses were available on other valid AEA Technology network Security Keys. Use one of the supplied Rainbow Technologies key monitoring programs for further information. (Error sub-code -14)"
HYSYS found a 498D (AEA Technology) key, gained a license on it, interrogated the key to ensure that the key was coded for operation with this software, discovered that was not the case, released the license on that key, went looking for another, and didn't find one.
HYSYS displays the message "Error X: Invalid Network Protocol selection for connection to the network Security Key. (Error sub-code -19)"
If operating HYSYS in "local" mode, ensure that the "NetSentinel System Driver Software" has been installed. If operating in normal network mode, this error message indicates that HYSYS is unable access the network protocols on the computer.
2-21
2-22
2-22
Get Started
3-1
3 Get Started
The Get Started section gives a quick introduction to HYSYS by recalling a saved case and illustrating how to manoeuvre around HYSYS.
3.1 Starting HYSYS

To start HYSYS: 1. 2. 3.
HYSYS Icon
Select the Start menu. Move from Programs to AEA Technology to HYSYS. Select Hysys.
Now you are ready to begin working with HYSYS. Get Started! After you start HYSYS, the HYSYS Desktop will appear:
Figure 3.1
Maximize Button
3-1
3-2
Starting HYSYS
Note that this view has been resized; your Desktop view should appear larger than this when initially opened. To re-size the view, click and drag the outside border. To make the view full size, press the Maximize button in the upper right hand corner. Before opening the pre-built Get Started case, you should choose the HYSYS unit set used for displaying information. You can check your current unit set by accessing the Session Preferences: 1. Select Preferences from the HYSYS Tools menu, and the Session Preferences view will open.
Figure 3.2
2.
Move to the Units page of the Variables tab. The Current Unit Set is shown highlighted in the list of Available Unit Sets. The HYSYS default is SI; however the Get Started example has been developed in Field units.
Figure 3.3
The default unit set is SI.
Click on the Variables tab to access the Units page.
3-2
Get Started
3-3
3.
Click on Field to make it the Current Unit Set.

Figure 3.4
Click on Field to make it the current unit set.
Close button.
4.
Press the Close button to close the Session Preferences view.
Recalling the Simulation Case from Memory

Included with your HYSYS package are a number of pre-built simulation cases, located in the SAMPLES subdirectory of the HYSYS root directory. One of these cases is named gstart-ss.hsc and is the example used for this Get Started example. To load the case: 1. Do one of the following:
Open Case Button
Select the Open Case button on the button bar. Select Open then Case from the File menu. Press CTRL O.
3-3
3-4
Starting HYSYS
The Open Simulation Case dialog will appear.

Figure 3.5
2. 3.
Open the Samples subdirectory and scroll through the list of files until gstrt-ss.hsc is visible. Click on gstrt-ss.hsc, the press the Open button. The pre-built simulation case will appear on your Desktop.
Figure 3.6
3-4
Get Started
3-5
Saving the Case Under a New Name

Before working with this case, you should save it using a new name to ensure that the original file remains intact. 1. Do one of the following:
Select Save As from the File menu. Press CTRL SHIFT S

The Save Simulation Case As dialog box will become visible. 2. Type a new name, for example MYCASE, in the File name cell. Note that you do not have to enter the .HSC extension; HYSYS will add it automatically.
Figure 3.7
3.
Press the Save button, and HYSYS will save your case with the new name.
3.2
Steady State Case
The Steady State - Dynamic toggle in the button bar indicates that you are currently in Steady State.
This Steady State simulation models the production of propylene glycol. Using a continuously-stirred-tank reactor (CSTR), propylene oxide and water are reacted at atmospheric pressure. The reaction is exothermic, so a coolant is circulated to the reactor to maintain its temperature. The reactor effluent, consisting of propylene glycol and unreacted feed, is fed to a distillation column. In the column, 99.5 mol% glycol is produced from the bottoms, while unreacted propylene oxide and water are recovered overhead. Three windows, or views, are currently displayed on the HYSYS Desktop. Each view is identified by its title at the top of the view. The
3-5
3-6
Steady State Case
current active view is the PFD, which is a graphical representation of the process flowsheet. The PFD shows:
The streams and unit operations, represented by symbols (called icons), in the flowsheet. The connectivity amongst the streams and unit operations. A property tables for the Reactor Prods stream
If you wish, you can re-size the PFD view to make it more readable.
Figure 3.8
Unit operation icon for a CSTR reactor.
Maximize button
Zoom All button
Properties table for Reactor Prods
1.
Do one of the following:
Click and drag the outside order to the new size. Press the Maximize button in the upper right corner of the view.
2. Press the Zoom All button to zoom in on all items in the PFD, filling the resized view.
Stream Fly-By
You can display summary information for a particular object (stream or operation) simply by placing the cursor over the objects icon. For example, position the cursor over the icon for stream Prop Oxide. A flyby view will appear at the cursor tip, showing the stream temperature, pressure and molar flow.
3-6
Get Started
3-7
Accessing Stream Information from the PFD

Every stream and operation (object) contained in a HYSYS simulation has its own Property View, which contains multiple tabs and related pages of information or properties describing the object. You can access the Property View for a stream directly from the PFD by simply double-clicking on the stream icon.
Prop Oxide Icon
For example, open the property view for one of the streams entering the reactor. Double-click on Prop Oxide icon on the PFD. The property view for Prop Oxide is shown in Figure 3.9:
Figure 3.9
When an objects property view is initially opened, it displays the first page on the first tab of the view. For the Material Stream property view, the first tab is the Worksheet tab; its first page is the Conditions page. Tabs are listed along the bottom of an objects view. Each tab has associated pages that are listed in the column on the left-hand side of the view, under the tab name. Change the page or tab by selecting the object with the cursor. The Conditions page of the Worksheet tab gives the basic conditions of the stream: the vapour fraction, temperature, pressure, material flows and heat flow (enthalpy). Move to the Composition page by selecting Composition in the lefthand column of the view. This page displays the material composition of the stream. In this case, five components are displayed along with the liquid volume flow for each component. You can display the
3-7
3-8
Steady State Case
composition on another basis, such as mass or molar fraction, by pressing the Basis button.
Figure 3.10
The remaining property view tabs and their associated pages are:
Attachments Tab
Unit Ops Page - Lists the unit operation(s) to which the stream is attached. Utilities Page - Allows you to create and attach utilities to the stream.
Dynamics Tab
Specs Page - Applicable only in Dynamic mode. You activate dynamic specifications on this page.
User Variables Tab

Lets you write and attach code as a User Variable to extend the functionality of your stream.
Once you have finished examining the stream properties, close the view using the Close button in the upper right hand corner of the view. The next time you open the property view, it will open to the last page that you accessed before closing the view.
Close Button
3-8
Get Started
3-9
Using the Workbook to Change a Stream Temperature

Select the Workbook button from the HYSYS button bar to change the current view to the Workbook.
Workbook Button Figure 3.11
Lists the unit operations to which the stream is attached.
Vertical scroll arrow.
The Workbook view displays tabular information pertaining to the streams and unit operations in the simulation. You can also add, delete or modify streams and unit operations in the Workbook. The first tab of the Workbook, Material Streams, displays for each stream the same information that is available on the Conditions page of the stream property view. You can view the streams that are not currently visible by re-sizing the view, or by clicking repeatedly on the vertical scroll arrow. The remaining Workbook tabs include:
Compositions - displays the composition of each material stream. Energy Streams - displays the name and heat flow of each energy stream. Unit Ops - lists summary information for all unit operations.
Suppose you want to investigate the amount of cooling required to maintain the reactor at certain temperatures. The reactor is currently operating at 135oF, which is the temperature of the product Reactor Prods.
3-9
3-10
Steady State Case
Figure 3.12
The temperature of Reactor Prods is currently 135 oF.
To see the cooling requirement to achieve this temperature, move to the Energy Streams tab in the Workbook.
Figure 3.13
The reactor cooling requirement is represented by the Heat Flow of the stream Coolant. Click here to move to the Energy Streams tab of the Workbook.
The cooling duty required to maintain the specified reactor temperature is 4.8 MMBtu/hr, the Heat Flow of the energy stream Coolant. Check the cooling requirement for outlet temperatures of 100oF. The reactor temperature is set by the specification on the outlet stream Reactor Prods.
3-10
Get Started
3-11
To specify the new separator temperature: 1. 2. 3. Return to the Material Streams tab in the Workbook by clicking on its tab. Select the temperature cell for the Reactor Prods stream. Type 100, the press ENTER. HYSYS will automatically re-calculate the Flowsheet based on the new temperature.
Figure 3.14 Workbook values shown in blue are user-specified. Values in black are calculated by HYSYS.
Enter 100 in the Temperature cell for Reactor Prods.
4.
Return to the Energy Streams tab to see the re-calculated cooling requirement.
Figure 3.15
The temperature change has decreased the required cooling duty to 4.4 MMBTU/hr. Suppose you want to examine the cooling duty at a number of other
3-11
3-12
Steady State Case
You might expect the cooling requirement to increase as the reactor temperature is lowered. However, the reaction has two attributes that dominate the reactors heat balance: 1. The reaction produces heat proportional to the amount of reaction occurring. Less reaction occurs at 100oF than at 135oF.
temperatures. Instead of repeating the above procedure for each new temperature, the HYSYS Case Study feature will automatically make changes and tabulate the results for you.
Using the Case Study

The third view open on your Desktop is the Case Studies view. To access this view, 1. Select Window on the HYSYS menu bar to open the available menu. The three views that are currently open on the DeskTop are listed at the bottom of the menu. A check mark indicates the view that currently has focus. In this case, it is the Workbook view.
Figure 3.16
2.
So by lowering the reactor temperature, less reaction is taking place and less heat is produced by the reaction. Therefore, less cooling is required.
3-12
Get Started
3-13
2.
Select Case Studies - Main from the menu to make it the active view. The case studies view is shown in Figure 3.17:
Figure 3.17
The Case Studies view shows a plot of the separator cooling duty and the Glycol stream molar flow rate (dependent variables) versus the separator temperature (independent variable). Case Study 1 has been configured to calculate and plot values over an independent Temperature range of 75oF to 130oF with an increment of 10oF. You may actually want to observe the results over a wider range. To change the bounds of the independent variable for the case study, select the Setup button at the bottom of the view. The Case Studies Setup view will open:
3-13
3-14
Steady State Case
Figure 3.18
Leave the Low Bound as its value of 75 oF, and the Step Size as 10oF. Change the High Bound value to 215 oF. Press the Start button then the Results button on the Case Studies Setup view. HYSYS will begin calculations immediately, solving the Flowsheet at each temperature and plotting the results on the Case Studies view. When the Flowsheet has been solved at the final temperature of 215oF, calculations will stop automatically. The final Case Studies view is shown following.
Figure 3.19
3-14
Get Started
3-15
The Case Study shows that the cooling requirement increases to its maximum value at approximately 125 oF and then decreases, while the glycol production rate increases over the entire temperature range. You have now completed your first HYSYS simulation! You can save your case by doing one of the following:
Save Button
Press the Save button on the HYSYS button bar. Select Save from the File menu. Press CTRL S.
You are now free to explore this case on your own. If you wish, you can quit HYSYS by doing one of the following:
Select the Exit from the File menu. Press ALT F4 Select the Close button in the right hand corner of the HYSYS window.
If you have made any changes to your case since the last time it was saved, HYSYS will prompt you to save before exiting. This concludes the Get Started case. If you would like more help getting to know HYSYS, you are encouraged to proceed to the HYSYS Tutorials manual for a more in-depth look at building simulation cases.
Note that HYSYS.Process will not run the Dynamics Case. In order to continue with section 3.3, you must be running HYSYS.Plant.
3.3
Dynamics Case
A dynamic simulation case that models the CSTR reactor from the Steady State section of Get Started, with the addition of a reactor control scheme, is presented in this section. To open the case, 1.
Open Case Button
Do one of the following:
Press the Open Case button on the button bar. Select Open then Case from the File menu. Press CTRL O.
The Open Simulation Case dialog box will appear. 2. Open the Samples directory. Scroll through the list of files until gstrt-dy.hsc is visible.
3-15
3-16
Dynamics Case
If the PFD is not open, you can open it by pressing the PFD button in the button bar.
3.
Click on gstrt-dy.hsc, the press Open. The pre-built simulation case will appear on the Desktop.
Figure 3.20
Face plates
Integrator
PFD Button
Controller
As with the Steady State case, you should save this case under a new name before making any changes. 1. Do one of the following:
Select Save As from the File menu. Press CTRL SHIFT S

The Save Simulation Case As dialog box will appear. 2. Type a new name, for example MYCASE2, in the File Name cell. Note again that you do not have to enter the .HSC extension; HYSYS will add it automatically. Press the Save button and HYSYS will save the simulation case under its new name.
3.
3-16
Get Started
3-17
This case is a dynamic model of the propylene glycol reactor from the Steady State portion of Get Started. The PFD shows the control scheme for the reactor, which includes the following three controllers.
Controller Reactor LC Reactor TC Glycol Conc Action Controls the liquid level in the reactor by manipulating the reactor outlet flow. Maintains the reactor temperature by manipulating the coolant flow. Controls the concentration of propylene glycol in the reactor outlet stream by manipulating the flow of the propylene oxide feed.
The face plates for these three controllers are open along the top of the Desktop. The face plates components are listed in the following table;
Face Plate Field Description The PV cell shows the current value of the Process Variable, or controlled variable. For example, the PV for the Reactor LC is the percent liquid level in the reactor. The current Set Point for the Process Variable is indicated by the red pointer on the top of the PV cell. The OP cell displays the current value of the controller Output as a percentage. Provides a drop-down list of the available controller modes. Currently, two of the controllers are in Automatic mode and the third is in Manual mode.
PV Cell
OP Cell Controller Mode Drop-Down
3-17
3-18
Dynamics Case
The face plate for the Reactor LC (level controller) is shown in Figure 3.21:
Figure 3.21
Set Point indicator OP cell
PV cell Drop-down for controller modes.
You can also start and stop dynamic calculations using the Integrator toggle buttons in the button bar.
In addition to the PFD and controllers, two other views appear on the DeskTop. They are:
The green button (left) starts the integrator. The red button stops it.
The Integrator, which lets you to start and stop dynamic calculations. The Reactor Key Variables view that is currently behind the PFD. To display this view, click on its title bar. The view is a customized HYSYS Strip Chart, on which the values of selected key variables will be plotted during dynamic calculations.
In Dynamic mode, HYSYS performs flowsheet calculations with each time stop. HYSYS determines an appropriate length for each time step based on the Minimum and Maximum Step Sizes in the Integrator, plus the rate of change in data from the previous time step. Currently, the Step Size is 5 seconds, so initially HYSYS will perform Flowsheet calculations for every 5 seconds of real plant time. In this example, the CSTR reactor will be set up from an empty condition using the following procedure: 1. Fill the vessel with water until the level set point is reached, at which time the Reactor LC controller will open the outlet control valve to maintain the level. Slowly introduce propylene oxide into the reactor while observing:
2.
The Reactor TC controller maintaining the reactor temperature The concentration of propylene glycol in the product stream
3. Switch the Glycol Conc controller to automatic mode to maintain the product concentration at a specified set point.
Starting Dynamic Calculations

Ensure that the Reactor Key Variables view is visible by clicking on its title bar. To begin, press the Start button on the Integrator. The reactor will begin to fill and the values of the process variables will immediately be displayed on the controllers and plotted on the strip chart. When the
3-18
Get Started
3-19
Current Time reaches about 55 minutes, press the Stop button.

Figure 3.22
To check the current level set point, place the cursor over the Set Point Indicator. When the cursor changes to a double-headed arrow, click and hold the primary mouse button. The Current Time displays the real plant time.
The rising vessel level is plotted on the Strip Chart and displayed in the PV cell of the Reactor LC controller
Coolant rate Product temperature
Notice that the reactor level rises linearly as the vessel fills to its set point of 85%.
If you want to reset dynamic calculations, press the Reset button on the Integrator. Then press the Start button to restart the calculations from zero. HYSYS will ask for confirmation before resetting the values.
Press the Continue button on the Integrator . As the reactor level approaches its set point, the Reactor LC controller will open the outlet valve to maintain the level. When the current time reaches approximately 125 minutes, press Stop.
3-19
3-20
Dynamics Case
Figure 3.23
Currently the outlet valve is about 26.5 % open. Reactor level.
Reactor product volume flow is initialized after the reactor reaches its set
Reactor temperature.
Adding a Process Disturbance

Press the Continue button of the Integrator. When the reactor level and product volume flows reach a steady state value, at about 200 minutes, press Stop. To add the disturbance, introduce some propylene oxide into the reactor by doing the following: 1. 2. 3. 4. 5. Double click on the OP cell on the Glycol Conc controller face plate. Type 25, then press ENTER. The control valve for the propylene oxide feed will open 25%. Note the Current Time displayed on the Integrator. Start the Integrator again. After the Current Time has increased by about 70 minutes stop the Integrator.
3-20
Get Started
3-21
As a result of the disturbance,
The reactor temperature increases due to the exothermic reaction. The reactor coolant will increase in flow to maintain the reactor temperature at 110 oF. The outlet flow increases to maintain the reactor level because of the increased feed. The propylene glycol begins to appear in the product stream.
Figure 3.24
Increase in cooling requirement due to the reaction.
Increase in reactor outlet flow.
Propylene glycol concentration at 3.7%.
If you wish, start the Integrator again and try entering other values for the OP , such as 40 or 50%, and watch the response. The next step is to switch the composition controller Glycol Conc to automatic mode and let it maintain a concentration set point. Use a set point of 0.25 mole fraction propylene glycol. Before changing the set point, stop the Integrator again. To change the set point follow the procedure outlined in Figure 3.25:
3-21
3-22
Dynamics Case
Figure 3.25
Open the drop-down list of controller modes by clicking on this arrow.
Click on Auto in the drop-down list to change the controller mode.
Place the cursor over the set point indicators, and the cursor will change to this double-headed arrow.
Alternatively, you can enter an exact set point by typing the value in the PV cell, then pressing the ENTER key.
With the double-headed arrow visible, press and hold the primary mouse button. This box will appear, displaying the current set point value.
Click and drag to slide the set point to the right. The set point value will change as you drag. Release the primary mouse button when you reach the new set point.
After you have entered the new set point, start the Integrator again. The system will react to the new set point as follows:
If you wish at any time to reset dynamic calculations and begin filling the vessel again: 1. 2. Press the Reset button. Return the Glycol Conc controller to Manual mode. Enter a value of 0 in the OP cell of the Glycol Conc controller. 4. Press the Start button.
3.
The flow of propylene oxide feed increases because the composition controller wants to raise the concentration of glycol in the product stream. The reactor level rises as a result of the higher feed rate; the product flow therefore increases to maintain the level set point. The reactor temperature rises because more exothermic reaction is taking place, and the coolant flow increases to compensate for this temperature change.
4.
3-22
Get Started
3-23
Figure 3.26
Propylene glycol concentration at 16.3%.
Coolant flow increases to accommodate for the extra heat introduced by the
More propylene glycol starts appearing in the product stream.
Feel free to experiment by changing either of the other set points and watch the response. When you are finished, stop the Integrator. You have now completed your first dynamic simulation using HYSYS! Before moving on, you can save your case by doing one of the following:
Save Button
Press the Save button on the HYSYS button bar. Select Save from the FIle menu. Press CTRL S.
If you wish, you can quit HYSYS by doing one of the following:
Select the Exit from the File menu. Press ALT F4 Select the Close button in the right hand corner of the HYSYS window.
If you have made any changes to your case since the last time it was saved, HYSYS will prompt you to save before exiting.
3-23
3-24
Dynamics Case
This concludes the Get Started example. You are encouraged to proceed to the HYSYS Tutorials manual. The Tutorial problems provide a more in-depth look at HYSYS by guiding you step-by-step through a number of example simulations. Both steady state and dynamic tutorials are available.
3-24

HYSYS GetStart PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

HYSYS GetStart PDF

Uploaded by

Copyright:

Available Formats

Copyright Notice

Contacting AEA Technology - Hyprotech

Installing HYSYS .............................................. 2-1

Get Started ....................................................... 3-1

Hyprotech Software Solutions

Integrated Intuitive and interactive Open and extensible

Integrated Simulation Environment

Hyprotech Software Solutions

model topology interface thermodynamics

Hyprotech Software Solutions

Intuitive and Interactive Process Modelling

Open and Extensible HYSYS Architecture

Use of the Manuals

HYSYS Electronic Documentation

Steady State Modeling

Use of the Manuals

Contact Hyprotech for information on HYSYS training courses.

Viewing the On-Line Documentation

Attaching the On-line CD Index

Use of the Manuals

Conventions used in the Manuals

Keywords for Mouse Actions

Cancel identifies the Cancel button on a particular view.

Example "Select the F1 key."

Bullets and Numbering

Select the Name cell Press ALT N

Press ENTER to accept the name.

Use of the Manuals

General Options Errors Column Options

Shaded Text Boxes

Technical Support Centres

Barcelona, Spain (Rest of Europe)

Oxford, UK (UK clients only)

Kuala Lumpur, Malaysia

The Standalone Key Version of HYSYS

The Standalone Key Version of HYSYS

Connecting the Security Device

HYSYS Installation to a Network Server

The Standalone Key Version of HYSYS

Potential Problems Starting the Standalone Key Version of HYSYS

Security Key Tips for IT Personnel

The Standalone Key Version of HYSYS

The Network Key Version of HYSYS

Quick Start - Using the Network Key in Local Mode

The Network Key Version of HYSYS

Setting Up the Network Key for Normal Operation

Install the Key on the Key Server Computer

Install the NetSentinel System Driver Software

The Network Key Version of HYSYS

Install and Run the NetSentinel Keyserver Software

Known problems with NSRVGX.

NSRVGX.EXE Command Line Options

The Network Key Version of HYSYS

Service Event Logging

NSSRVICE.EXE Command Line Options

The Network Key Version of HYSYS

HYSYS Installation to a Network Server

The Network Key Version of HYSYS

Potential Problems Running the Network Key Version of HYSYS

The Network Key Version of HYSYS

The Network Key Version of HYSYS

3.1 Starting HYSYS

Click on the Variables tab to access the Units page.