RSoft Product Guide OptSim 5.3

7/22/2019 RSoft Product Guide OptSim 5.3

1/26

RSoft Installation Guide

Optical Solutions Group400 Executive Blvd. Ste 100

Ossining, NY 10562 USA

Phone: 914-923-2164E-mail: [email protected]

www.rsoftdesign.com

Revision 120917


2/26

Copyright Notice and Proprietary Information

Copyright 2012 Synopsys, Inc. All rights reserved. This software and documentation contain confidential and proprietary information that is

the property of Synopsys, Inc. The software and documentation are furnished under a license agreement and may be used or copied only inaccordance with the terms of the license agreement. No part of the software and documentation may be reproduced, transmitted, or translated, in

any form or by any means, electronic, mechanical, manual, optical, or otherwise, without prior written permission of Synopsys, Inc., or as

expressly provided by the license agreement.

Right to Copy Documentation

The license agreement with Synopsys permits licensee to make copies of the documentation for its internal use only. Each copy shall include all

copyrights, trademarks, service marks, and proprietary rights notices, if any. Licensee must assign sequential numbers to all copies. These copies

shall contain the following legend on the cover page:

This document is duplicated with the permission of Synopsys,Inc., for the exclusive use of

______________________________ and its employees. This is copy number __________.

Destination Control Statement

All technical data contained in this publication is subject to the export control laws of the United States of America. Disclosure to nationals of

other countries contrary to United States law is prohibited. It is the readers responsibility to determine the applicable re gulations and to complywith them.

Disclaimer

SYNOPSYS, INC., AND ITS LICENSORS MAKE NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS

MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

PARTICULAR PURPOSE.

Trademarks

Synopsys company and certain product names are trademarks of Synopsys, as set forth at:

http://www.synopsys.com/Company/Pages/Trademarks.aspx. All other product or company names may be trademarks of their respective owners.


3/26

RSoft Installation Guide iii

Contents

Preface 1System Requirements..............................................................................1How to Read This Manual........................................................................1Typographical Conventions......................................................................1

1 Windows Installation 31.A. Pre-Install Checklist..........................................................................31.B. Installing the Software.......................................................................41.C. What Next?.......................................................................................51.D. Troubleshooting a Windows Installation............................................6

1.D.1. Setting up the PATH...........................................................61.D.2. Installing the License Key...................................................61.D.3. USB Dongle Drivers...........................................................61.D.4. License Manager (rslmd.exe).............................................61.D.5. MPI for Clustering...............................................................7

2 Linux Installation 92.A. Pre-Install Checklist..........................................................................92.B. Installing the Software.....................................................................102.C. What Next?.....................................................................................122.D. Troubleshooting a Linux Installation................................................12

2.D.1. Configuring the Startup Script...........................................122.D.2. Setting Variables in User Login Scripts.............................132.D.3. Installing in a Different Directory.......................................132.D.4. Missing Shared Libraries..................................................132.D.5. DOS Format *.ind & other text files...................................132.D.6. Environment Variables......................................................13

3 Cluster Installation 15


4/26

RSoft Installation Guide iv

3.A. Pre-Install Checklist........................................................................153.B. Configuring and Testing a Standalone Cluster.................................16

3.B.1. Standalone FullWAVE Clusters.........................................163.B.2. Standalone MOST Clusters..............................................16

3.C. Configuring and Testing a Networked Cluster.................................163.C.1. Ensuring Network Connectivity.........................................163.C.2. Testing a Networked FullWAVE Cluster............................183.C.3. Testing Networked MOST Clusters...................................19

4 Uninstalling 214.A. Uninstalling the Package.................................................................214.B. Uninstalling Older Versions.............................................................22


5/26

RSoft Installation Guide 1

Preface

System RequirementsMost of Synopsys RSoft products have 32-and 64-bit versions for both Windows and Linuxoperation systems. Please check the 'System Requirements' section of the relevant product on

www.rsoftdesign.com for a list of the specific OS versions we currently support.

Note that once a product has been successfully installed, it may not function correctly after

changes such as OS updates or other software/hardware modifications that are made to thecomputer system. In such cases, Synopsys will attempt to resolve any issues for customers that

have a current maintenance contract but does not guarantee success.

