From Documentation
Revision as of 17:53, 15 February 2013 by Bge (Talk | contribs)

Jump to: navigation, search
Description: Providing photonic and optoelectronic TCAD device simulation and photonic integrated circuit design products
SHARCNET Package information: see LUMERICAL software page in web portal
Full list of SHARCNET supported software

Licensing Information

As of February 2013, SHARCNET no long holds the FDTD Solutions (also known as front end or GUI) licence. Users who need to use FDTD Solutions for their model construction and data analysis must obtain their own licences.

Thanks to the kind donation of FDTD Engine licences by Lumerical, Inc., SHARCNET will continue to support the serial farming and parallel processing of FDTD simulations on SHARCNET systems.

The Workflow

It is assumed that users prepare their simulation files on their own computers with FDTD Solutions and then carry on large scale simulations--being large number of cases or large size of problems that are not feasible on their computers--on SHARCNET systems through serial farming or parallel processing. Typically this will involve transferring simulation files to SHARCNET and copying computed results back to their local computers for analysis.

To transfer data between one's computers and SHARCNET systems, one may use the common secure file transfer client software such as SSH Secure File Transfer Client, WinSCP, putty-sftp, etc. Users are referred to the tutorials on using these tools.

Account Preparation (version 6 only)

Before running lumerical on requin or rainbow verify that the following "ini" file exists and contains the server and type line as shown. If it doesnt exist created it. Note that if you have been running version 7 jobs the "ini" file might be corrupted and need to be re-created:

1) First create the directory using the following command:

mkdir -p ~/.config/Lumerical 

2) Using an editor (such as vi) open the "ini" file:

vi .config/Lumerical/"FDTD Solutions.ini"

3) Paste in the following 3 lines and save the file:


Loading Lumerical Module

Before you can run Lumerical version 7.5.2 or newer, you must load the Lumerical module:

module load lumerical

Using FDTD Solutions GUI CAD

The graphical interface on SHARCNET's system is named CAD. To run CAD remotely on the login nodes (or tope) from a windows desktop, one needs an X server running on the local desktop. We recommend using Xming + Putty [1] or Cygwin/X[2]. They are all free. Or if your connecting from a linux desktop then run the "ssh -X clustername" command for instance:

ssh -X
module load lumerical
cd /scratch/$USER
cp /opt/sharcnet/lumerical/7.5.6/examples/paralleltest.fsp .
CAD paralleltest.fsp

Submitting A Parallel Job (version 6.5.5)

Due to system level incompatibilities on requin and rainbow the latest version of lumerical cannot be installed. Therefore the previous non-modularized version 6 remains on these systems. Since as before the binaries are found by default in your path to run a job simply requires doing:

sqsub -test -q mpi -r 59m -n 16 -o ofile.%J FDTD-par-hpmpi-lcl paralleltest.fsp

Submitting A Parallel Job JOB (version 7.5.6)

Starting with version 7 the lumerical module must be loaded first before submitting a job or running the CAD command for instance as follows:

module unload intel openmpi
module load intel/11.0.083 openmpi/intel/1.4.2
module load lumerical/7.5.6
sqsub -q mpi -r 1.5h -n 16 -o ofile%J fdtd-engine-ompi-lcl paralleltest.fsp

For further details about Distributed simulation testing please refer to the documentation on Lumerical's web site which can be found here[3].