How to Read This ManualAll users should follow the installation instructions in eitherChapter 1(Windows) orChapter 2(Linux) to ensure that the software is correctly installed. Users who need to use a clustering

feature should follow the further instructions inChapter 3. Chapter 4provides instructions for

uninstalling the software.

Typographical ConventionsA number of typeface and layout conventions are followed in this manual.

The names of fields and controls in the GUI dialogs are written in boldface

The values of pull-down menus and radio button controls are written in italics.

File names and paths, symbol table variables and values, expressions typed in GUI edit

fields, and code snippets are written in monospace.

In referring to example files, the installation directory for the tool is specified as

, and should be replaced with the correct value for your installation.


6/26



7/26


1

Windows Installation

This chapter describes the general installation procedure for Synopsys RSoft products on a

Windows platform. These packages include the Photonic Component Suite (RSoft CAD,FullWAVE, BeamPROP, DiffractMOD, BandSOLVE, GratingMOD, FemSIM, ModePROP,

LaserMOD, and/or MOST) and the Optical Communication Suite (OptSim, and/or ModeSYS).

While installing each suite places all products on your computer, an appropriate license is

required to use a specific product. Please consult the appropriate product manual for additionalinstructions.

1.A. Pre-Install Checklist

Please read through the following before installing:

Installation Executable

The process to obtain the installation executable depends on your physical location:

o Customers in Direct-Sales Locations

Direct-Sales customers (evaluating or purchased directly from Synopsys) must create aSolvNet account in order to download the latest installation executable. To create a

SolvNet account, go tohttp://solvnet.synopsys.com.Further instructions, including how

to order CDs from SolvNet, are available in the Process for Obtaining RSoft Software

and License Keys document.

o Customers in Distributor-Sales Locations

Distributor-Sales customers (evaluating or purchased through a Distributor) can obtain

the installation executable through the distributor.

USB Dongle

You will need a USB dongle with a serial number such as 16845678. This will be shipped to

you by Synopsys.
http://solvnet.synopsys.com/http://solvnet.synopsys.com/http://solvnet.synopsys.com/http://solvnet.synopsys.com/


8/26


License Key

You will need a license key that corresponds to the serial number of the USB dongle and to

the version of the suite(s) you are installing. Synopsys will email this file to the user on

record. If you have not received a license key, contact Synopsys with your name,organization, and serial number(s) [email protected] that license files

will eventually be made available through SolvNet (Direct-Sales Customers) or through yourdistributor (Distributor-Sales Customers).

Upgrades

Only users who have a current maintenance contract with Synopsys are entitled to freeupgrades. If you do not have a current maintenance contract, do not attempt to upgrade as

you will lose your currently installed version. See Section 1.C.1for information on upgrade

eligibility and how to check for upgrades.

o Updated license key

You will need an updated license key if you are installing a version that changes either of

the first two version numbers, i.e. 9.0 to 9.1. If you need a new license key, contact [email protected] your name, organization, and serial number(s).

o Backup

When upgrading, though not required, it is recommended that you backup the existing

installation during the upgrade process. Do not simply rename the \rsoftdirectory.

1.B. Installing the Software

Administrative rights are required. Do not attach the USB dongle until prompted by these

instructions.

1. Start by running the installation executable (usually setup.exe). Click Next.

2. Read through and agree to the License Agreement and click Nextto continue.

3. Enter your User Nameand Organizationand click Nextto continue.

4. Enter the directory to which the software should be installed. The default (c:\rsoft) isrecommended. Installations should not be made to directories with spaces. If installing

multiple suites, be sure to use the same directory. Click Nextto continue.

5. Select the Start Menu folder in which shortcuts to the programs(s) should be placed. It isrecommended that you use the default folder name. Click Nextto continue.

6. Select the type of license you have purchased:

If you are unsure about the type of license you have, choose Nodelocked.

licenses are standalone copies of the software to be used on one computer

only.

licenses can be shared across a network. You must repeat this entire

installation process on all computers that will use the software, including the network
mailto:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]


9/26


license server (the computer the USB dongle is connected to). Click Nextand enter the

Name or IP Address of Network Key Server. If this is unknown at this time, leave blank

and set later as described inSection 1.D.4.

Click Nextto continue.

7. Select the method for installing the license key:

you will be prompted to select the file,

and it will be copied to proper directory.

at the end of the installation the setup

program will tell you where to copy the license key.

best for upgrades where a new license key is not needed.

Click Nextto continue.

8. Review the installation options, and if any changes need to be made, click Back. If not, clickNextto continue to start the installation.

9. After the installation is complete, messages will appear if any parts of the installation were

unsuccessful. SeeSection 1.Dfor details on how to manually complete these installation

steps. Click Finish.

10.Once any required manual steps are completed, attach the USB dongle if applicable. In allcases, it is a good idea to restart the computer.

11.Open the software via the Start Menu. If the software does not successfully start, seeSection

1.Dfor troubleshooting help. In addition, use of clustering requires additional manual setup

as described inChapter 3. Also, Network/floating licenses require any firewall(s) to beconfigured as described inSection 1.D.4.

1.C. What Next?At this point you are ready to begin using the software.

The installation directory (rsoft) contains several subdirectories with important content:

Product Manuals and README Files

Each software product includes a comprehensive manual that describes its usage: manuals canbe opened via menus and toolbar buttons in each program. Online help files can be found in the

helpsubdirectory and printable PDF versions can be found in the docsubdirectory. The file

readme.txt, as well as other product-specific files, are located in the readmesubdirectory andprovide important program information that is not contained in the manuals, including new or

improved features and options.

Example Design and Tutorial Files

The software comes with an extensive set of examples and tutorial files located in the examples

subdirectory. Since it is easy to accidentally overwrite these files when experimenting, it is


10/26


recommended that you back up this folder to another location, perhaps a subdirectory of your

own home directory.

Main Executable Files

The binand bin32subdirectories contain the main executable files for each program.

1.D. Troubleshooting a Windows InstallationIf after performing the automatic installation procedure one or more installation steps wereunsuccessful, or if an error message appears when the program is opened, one or more manual

installation steps may be required.

These manual steps should only be used if needed.

1.D.1. Setting up the PATH

The bin directories (c:\rsoft\binand c:\rsoft\bin32by default) must be in the systems

PATH. To test that this setting is correct, open a Command Prompt (DOS window) and type the

command winplot. If the program is not recognized, type PATH and see if the correctdirectories are present. If not, contact your system administrator to assist you in modifying the

PATH.

1.D.2. Installing the License Key

To manually install the license key, copy the license key file you received from Synopsys into the

\licensessubdirectory in the main installation directory. This name of the license key mustmatch the serial number of the USB dongle and all user accounts that will use the software must

have read access to this file.

1.D.3. USB Dongle Drivers

To manually install the USB dongle drivers, log on as administrator, open a Command Prompt

(DOS window), and type the command:

haspdinst install

from the hardlocksubdirectory in the installation directory. If previous versions of the drivers

were installed, you should first give the command to haspdinst fremove to uninstall.

1.D.4. License Manager (rslmd.exe)The License Manager (rslmd.exe) is required for all installations. To manually install it, log onas administrator, open a Command Prompt (DOS window), and type the command:

rslmd install

If using a floating/network license, the environment variable RSLM_SERVERmust be set to pointto the network name or IP address of the network license server. This must be done on the key

server and all clients; contact your IT department to assist you in adding environment variables.


11/26


When using a nodelocked license, this variable does not need to be set and the default value of

localhostis assumed. Also, firewall(s) must allow the License Manager (rslmd.exe) tocommunicate via TCP on port 8988.

1.D.5. MPI for Clustering

To manually install MPICH2 which is required for clustering, log on as administrator, open aCommand Prompt (DOS window), and type the command:

smpd install

Additional manual installation steps are required for clustering and are described inChapter 3.


12/26


13/26


2

Linux Installation

This chapter describes the general installation procedure for Synopsys RSoft Photonic

Component Suite (RSoft CAD, FullWAVE, BeamPROP, DiffractMOD, BandSOLVE,GratingMOD, FemSIM, ModePROP, and/or MOST) on a Linux computer system. RSofts

Optical Communication Suite (OptSim, and/or ModeSYS) uses a different installation routine

that is documented separately. While installing this suite places all products on your computer, an

appropriate license is required to use a specific product. Please consult the appropriate productmanual for additional instructions.

2.A. Pre-Install Checklist

Before installing, have the following accessible before continuing with the installation:

Installation Executable

The process to obtain the installation executable depends on your physical location:

o Customers in Direct-Sales Locations

Direct-Sales customers (evaluating or purchased directly from Synopsys) must create aSolvNet account in order to download the latest installation executable. To create a

SolvNet account, go tohttp://solvnet.synopsys.com.Further instructions, including how

to order CDs from SolvNet, are available in the Process for Obtaining RSoft Software

and License Keys document.

o Customers in Distributor-Sales Locations

Distributor-Sales customers (evaluating or purchased through a Distributor) can obtain

the installation executable through the distributor.

USB Dongle

You will need a USB dongle with a serial number such as 16845678. This will be shipped to

you by Synopsys.
http://solvnet.synopsys.com/http://solvnet.synopsys.com/http://solvnet.synopsys.com/http://solvnet.synopsys.com/


14/26


License Key

You will need a license key that corresponds to the serial number of the USB dongle and to

the version of the suite(s) you are installing. Synopsys will email this file to the user on

record. If you have not received a license key, contact Synopsys with your name,organization, and serial number(s) [email protected] that license files

will eventually be made available through SolvNet (Direct-Sales Customers) or through yourdistributor (Distributor-Sales Customers).

The openmotifpackage must be installed. Contact your system administrator for helpinstalling this package.

Upgrades

Only users who have a current maintenance contract with Synopsys are entitled to free

upgrades. If you do not have a current maintenance contract, do not attempt to upgrade asyou will lose your currently installed version. See Section 1.C.1for information on upgrade

eligibility and how to check for upgrades.

o Updated license key

You will need an updated license key if you are installing a version that changes either of

the first two version numbers, i.e. 9.0 to 9.1. If you need a new license key, contact [email protected] your name, organization, and serial number(s).

o Backup

When upgrading, though not required, it is recommended that you backup the existing

installation during the upgrade process. For example, move /usr/local/rsoftto say

/usr/local/rsoft_9.0.

2.B. Installing the SoftwareYou need root access to perform some of these steps. Do not attach the USB dongle until

prompted by these instructions.

1. To start the installation process, copy the distribution file (usually rsoft.taz) in binary

mode to /usr/local. To install in a different directory, see the notes inSection 2.D.3.

2. Change directories to /usr/localand unpack the .tazfile with this command to install the

files in the /usr/local/rsoftdirectory:

tar zxf rsoft.taz

3. Next, determine whether you have purchased aNodelockedorNetwork/Floatinglicensebefore proceeding:

If you are unsure about the type of license you have, follow the Nodelocked instructions.

Nodelockedlicenses are standalone copies of the software to be used on one computeronly.
mailto:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]


15/26


Network/Floatinglicenses can be shared across a network. You must repeat the

installation on each computer that the software will be used on, including the network

license server (the computer the USB dongle is connected to).

4. For a Nodelocked installation, or installing the software on the network key server for aNetwork/Floating installation, the USB dongle drivers must be added to your systems

startup script. This step does not need to be performed on Network/Floating client machines.If your system uses the /etc/rc.d/rc.localscript, this can automatically be done with thecommand:

./usr/local/rsoft/hardlock/setup_usb

If not using the rc.localstartup script, seeSection 2.D.1for more information.

5. The License Daemon is required for all installations and must be added to your systems

startup script. If your system uses the /etc/rc.d/rc.localscript, this can be automaticallybe done with the command:

./usr/local/rsoft/etc/setup_rslmd

If installing on a 64-bit system, you will have to install your distributions 32-bitcompatibility package in order to run this script. If you want to manually start the License

Daemon, or if not using the rc.localstartup script, seeSection 2.D.1for more information.

Also, all firewalls must allow the license daemon (rslmd) to communicate via TCP on port8988.

6. The executable directories must be added to the login scripts of all users that will use thesoftware. If using the bash shell, add the command:

export PATH=$PATH:/usr/local/rsoft/bin:/usr/local/rsoft/bin32

to the ~/.bashrcfile. If not using the bash shell, a similar command should be added to yourshells login script.

7. If installing a Network/Floating license, the variable RSLM_SERVERmust be set to the IPaddress of the network key server in the login scripts of all users that will use the software. Ifusing the bash shell, add the command:

export RSLM_SERVER=

to the ~/.bashrcfile. If not using the bash shell, a similar command should be added to yourshells login script. For nodelocked installations, this variable does not need to be set and the

default value of localhostis assumed.

8. It is necessary to either restart the computer or reload the startup and login scripts (rc.local,

.bashrc, or others). It is also required that you source the .bashrcfile in the .bash_profile

file to ensure that it is always run.9. Copy the license key in binary form to the /usr/local/rsoft/licensesdirectory. All user

accounts that will use the software must have read access to the file.

10.Attach the USB dongle if appropriate.

11.Open the software via the command xbcad. If the software does not successfully start, seeSection 2.Dfor troubleshooting help. In addition, use of clustering requires additional setup


16/26


as described inChapter 3.Also, when using specific tools, messages about missing libraries

might be encountered; seeSection 2.D.4for more information.

2.C. What Next?

At this point you are ready to begin using the software.

The installation directory (rsoft/) contains several subdirectories with important content.

Product Manuals and README Files

Each software product includes a comprehensive manual that describes its usage: manuals canbe opened via menus and toolbar buttons in each program. Online help files can be found in the

helpsubdirectory and printable PDF versions can be found in the docsubdirectory. The file

readme.txt, as well as other product-specific files, are located in the readmesubdirectory andprovide important program information that is not contained in the manuals, including new orimproved features and options.

Example Design and Tutorial Files

The software comes with an extensive set of examples and tutorial files. The files in the

examplessubdirectory in the installation directory should be copied to the home directory of allusers who will use the software since they will not have permission to run files from the maindirectory.

Main Executable Files

The binand bin32subdirectories contain the main executable files for each program.

2.D. Troubleshooting a Linux InstallationIf after performing the installation an error message appears when the program is opened, reviewthe instructions above and the notes in this section. These are general instructions; for specific

instructions for various Linux distributions, see the file /readme/readmelinux.txt. If asolution cannot be found, contact Synopsys [email protected].

2.D.1. Configuring the Startup Script

These commands mustbe added to your systems startup script to start the USB dongle driver

and License Daemon:./usr/local/rsoft/hardlock/hldinst_usb

/usr/local/rsoft/bin/rslmd &

If using the /etc/rc.d/rc.localstartup script, this can be automatically done with the scriptsdescribed in theSection 2.B.On Network/Floating client machines, it is not necessary to install

the USB dongle driver. After adding these commands, it is necessary to either restart the machineor reload the script.
mailto:[email protected]:[email protected]:[email protected]:[email protected]


17/26


2.D.2. Setting Variables in User Login Scripts

Users must make modifications to the system PATHvariable and, in some cases, define new

variables in their login file. SeeSection 2.Bfor instructions for modifying the system PATH.

Users of the bash shell can add variables to the ~/.bashrcfile with the command:

export VARIABLE=VALUEIt is required that you source the .bashrcfile in the .bash_profilefile to ensure that it isalways run. Users of other shells must add similar commands in your shells login script. Aftermaking modifications to a user login script, either log off and on or reload the script.

2.D.3. Installing in a Different Directory

It is simplest to use the default installation directory /usr/local/rsoft. In certain cases such ascluster installations where it is necessary to install in a shared location, it is possible to install to

another directory provided the new directory does not have spaces and a symbolic link is made

between /usr/local/rsoftand the actual installation directory.

When installing to a different directory without a symbolic link, all features arenot guaranteed to work correctly. To do this, set the variables RSOFT_PROGRAMPATHand

LD_LIBRARY_PATHto /bin. The paths given in the installation instructions

should be modified appropriately.

2.D.4. Missing Shared Libraries

Required libraries are usually included on Linux systems by default. If any libraries are missing,

check your distributions repository and install it if possible. If no library is available, check the

included libraries in the etcsubdirectory. These libraries can be installed be moving to the bin

directory and giving the command tar zxf ../etc/libXXX.taz where XXXcorresponds to

the library name. To list the libraries used by a particular tool and see if they are on your system,use the command ldd .

If using SE Linux and a message appears that it cannot access a needed library (but not that it is

missing), move to the binsubdirectory and give the command ../etc/chconlib *.so*.

2.D.5. DOS Format *.ind & other text files

The Windows and Linux versions of Synopsys RSoft products are functionally identical and

input files can be interchanged between platforms. However, input ASCII files transferred

between Windows and Linux should be converted to the native format of the new platform. This

is easily accomplished using the dos2unixand unix2dosutilities which are most likely included

with your Linux distribution but if not are widely available on the Internet.

2.D.6. Environment Variables

These variables can be defined to set several program defaults:

RSOFT_EDITOR


18/26


This variable sets the text editor used to view certain text files produced by Synopsys RSoft

products. Depending on your environment, suitable values might be gedit (Gnome),

kedit (KDE), or xterm -geometry 120x20 -e vi (generic desktop).

RSOFT_BROWSER

This variable sets the HTML browser used to display online help. Suitable values might be

galeon or epiphany (Gnome), konqueror (KDE) or mozilla (generic desktop). For

the Firefox browser, copy the file /etc/myfirefox.sh into $HOME/binand set

this variable to $HOME/myfirefox.shto open the documentation correctly and in a new tabin an open browser if available.


19/26


3

Cluster Installation

This chapter describes the configuration of a cluster for both Windows and Linux systems.

Synopsys RSoft products supports a customized version of the MPICH2 implementation of MPIfrom Argonne National Lab (Copyright 2002 Argonne National Lab). The complete distribution

and further information regarding MPICH2 can be found atwww.mcs.anl.gov/mpi/mpich2/.

3.A. Pre-Install ChecklistPlease read this section before starting to use clustering features.

Licensing

Clustering allows simulations to use multiple cores, CPUs, or, machines utilizing themessage passing interface (MPI). Each computer in a clustered simulation must be

appropriately licensed. FullWAVEs clustering feature is included with every copy of

FullWAVE and allows clustering using multiple cores or CPUs on the same machine.

Multiple FullWAVE licenses can be clustered across multiple machines on a network. TheMOST clustering feature is licensed separately.

Basic Software Installation

Before configuring a cluster installation, the software should be installed on all nodes

(computers) as described in the previous chapters.

Starting MPICH2

Linux users can skip this step. For Windows platforms, be sure the automated installation

routine started the MPICH2 process (smpd.exe). This process can be manually started as

described inSection 1.D.5.

Cluster Installation and Testing
http://www.mcs.anl.gov/mpi/mpich2/http://www.mcs.anl.gov/mpi/mpich2/http://www.mcs.anl.gov/mpi/mpich2/http://www.mcs.anl.gov/mpi/mpich2/


20/26


All cluster users must first configure and test a standalone cluster (Section 3.B). Users who

are licensed for network clustering can then proceed to configuring and testing a networked

cluster (Section 3.C).

3.B. Configuring and Testing a Standalone ClusterA standalone (e.g. non-networked) cluster allows users to utilize multiple cores/CPUs in a singlecomputer.

3.B.1. Standalone FullWAVE Clusters

Linux users should set the environment variable P4_RSHCOMMAND=rshlocalin their login script

(seeSection 2.D.2)before running this test.

Open the file \examples\FullWAVE\wg.indin the CAD interface. Click the PerformSimulationbutton in the left toolbar and click OKto start the non-clustered simulation. The

entire simulation domain is visible in the simulation window. Click the Perform Simulationbutton again and, in the Cluster Option feature group, click Enableand set # Processesto 2.

Click OKto start the clustered simulation and note that half the simulation domain is visible in

the simulation window. The simulation has been split into two processes and only one is

displayed by default.

See the FullWAVE manual for more details about using clustering.

3.B.2. Standalone MOST Clusters

Instructions for testing a standalone MOST cluster can be found in Chapter 6 of the MOST

manual.

3.C. Configuring and Testing a Networked ClusterA networked cluster allows users to utilize multiple cores/CPUs/machines on a network. Firstthe connectivity between the nodes must be ensured, and then the cluster can be tested.

3.C.1. Ensuring Network Connectivity

Nodes within a cluster must be able to access the same simulation data and communicate with

each other across the network to remotely start jobs and share data.

Windows Clusters

To ensure network connectivity under Windows, perform these steps:

Configure firewall(s)

Any firewalls on the network must be configured to allow MPICH2 traffic to pass through it.

User accounts and running mpiexec


21/26


MPICH2 requires that a single user account be able to remotely access and start simulation

jobs on all computers in the cluster. The account should be created on each node if using a

Windows workgroup, or created on the domain controller if using a Windows domain. Donot user accounts with the name administrator or blank passwords.

To enable MPICH2 access, issue this command on the master node:

mpiexecregister

Enter the username and password to be used. To check that the user does indeed have remote

access, issue the command

mpiexec validate host cluster_node_name

where cluster_node_nameis the name of a specific node computer. Repeat this test for allnodes in the cluster.

Using a shared workspace

The working directory where simulation files are stored must be a shared folder on the

network that all cluster nodes can access and have full read and write permission.

Furthermore, it must be accessible via the same pathby all nodes in the cluster.

Open design files (.ind) via their UNC path on the master node. For example, if design

files are located in the directory c:\tmpon a computer named master_node, and this

directory is shared on the network as cluster_sims, open the file from the location

\\master_node/cluster_sims.

Map a shared drive to the shared directory where the design files are located. For

example, if the local drive c:\tmpon the master node is shared on the network and

mapped as z:on all the nodes, open the file from the mapped drive (z:\) on the masternode.

In both scenarios, each node will be able to access the design files using the same path.

Linux Clusters

To ensure network connectivity under Linux, perform these steps:

Configure firewall(s)

Any firewalls on the network must be configured to allow MPICH2 traffic to pass through it.

Enabling ssh

You must enable sshto remotely access nodes involved in a networked cluster. You shouldask your system administrator if these steps are necessary as some machines might already

have ssh enabled. To enable ssh, follow these steps:Add the following line to your user login file (seeSection 2.D.2)

export P4_RSHCOMMAND=ssh

Assuming that the cluster has a shared directory structure and that your home directory is the

same when you log into any node, issue the following command from your home directory

sshkeygen t dsa


22/26


Accept all the defaults (including the empty passphrase), then issue the commands

cd ~/.ssh

cp id_dsa.pub authorized_keys2

This will allow you to sshfrom one node to another without a password. Test this by using

this command twice from the master node:ssh cluster_node_name

The first time you try each node, you will get a question about the authenticity of the host -

type yesto continue. After that, you will not be asked again. This should be repeated for each

cluster node.

Note that if all processes will be run on the local host, sshis not needed to start jobs. To

disable the use of sshfor this case, set the variable P4_RSHCOMMAND=rshlocal.

Creating a shared workspace

The working directory where simulation files are stored must be a shared folder on the

network that all cluster nodes can access and have full read and write permission.Furthermore, it must be accessible via the same pathby all nodes in the cluster. This is most

easily done by accessing all design files and running all simulations with UNC paths. For

example, if design files are located in the directory \tmpon a computer named master_node,

and this directory is shared on the network as cluster_sims, open the file from the location

\\master_node\cluster_sims.

Environment Variables

In order for remote shells created by sshto function correctly, they require any variables to

be defined locally to be set in the new shell. Since sshonly uses standard shell initializationfiles make sure that any environment variables used by RSoft software or MPICH are definedin the standard login file. SeeSection 2.D.2for related information.

X11 forwarding

For FullWAVE simulation windows to appear on the master node, you must enable X11

forwarding in the sshconfiguration file (ssh_config) which is normally located in

/etc/ssh/.

3.C.2. Testing a Networked FullWAVE Cluster

First test each node separately and then test as a group.

Testing Nodes Separately

Open a command prompt on a node, move to the \examples\FullWAVEdirectory, and issue thefollowing command:

fwmpirun np1 hosts localhost show1 wg.ind

This command indicates that a clustered simulation of the file wg.indshould be performed on

the local machine with one process (CPU). A FullWAVE simulation window should openshowing a normal simulation of a simple waveguide.


23/26


Next, issue this command to use two processes (CPUs) on the local machine:

fwmpirun np2 hosts localhost show1 wg.ind

A FullWAVE simulation window should open that shows half of the simulation domain seen

before. If this appears MPICH is working correctly. This should be repeated on all nodes toensure they function correctly.

Testing Nodes Together

Once the nodes have been verified to work on their own, the networked aspect of the clusteringcan be tested. Open a command prompt on the master node and move to the shared directory

created in the previous section. Copy the file \examples\FullWAVE\wg.indto this directory andissue the command

fwmpirun np2 hosts master_node_name,cluster_node_name show1 wg.ind

where master_node_nameand cluster_node_nameare the names of the master node and a

cluster node respectively. Note that the path to the design file (wg.ind) might have to bemodified as described in the previous section depending on where it is located. If everything has

been set up correctly, a simulation window will open showing half of the simulation domain.Repeat this test with the rest of the cluster nodes to ensure they have been set up correctly.

For more details on the usage of FullWAVE clustering, see the FullWAVE manual.

3.C.3. Testing Networked MOST ClustersInstructions for testing a MOST cluster can be found in the MOST manual.


24/26


25/26


4

Uninstalling

Should you choose to uninstall Synopsys RSoft products, please follow these instructions.

4.A. Uninstalling the PackageBefore uninstalling the software, it is recommended to backup the installation directory includingany license key files and user work.

Some of these steps require administrative (root) access and, if done incorrectly, can seriously

impair your system; consult your IT department before performing any of these steps.

Windows:

In most cases, it is sufficient to uninstall the package via the Add/Remove Programs option in the

Control Panel. However, if it is necessary to completely remove the package, use these steps:

Run the following commands from the command line (DOS Window) to remove the MPIdaemon, the License Manager, and USB dongle driver:

smpd remove

rslmd remove

haspdinst fremove

Remove the following environment variables if they exist: RSLM_SERVER,

RSOFT_PROGRAMPATH, RSOFT_LICENSEPATH, RSOFT_MATLIB_GROUP_PATH, or HLS_IPADDR.

Delete BCADW32.INI, WINPLOT.INI, and LASERMOD.INIfrom the users home directory.

Modify the PATHenvironment variable to remove RSoft's executable directories

c:\rsoft\binand c:\rsoft\bin32.

Delete the installation directory (c:\RSoftby default).


26/26

If all of the above steps have been completed, it should be able to be removed.If not, contact

Synopsys [email protected].

Linux:

To uninstall the package under Linux, remove any commands from login/startup scripts related

to the package, including:

Commands that start the USB dongle driver and License Daemon.

Remove the following environment variables if they exist: RSLM_SERVER,

RSOFT_PROGRAMPATH, RSOFT_LICENSEPATH, LD_LIBRARY_PATH,

RSOFT_MATLIB_GROUP_PATH, or HLS_IPADDR.

Commands that add the executable directories /usr/local/rsoft/binand

/usr/local/rsoft/bin32from the system PATH.

Finally, delete the installation directory /usr/local/rsoft.

4.B. Uninstalling Older Versions

These instructions are for versions earlier than RSoft CAD 5.0g, OptSim 4.0, and LaserMOD

2.0.

To remove any of these versions, it is first recommended to backup any license key files and the

installation directory (usually C:\BEAMPROP, c:\LINKSIM, or c:\LaserMODon Windows,

/usr/local/beampropon Linux). Then, depending on the platform, perform the following:

These steps require administrative access and, if not done correctly, can seriously impair your

system; consult your IT department before performing any of these steps.

Windows only: Remove dongle driver by opening a Command Prompt (DOS Window),

moving to the old installation directory, and issuing the following command: hldinst

remove or hlinst d. If you are running a network license server, first stop and remove

the server by typing hls32svc remove.

Linux only:Remove any lines in rc.localor other startup scripts for the dongle driver.

Remove any environment variables for RSoft products that you may have set and remove all

PATHsettings that refer to the installation directory.

Delete the installation directory.

Linux only:Links in /usr/local/binwill be broken after deleting/renaming the oldinstallation directory. These can be manually removed, or, if installing the new version, canbe automatically removed.
mailto:[email protected]:[email protected]:[email protected]:[email protected]

Documents

RSoft Product Guide OptSim 5.3