finesse.py 54.6 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# -*- coding: utf-8 -*-
"""
Created on Sun Jan 27 09:56:53 2013

PyKat - Python interface and wrapper for FINESSE
Copyright (C) 2013 Daniel David Brown

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Contact at ddb@star.sr.bham.ac.uk

@author: Daniel Brown
"""
import sys
import os
import subprocess
import tempfile
import numpy as np
import datetime
import pickle
import pykat
import warnings
import re
36
import math       
Daniel Brown's avatar
Daniel Brown committed
37
import itertools
Daniel Brown's avatar
Daniel Brown committed
38
import ctypes
Daniel Brown's avatar
Daniel Brown committed
39
import ctypes.util
Daniel Brown's avatar
Daniel Brown committed
40
import collections
41
42
import re

43
from collections import namedtuple, OrderedDict
44

Daniel Brown's avatar
Daniel Brown committed
45
46
47
48
49
from pykat.node_network import NodeNetwork
from pykat.detectors import Detector
from pykat.components import Component
from pykat.commands import Command, xaxis
from pykat.gui.gui import pyKatGUI
50
from pykat.SIfloat import *
51
from pykat.param import Param, AttrParam
Daniel Brown's avatar
Daniel Brown committed
52
53
54
55
56
57

import pykat.exceptions as pkex

from PyQt4.QtCore import QCoreApplication
from PyQt4.QtGui import QApplication

Daniel Brown's avatar
Daniel Brown committed
58
59
from multiprocessing import Process, Manager

Daniel Brown's avatar
Daniel Brown committed
60
61
NO_GUI = False
NO_BLOCK = "NO_BLOCK"
62
63
pykat_web = "www.gwoptics.org/pykat"

Daniel Brown's avatar
Daniel Brown committed
64
65
66
67
68
69
70
# containers used in the trace routine
space_trace = namedtuple("space_trace", ['gouyx','gouyy'])
node_trace = namedtuple("node_trace", ['qx','qy'])
cav_trace = namedtuple("cav_trace", ['isStable','gx','gy','qx','qy','finesse','loss','length','FSR','FWHM','pole'])
         
lkat_location = ctypes.util.find_library("kat")
                                     
Daniel Brown's avatar
Daniel Brown committed
71
72
73
def f__lkat_process(callback, cmd, kwargs):
    """
    """
Daniel Brown's avatar
Daniel Brown committed
74
75
76
77
78
    
    if lkat_location == None:
        raise RuntimeError("Could not find shared library 'libkat', please install to a system location or copy to the same directory as this script")
        
    lkat = ctypes.PyDLL(lkat_location)
Daniel Brown's avatar
Daniel Brown committed
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

    try:
        lkat._pykat_preInit() # must always be called, sets up
                        # exception handling and such no simulation
                        # specifc code here

        # reads in the kat.ini and setups up other parts
        lkat._pykat_init()
        lkat._pykat_setup(cmd)
    
        callback(lkat, **kwargs)
    
    except Exception as ex: 
        print "Exception caught in python: ", ex.message
    finally:
        # This should always be called no matter what
        lkat._pykat_finish(0)
Daniel Brown's avatar
Daniel Brown committed
96
97


98
def f__lkat_trace_callback(lkat, trace_info, getCavities, getNodes, getSpaces):
Daniel Brown's avatar
Daniel Brown committed
99
100
101
102
103
104
105
106
107
108
109
110
    """
    lkat callback for computing the beam traces through a setup.
    Returns a dictionary of nodes, spaces and cavities and the
    various outputs of the tracing algorithm.
    """
    import pylibkat

    # first we need to get a handle on the internals of Finesse
    inter = pylibkat.interferometer.in_dll(lkat, "inter")

    lkat._pykat_step()

111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
    if getNodes:
        for n in range(0, inter.num_nodes):
            node = inter.node_list[n]

            node_info = node_trace(
                                    qx = complex(node.qx.re, node.qx.im),
                                    qy = complex(node.qy.re, node.qy.im)
                                    )

            trace_info[node.name] = node_info

    if getCavities:
        for c in range(0, inter.num_cavities):
            cav = inter.cavity_list[c]

            cav_info = cav_trace(
                                isStable = (cav.stable == 1),
                                gx = cav.stability_x,
                                gy = cav.stability_y,
                                qx = complex(cav.qx.re, cav.qx.im),
                                qy = complex(cav.qy.re, cav.qy.im),
                                finesse = cav.finesse,
                                FSR = cav.FSR,
                                FWHM = cav.FWHM,
                                loss = cav.loss,
                                length = cav.length,
                                pole = cav.pole
Daniel Brown's avatar
Daniel Brown committed
138
139
                                )

140
            trace_info[cav.name] = cav_info
Daniel Brown's avatar
Daniel Brown committed
141

142
143
144
    if getSpaces:
        for s in range(0, inter.num_spaces):
            space = inter.space_list[s]
Daniel Brown's avatar
Daniel Brown committed
145

146
147
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
148
149
                     
                                             
Daniel Brown's avatar
Daniel Brown committed
150
151
152
153
154
155
156
157
158
class katRun(object):
    def __init__(self):
        self.runDateTime = datetime.datetime.now()
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
159
        self.yaxis = None
160
        
161
162
163
164
165
166
167
    def plot(self):
        import pylab
        
        pylab.plot(self.x, self.y)
        pylab.legend(self.ylabels,0)
        pylab.xlabel(self.xlabel)
        pylab.show()
Daniel Brown's avatar
Daniel Brown committed
168
        
169
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
170
171
172
173
174
175
176
177
178
179
180
        with open(filename,'w') as outfile:
            pickle.dump(self, outfile)
    
    @staticmethod
    def loadKatRun(filename):
        with open(filename,'r') as infile:
            return pickle.load(infile)
    
    def get(self, value): return self[value]
    
    def __getitem__(self, value):
181
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
182
        
183
184
185
        
        if len(idx) > 0:
            out = self.y[:, idx]
186
            
187
188
189
190
191
192
193
            if self.yaxis == "abs:deg":
                out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
            elif self.yaxis == "re:im":
                out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
            
            out.squeeze()
            
194
            if out.size == 1:
195
                return out[0]
196
            else:
197
                return out
Daniel Brown's avatar
Daniel Brown committed
198
        else:
199
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
      
class katRun2D(object):
    def __init__(self):
        self.runDateTime = datetime.datetime.now()
        self.x = None
        self.y = None
        self.z = None
        self.xlabel = None
        self.ylabel = None
        self.zlabels = None
        self.katScript = None
        self.katVersion = None
        
    def saveKatRun(self, filename):
        with open(filename,'w') as outfile:
            pickle.dump(self, outfile)
    
    @staticmethod
    def loadKatRun(filename):
        with open(filename,'r') as infile:
            return pickle.load(infile)
    
222
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
223
224
    
    def __getitem__(self, value):
225
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
226
227
228
229
230
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
231
    
232
        
233
234
class Signals(object):
    class fsig(object):
235
236
237
238
239
240
        def __init__(self, param, name, amplitude, phase):
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
241
            self.__removed = False
242
243
244
245
246
247
            
            # unfortunatenly the target names for fsig are not the same as the
            # various parameter names of the components, e.g. mirror xbeta is x 
            # for fsig. So we need to check here what type of component we are targetting
            # and then based on the parameter specfied get the name
            if not param.canFsig:
248
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
249
250
251
            
        def _register_param(self, param):
            self._params.append(param)
252
253
254
        
        @property
        def removed(self): return self.__removed
255
  
256
257
258
259
260
261
        def remove(self):
            if self.__removed:
                raise pkex.BasePyKatException("Signal {0} has already been marked as removed".format(self.name))
            else:
                self._kat.remove(self)
        
262
263
264
265
266
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
267
268
269
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

270
271
272

        @property
        def phase(self): return self.__phase
273
274
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
275
276
277
278
279

        @property
        def target(self): return self.__target.fsig_name

        @property
280
        def owner(self): return self.__target._owner().name
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
    
        def getFinesseText(self):
            rtn = []
    
            for p in self._params:
                rtn.extend(p.getFinesseText())
        
            return rtn
    
    @property
    def name(self):
        # if we don't have any signals yet then use a dummy name
        # however we need to always tune a real fsig command
        # so need to get the name of at least one of them
        # as if you tune one you tune them all
        if len(self.targets) == 0:
297
            return "fsignal"
298
299
        else:
            return self.targets[0].name
300
301
302
303
            
    @property
    def removed(self): return False # we can never remove the Signal object altogethr just the
                                    # individual fsig targets
304

305
306
307
308
    def remove(self):
        for t in self.targets:
            self._kat.remove(self)
            
309
310
    @property
    def f(self): return self.__f
311
312
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
    
    def __init__(self):

        self.targets = []
        self._params = []
        
        self.__f = Param("f", self, 1)
    
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
        if target == None:
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
        if name == None:
330
            name = "sig_" + target._owner().name + "_" + target.name
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
        
        self.targets.append(Signals.fsig(target, name, amplitude, phase))
        
    def getFinesseText(self):
        rtn = []
        
        for t in self.targets:
            rtn.extend(t.getFinesseText())
            rtn.append("fsig {name} {comp} {target} {frequency} {phase} {amplitude}".format(name = t.name, comp=t.owner, target=t.target, frequency=str(self.f), phase=str(t.phase), amplitude=str(t.amplitude)))
        
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
        
Daniel Brown's avatar
Daniel Brown committed
347
348
349
350
351
352
353
354
355
class Block:
    def __init__(self, name):
        self.__name = name
        self.contents = [] # List of objects and strings of finesse code
        self.enabled = True 
        
    @property
    def name(self): return self.__name
    
356
357
358
Constant = namedtuple('Constant', 'name, value, usedBy')
    
class kat(object):  
Daniel Brown's avatar
Daniel Brown committed
359
360
        
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
361
362
363

        cls = type(self)
        self.__class__ = type(cls.__name__, (cls,), {})
Daniel Brown's avatar
Daniel Brown committed
364
365
366
        
        self.scene = None # scene object for GUI
        self.verbose = True
367
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
368
369
370
371
372
373
374
375
376
377
        self.__components = {}  # dictionary of optical components      
        self.__detectors = {}   # dictionary of detectors
        self.__commands = {}    # dictionary of commands
        self.__gui = None
        self.nodes = NodeNetwork(self)  
        self.__katdir = katdir
        self.__katname = katname
        self.__tempdir = tempdir
        self.__tempname = tempname
        self.pykatgui = None
378
        self.__signals = Signals()
379
        self.constants = {}
380
        self.vacuum = []
381
382
        self.__prevrunfilename = None
        self.printmatrix = None
383
384
385
386
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
387
388
389
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
390
391
        self.retrace = None
        self.deriv_h = None
392
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
393
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
394
395
        self.__phase = None
        self.__maxtem = None
396
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
397
        self.__time_code = None
398
        self.__yaxis = "abs" # default yaxis
399
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
400
401
402
403
404
405
406
407
408
        
        if kat_code != None and kat_file != None:
            raise pkex.BasePyKatException("Specify either a Kat file or some Kat code, not both.")
        
        if kat_code != None:
            self.parseCommands(kat_code)
        
        if kat_file != None:
            self.loadKatFile(kat_file)
Daniel Brown's avatar
Daniel Brown committed
409

410
411
412
    @property
    def signals(self): return self.__signals

413
414
415
416
417
418
419
420
421
422
423
    yaxis_options = ["abs:deg","db:deg","re:im","abs","db","deg"]
    @property
    def yaxis(self): return self.__yaxis
    @yaxis.setter
    def yaxis(self, value):
        
        if not str(value) in self.yaxis_options:
            raise pkex.BasePyKatException("yaxis value '{0}' is not a value option. Valid options are: {1}".format(str(value), ",".join(self.yaxis_options) ))
            
        self.__yaxis = str(value)

Sean Leavey's avatar
Sean Leavey committed
424
425
426
427
428
429
430
431
432
433
434
    @property
    def trace(self): return self.__trace
    @trace.setter
    def trace(self, value):
        value = int(value)

        if value < 0 or value > 255:
            raise pkex.BasePyKatException('trace command only accepts values in the range 0-255.')
        else:
            self.__trace = value

435
436
437
438
439
440
441
442
443
444
    @property
    def lambda0(self): return self.__lambda0
    @lambda0.setter
    def lambda0(self, value):
        self.__lambda0 = SIfloat(value)
        
        for node in self.nodes.getNodes():
            if self.nodes[node].q != None:
                self.nodes[node].q.wavelength = self.__lambda0

Daniel Brown's avatar
Daniel Brown committed
445
446
447
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
448
449
450
451
452
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
453
454
455
456
457
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
458
        
Daniel Brown's avatar
Daniel Brown committed
459
460
461
462
463
    @property
    def getPerformanceData(self): return self.__time_code
    @getPerformanceData.setter
    def getPerformanceData(self,value): self.__time_code = bool(value)
    
Daniel Brown's avatar
Daniel Brown committed
464
465
466
467
468
469
470
471
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
Daniel Brown's avatar
Daniel Brown committed
472
473
474
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
475
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
476

477
478
    @staticmethod
    def logo():
Daniel Brown's avatar
Daniel Brown committed
479
        print """                                              ..-
480
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
481
482
483
484
485
486
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
Daniel Brown's avatar
Daniel Brown committed
487
   `^-....____:   +.      {1}""".format(pykat.__version__, pykat_web)
Daniel Brown's avatar
Daniel Brown committed
488
489
490
491
492
493
494
495
    
    def loadKatFile(self, katfile):
        commands=open(katfile).read()
        self.parseCommands(commands)
    
    def parseKatCode(self, code):
        #commands = code.split("\n")
        self.parseCommands(code)
496
497
498
499
500
501
502
503
504

    def processConstants(self, commands):
        """
        Before fully parsing a bunch of commands firstly any constants or variables
        to be recorded and replaced.
        """
        constants = self.constants
        
        for line in commands:
505
            values = line.split()
506
507
508
            
            if len(values)>0 and values[0] == 'const':
                
Daniel Brown's avatar
Daniel Brown committed
509
                if len(values) >= 3:
510
511
512
                    if values[1] in constants:
                        raise pkex.BasePyKatException('const command with the name "{0}" already used'.format(values[1]))
                    else:
Daniel Brown's avatar
Daniel Brown committed
513
                        constants[str(values[1])] = Constant(values[1], values[2], [])
514
515
516
517
518
519
                else:
                    raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
        
        commands_new = []
        
        for line in commands:
520
            values = line.split()
521
            
522
            if len(values) > 0 and values[0] != 'const':
523
524
525
                # check if we have a var/constant in this line
                if line.find('$') >= 0:
                    for key in constants.keys():
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
                        # TODO: need to fix this for checking mulitple instances of const in a single line
                        
                        chars = [' ', '+', '-', '*', '/', ')']

                        for c in chars:
                            none_found = False
                            
                            while not none_found:
                                if line.find('$'+key+c) > -1:
                                    constants[key].usedBy.append(line)
                                    line = line.replace('$'+key+c, str(constants[key].value)+ c)
                                else:
                                    none_found = True
                        
                        if line.endswith('$'+key):
541
542
543
544
545
546
547
548
                            constants[key].usedBy.append(line)
                            line = line.replace('$'+key, str(constants[key].value))
                        
                commands_new.append(line)
    
        self.constants = constants
        
        return commands_new
Daniel Brown's avatar
Daniel Brown committed
549
550
551
552
553
        
    def parseCommands(self, commands):
        blockComment = False
        
        commands=self.remove_comments(commands)
554
555
        
        commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
556
557
558
559
        
        after_process = [] # list of commands that should be processed after 
                           # objects have been set and created
        
560
        for line in commands:
Daniel Brown's avatar
Daniel Brown committed
561
562
563
564
565
            #for line in commands:
            if len(line.strip()) >= 2:
                line = line.strip()

                # Looking for block start or end
566
                values = line.split()
Daniel Brown's avatar
Daniel Brown committed
567
568
569
570
                if values[0] == "%%%":
                    if values[1] == "FTblock":
                        newTag = values[2]
                        
571
                        if self.__currentTag != None and self.__currentTag != NO_BLOCK: 
Daniel Brown's avatar
Daniel Brown committed
572
573
574
                            warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
                            
                        if newTag in self.__blocks:
Daniel Brown's avatar
Daniel Brown committed
575
                            raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
Daniel Brown's avatar
Daniel Brown committed
576
577
                            
                        self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
578
                        self.__currentTag = newTag
Daniel Brown's avatar
Daniel Brown committed
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
                        
                    if values[1] == "FTend":
                        self.__currentTag = NO_BLOCK
                        
                    continue
                #warnings.warn("current tag {0}".format(self.__currentTag))    

                # don't read comment lines
                if line[0] == "#" or line[0] == "%":
                    continue
                
                # check if block comment is being used
                if not blockComment and line[0:2] == "/*":
                    blockComment = True
                    continue
                elif blockComment and line[0:2] == "*/":
                    blockComment = False
                    continue
                
                first = line.split(" ",1)[0]
                obj = None
                if(first == "m" or first == "m1" or first == "m2"):
                    obj = pykat.components.mirror.parseFinesseText(line)
                elif(first == "s"):
                    obj = pykat.components.space.parseFinesseText(line)
                elif(first == "l"):
                    obj = pykat.components.laser.parseFinesseText(line)
606
607
                elif(first == "sq"):
                    obj = pykat.components.squeezer.parseFinesseText(line)
Daniel Brown's avatar
Daniel Brown committed
608
609
610
611
612
613
614
615
616
617
                elif(first[0:2] == "bs"):
                    obj = pykat.components.beamSplitter.parseFinesseText(line)
                elif(first[0:2] == "gr"):
                    obj = pykat.components.grating.parseFinesseText(line)
                elif(first[0:4] == "isol"):
                    obj = pykat.components.isolator.parseFinesseText(line)
                elif(first[0:4] == "lens"):
                    obj = pykat.components.lens.parseFinesseText(line)
                elif(first[0:3] == "mod"):
                    obj = pykat.components.modulator.parseFinesseText(line)
Daniel Brown's avatar
Daniel Brown committed
618
619
                elif(first[0:2] == "ad"):
                    obj = pykat.detectors.ad.parseFinesseText(line)
620
621
622
623
                elif(first[0:2] == "bp"):
                    obj = pykat.detectors.bp.parseFinesseText(line)
                elif(first[0:4] == "gouy"):
                    obj = pykat.detectors.gouy.parseFinesseText(line)
624
                elif(first[0:2] == "pd" and first != "pdtype"):
625
                    obj = pykat.detectors.pd.parseFinesseText(line)
626
                elif(first == "qshot" or first == "qshotS" or first == "qshotN"):
Daniel Brown's avatar
Daniel Brown committed
627
                    obj = pykat.detectors.qshot.parseFinesseText(line)
628
                elif(first == "qnoised" or first == "qnoisedS" or first == "qnoisedN"):
Daniel Brown's avatar
Daniel Brown committed
629
                    obj = pykat.detectors.qnoised.parseFinesseText(line)
Daniel Brown's avatar
Daniel Brown committed
630
631
632
633
634
635
                elif(first == "xaxis" or first == "xaxis*"):
                    obj = pykat.commands.xaxis.parseFinesseText(line)
                elif(first == "x2axis" or first == "x2axis*"):
                    obj = pykat.commands.x2axis.parseFinesseText(line)
                elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
                    after_process.append(line)
636
637
                elif(first == "scale"):
                    after_process.append(line)
638
639
                elif(first == "pdtype"):
                    after_process.append(line)
Daniel Brown's avatar
Daniel Brown committed
640
641
                elif(first == "attr"):
                    after_process.append(line)
Daniel Brown's avatar
Daniel Brown committed
642
643
                elif(first == "noxaxis"):
                    self.noxaxis = True
644
645
646
                elif(first == "lambda"):
                    v = line.split()
                    self.lambda0 = SIfloat(v[-1])
647
648
649
650
                elif(first == "yaxis"):
                    v = line.split()
                    
                    self.yaxis = v[-1]
651
                elif(first == "phase"):
652
                    v = line.split()
653
                    if len(v) != 2:
654
                        raise pkex.BasePyKatException("phase command `{0}` is incorrect.".format(line))
655
656
                    else:
                        self.phase = int(v[1])
657
                elif(first == "maxtem"):
658
                    v = line.split()
659
660
661
                    if len(v) != 2:
                        raise pkex.BasePyKatException("maxtem command `{0}` is incorrect.".format(line))
                    else:
662
663
664
                        if v[1] == "off":
                        	self.maxtem = -1
                        else:
665
	                        self.maxtem = int(v[1])
Sean Leavey's avatar
Sean Leavey committed
666
667
668
669
670
671
                elif(first == "trace"):
                    v = line.split()
                    if len(v) > 2:
                        raise pkex.BasePyKatException("Trace command `{0}` is incorrect.".format(line))
                    elif len(v) == 2:
                        self.trace = v[1]
672
                elif(first == "retrace"):
673
                    v = line.split()
Daniel Brown's avatar
Daniel Brown committed
674
                    if len(v) > 2:
675
                        raise pkex.BasePyKatException("Retrace command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
676
                    elif len(v) == 2:
677
                        self.retrace = v[1]                        
678
                elif(first == "deriv_h"):
679
                    v = line.split()
680
                    if len(v) != 2:
681
                        raise pkex.BasePyKatException("deriv_h command `{0}` is incorrect.".format(line))
682
683
                    else:
                        self.deriv_h = float(v[1])
684
685
686
                elif(first == "gnuterm" or first == "pyterm"):
                    if self.verbose:
                        print "Ignoring Gnuplot/Python terminal command '{0}'".format(line)
687
688
689
690
691
                #elif(first == "fsig"):
                #    after_process.append(line)
                elif(first == "noplot"):
                    obj = line
                    self.__blocks[self.__currentTag].contents.append(line) 
Daniel Brown's avatar
Daniel Brown committed
692
693
694
                else:
                    if self.verbose:
                        print "Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line)
695
                        
Daniel Brown's avatar
Daniel Brown committed
696
697
698
699
700
                    obj = line
                    # manually add the line to the block contents
                    self.__blocks[self.__currentTag].contents.append(line) 
                
                if obj != None and not isinstance(obj, str):
701
702
                    if self.hasNamedObject(obj.name):
                        getattr(self, obj.name).remove()
703
                        print "Removed existing object '{0}' of type {1} to add line '{2}'".format(obj.name, obj.__class__, line)
704
                        
Daniel Brown's avatar
Daniel Brown committed
705
706
                    self.add(obj)
                    
707
                    
Daniel Brown's avatar
Daniel Brown committed
708
709
710
        # now process all the varous gauss/attr etc. commands which require
        # components to exist first before they can be processed
        for line in after_process:
711
            first = line.split(" ",1)[0]            
Daniel Brown's avatar
Daniel Brown committed
712
            if first == "gauss" or first == "gauss*" or first == "gauss**":
713
                pykat.commands.gauss.parseFinesseText(line, self)
714
            elif (first == "scale"):
715
                v = line.split()
716
717
718
719
720
                if len(v) == 3:
                    component_name = v[2]
                    if component_name in self.__detectors :
                        self.__detectors[component_name].scale = SIfloat(v[1])
                    else:
721
                        raise pkex.BasePyKatException("scale command `{0}` refers to non-existing output".format(component_name))
722
723
724
725
726
                elif len(v) == 2:
                    if v[1] == "meter" or v[1] == "ampere" or v[1] == "deg":
                        self.scale = v[1]
                    else:
                        self.scale = SIfloat(v[1])
727
                else:
728
                    raise pkex.BasePyKatException("scale command `{0}` is incorrect.".format(line))
729
            elif (first == "pdtype"):
730
                v = line.split()
731
732
733
                if len(v) == 3:
                    component_name = v[1]
                    if component_name in self.__detectors :
Andreas Freise's avatar
Andreas Freise committed
734
                        self.__detectors[component_name].pdtype = v[2]
735
                    else:
736
                        raise pkex.BasePyKatException("pdtype command `{0}` refers to non-existing detector".format(component_name))
737
                else:
738
                    raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
739
740
            elif(first == "attr"):
                v = line.split()
741

Daniel Brown's avatar
Daniel Brown committed
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
                if len(v) < 4:
                    raise pkex.BasePyKatException("attr command `{0}` is incorrect.".format(line))
                else:
                    # get the component/detector in question
                    if v[1] in self.__components:
                        comp = self.__components[v[1]]
                    elif v[1] in self.__detectors:
                        comp = self.__detectors[v[1]]
                    else:
                        raise pkex.BasePyKatException("Could not find the component '{0}' for attr command in line '{1}'".format(v[1], line))
                
                    if len(v[2:]) % 2 == 1:
                        raise pkex.BasePyKatException("Attr command '{0}' must specify both parameter and value pairs".format(line))
                                                
                    # convert split list to key value pairs
                    kv = dict(itertools.izip_longest(*[iter(v[2:])] * 2, fillvalue=None))

                    comp.parseAttributes(kv)
760
                    
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
            elif(first == "fsig"):
                
                v = line.split()
                
                if v[2] in self.__components:
                    comp = self.__components[v[1]]
                else:
                    raise pkex.BasePyKatException("Could not find the component '{0}' for attr command in line '{1}'".format(v[1], line))
                
                
                #kat.siganls.apply()
                
            else:
                raise pkex.BasePyKatException("Haven't handled parsing of '{0}'".format(line))
                    
Daniel Brown's avatar
Daniel Brown committed
776
        self.__currentTag = NO_BLOCK 
777
        
Daniel Brown's avatar
Daniel Brown committed
778
779
780
781
782
783
784
785
786
787
788
789
790
    def saveScript(self, filename=None):
        """
        Saves the current kat object to a Finesse input file
        """
        try:
            katScript = "".join(self.generateKatScript())       
            katfile = open(filename,'w')
            katfile.writelines(katScript)
            katfile.flush()
            katfile.close()

        except pkex.BasePyKatException as ex:
            print ex
Daniel Brown's avatar
Daniel Brown committed
791

Daniel Brown's avatar
Daniel Brown committed
792
            
Daniel Brown's avatar
Daniel Brown committed
793
794
795
796
797
798
799
800
    def getProcess(self, callback, **kwargs):
        """
        """
        
        cmd = "\n".join(self.generateKatScript())
        
        return Process(target=f__lkat_process, args=(callback, cmd, kwargs))
           
801
    def run(self, printout=0, printerr=0, plot=None, save_output=False, save_kat=False, kat_name=None) :
Daniel Brown's avatar
Daniel Brown committed
802
803
804
805
        """ 
        Runs the current simulation setup that has been built thus far.
        It returns a katRun or katRun2D object which is populated with the various
        data from the simulation run.
Sean Leavey's avatar
Sean Leavey committed
806
        printout=1 prints the Finesse banner
807
        printerr shows the Finesse progress (set kat.verbose=1 to see warnings and errors)
Daniel Brown's avatar
Daniel Brown committed
808
809
810
811
812
813
814
815
816
817
818
819
        """
        start = datetime.datetime.now()
        
        try:        
            if not hasattr(self, "xaxis") and self.noxaxis != None and self.noxaxis == False:
                raise pkex.BasePyKatException("No xaxis was defined")
            
            if len(self.__katdir) == 0:
                # Get the environment variable for where Finesse is stored
                self.__finesse_dir = os.environ.get('FINESSE_DIR')
                
                if self.__finesse_dir == None :
820
                    raise pkex.MissingFinesseEnvVar()
Daniel Brown's avatar
Daniel Brown committed
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
            else:
                self.__finesse_dir = self.__katdir
                
            if len(self.__katname) == 0:
                katexe = "kat"
                
                if os.sys.platform == "win32":
                    katexe += ".exe"
            else:
                katexe = self.__katname
            
            kat_exec = os.path.join(self.__finesse_dir, katexe) 
            
            # check if kat file exists and it is executable by user        
            if not (os.path.isfile(kat_exec) and os.access(kat_exec, os.X_OK)):
836
                raise pkex.MissingFinesse()
Daniel Brown's avatar
Daniel Brown committed
837
838
839
840
                
            if self.verbose: print "--------------------------------------------------------------"
            if self.verbose: print "Running kat - Started at " + str(start)
            
841
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
842
843
844
845
                r = katRun2D()
            else:
                r = katRun()
                
846
            r.yaxis = self.yaxis
Daniel Brown's avatar
Daniel Brown committed
847
            r.katScript = "".join(self.generateKatScript())   
848
849
850
851
852
853
854
855

            if (plot==None):
                # ensure we don't do any plotting. That should be handled
                # by user themselves
                r.katScript+=("gnuterm no\n")
                r.katScript+=("pyterm no\n")
            else:
                r.katScript+=(plot+"\n")
Daniel Brown's avatar
Daniel Brown committed
856
857
858
859
860
861
862
863
864
865
            
            # create a kat file which we will write the script into
            if self.__tempname == None:
                katfile = tempfile.NamedTemporaryFile(suffix=".kat", dir=self.__tempdir)
            else:
                filepath =os.path.join(self.__tempdir, self.__tempname+".kat" )
                katfile = open( filepath, 'w' ) 
                
            katfile.writelines(r.katScript)
            katfile.flush()
866

867
            if printout == 1 or plot != None:
868
869
870
                cmd=[kat_exec]
            else:
                cmd=[kat_exec, '--perl1']
Daniel Brown's avatar
Daniel Brown committed
871
872
873
874
875
876
877
878
879
880
            
            if self.__time_code:
                cmd.append('--perf-timing')

            cmd.append('--no-backspace')
            # set default format so that less repeated numbers are printed to the
            # output file, should speed up running and parsing of output files
            cmd.append('-format=%.15g')

            cmd.append(katfile.name)
881
                            
Daniel Brown's avatar
Daniel Brown committed
882
883
884
            p=subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
            err = ""
            
885
            #if self.verbose: print "Finesse output:"            
Daniel Brown's avatar
Daniel Brown committed
886
            for line in iter(p.stderr.readline, ""):
887
                if len(line) > 0:
888
889
890
891
892
893
894
                    # remove any ANSI commands
                    ansi = re.compile(r'\x1b[^m]*m')
                    line = ansi.sub('', line)
                    
                    # warnings and errors start with an asterisk 
                    # so if verbose show them
                    if line.lstrip().startswith('*'):
Daniel Brown's avatar
Daniel Brown committed
895
                        if self.verbose: sys.stdout.write(line)
896
897
                        
                    elif line.rstrip().endswith('s') and line.contains('%'):
898
899
900
901
902
903
904
                        vals = line.split("-")
                        action = vals[0].strip()
                        prc = vals[1].strip()[:]
                    
                        if printerr == 1:
                            sys.stdout.write("\r{0} {1}".format(action, prc))
                            
Daniel Brown's avatar
Daniel Brown committed
905
906
907
908
909
910
911
912
                    elif line.rstrip().endswith('%'):
                        vals = line.split("-")
                        action = vals[0].strip()
                        prc = vals[1].strip()[:]
                        
                        if printerr == 1:
                            sys.stdout.write("\r{0} {1}".format(action, prc))
                            
913
914
                    else:
                        err += line
915

Daniel Brown's avatar
Daniel Brown committed
916
            
Daniel Brown's avatar
Daniel Brown committed
917
            [out,errpipe] = p.communicate()
918
            
919
920
            if printout == 1: 
                print out
Andreas Freise's avatar
Andreas Freise committed
921
922
            else:
                if printerr == 1: print ""
923

Daniel Brown's avatar
Daniel Brown committed
924
925
926
927
928
929
            # get the version number
            ix = out.find('build ') + 6
            ix2 = out.find(')',ix)
            r.katVersion = out[ix:ix2]
            
            r.runDateTime = datetime.datetime.now()
930
931

            # If Finesse returned an error, just print that and exit!
Daniel Brown's avatar
Daniel Brown committed
932
            if p.returncode != 0:
933
934
                print err
                sys.exit(1) 
Daniel Brown's avatar
Daniel Brown committed
935
            
936
937
            self.__prevrunfilename = katfile.name
            
Daniel Brown's avatar
Daniel Brown committed
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
            root = os.path.splitext(katfile.name)
            base = os.path.basename(root[0])            
            outfile = root[0] + ".out"
            
            if save_output:        
                newoutfile = "{0}.out".format(base)
                
                cwd = os.path.os.getcwd()
                newoutfile = os.path.join(cwd,newoutfile)
                
                if os.path.isfile(newoutfile):
                    os.remove(newoutfile)
                    
                os.rename(outfile, newoutfile)

                if self.verbose: print "\nOutput data saved to '{0}'".format(newoutfile)
            
955
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
956
957
958
959
960
                [r.x,r.y,r.z,hdr] = self.readOutFile(outfile)
                
                r.xlabel = hdr[0]
                r.ylabel = hdr[1]
                r.zlabels = map(str.strip, hdr[2:])
961
                         
Daniel Brown's avatar
Daniel Brown committed
962
963
964
965
966
            else:
                [r.x,r.y,hdr] = self.readOutFile(outfile)
            
                r.xlabel = hdr[0]
                r.ylabels = map(str.strip, hdr[1:])
967
                    
Daniel Brown's avatar
Daniel Brown committed
968
969
970
971
972
973
974
975
976
977
978
979
980
981
            if save_kat:
                if kat_name == None:
                    kat_name = "pykat_output"                
                
                cwd = os.path.os.getcwd()
                newkatfile = os.path.join(cwd, kat_name + ".kat")
                
                if os.path.isfile(newkatfile):
                    os.remove(newkatfile)
                  
                os.rename(katfile.name, newkatfile)         
                
                if self.verbose: print "Kat file saved to '{0}'".format(newkatfile)
                
Sean Leavey's avatar
Sean Leavey committed
982
983
984
985
986
987
988
989
            if self.trace != None and self.trace > 0:
                #print "{0}".format(out)
                #if self.trace & 1:
                    #search = out.find(' --- highest order of TEM modes')
                    #if search > -1:
                        #print "Trace 1: {0}".format(out[search:])

                # for now, just try to print the trace block in full
Sean Leavey's avatar
Bug fix    
Sean Leavey committed
990
                print out[out.find(' ---') :]
Daniel Brown's avatar
Daniel Brown committed
991
992
993
994
995
996
997
998

            katfile.close()
            perfData = []
            
            if self.__time_code:
                perffile = open(root[0] + ".perf",'r')
                
                for l in perffile.readlines():
999
                    vals = l.strip().split()
Daniel Brown's avatar
Daniel Brown committed
1000
1001
1002
1003
1004
                    perfData.append((vals[0], float(vals[1]), float(vals[2]), float(vals[3])))
                    
                return [r, perfData]
            else:
                return r
1005
1006
            
        except pkex.FinesseRunError as fe:
Daniel Brown's avatar
Daniel Brown committed
1007
1008
1009
1010
1011
            print fe
        finally:
            if self.verbose: print ""
            if self.verbose: print "Finished in " + str(datetime.datetime.now()-start)
            
1012
1013
1014
1015
1016
1017
    def remove(self, obj):
        if not (obj.name in self.__components or obj.name in self.__detectors or obj.name in self.__commands):
            raise pkex.BasePyKatException("{0} is not currently in the simulation".format(obj.name))
        
        if obj.removed:
            raise pkex.BasePyKatException("{0} has already been removed".format(obj.name))        
Daniel Brown's avatar
Daniel Brown committed
1018
1019

        nodes = None
1020
        
Daniel Brown's avatar
Daniel Brown committed
1021
1022
1023
1024
        # store nodes that this componet is attached to as a reference for gui
        if isinstance(obj, Component):
            nodes = self.nodes.getComponentNodes(obj)

1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
        if isinstance(obj, Component):    
            del self.__components[obj.name]
            self.__del_component(obj)
            self.nodes.removeComponent(obj)
        elif isinstance(obj, Command):    
            del self.__commands[obj.name]
            self.__del_command(obj)
        elif isinstance(obj, Detector):    
            del self.__detectors[obj.name]
            self.__del_detector(obj)
        
        for b in self.__blocks:
            if obj in self.__blocks[b].contents:
                self.__blocks[b].contents.remove(obj)
        
Daniel Brown's avatar
Daniel Brown committed
1040
1041
1042
1043
1044
        if self.pykatgui != None:
            self.pykatgui._onComponentRemoved(obj, nodes)
    
        del nodes
        
1045
1046
        #import gc
        #print gc.get_referrers(obj)
1047
    
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
    def getMatrices(self):
        
        import scipy
        from scipy.sparse import coo_matrix
        
        prev = self.noxaxis
        
        self.noxaxis = True
        self.printmatrix = True
        print "".join(self.generateKatScript())
        self.verbose = True
        self.run(printout=1)
        self.printmatrix = None
        self.noxaxis = prev        
        
        if self.__prevrunfilename == None:
            return None
        else:
            
            Mcarrier = None
            Msignal = None
            
            if os.path.exists("klu_full_matrix_car.dat"):
                M = np.loadtxt("klu_full_matrix_car.dat")
                
                if M.size > 0:
                    row = M[:,0]-1
                    col = M[:,1]-1
                    data = M[:,2] + 1j * M[:,3]
                    N = row.max()+1
                    Mcarrier = coo_matrix((data,(row,col)), shape=(N,N))
                
        
            if os.path.exists("klu_full_matrix_sig.dat"):
                M = np.loadtxt("klu_full_matrix_sig.dat")
                
                if M.size > 0:
                    row = M[:,0]-1
                    col = M[:,1]-1
                    data = M[:,2] + 1j * M[:,3]
                    N = row.max()+1
                    Msignal = coo_matrix((data,(row,col)), shape=(N,N))
        
            return (Mcarrier, Msignal)

        
1094
1095
    def hasNamedObject(self, name):
        return name in self.__components or name in self.__detectors or name in self.__commands
Daniel Brown's avatar
Daniel Brown committed
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
        
    def add(self, obj):
        try:
            obj.tag = self.__currentTag
            self.__blocks[self.__currentTag].contents.append(obj)
            
            if isinstance(obj, Component):
                
                if obj.name in self.__components :
                    raise pkex.BasePyKatException("A component with name '{0}' has already been added".format([obj.name]))            
                            
                self.__components[obj.name] = obj
                self.__add_component(obj)
                
            elif isinstance(obj, Detector):
                
                if obj.name in self.__detectors :
                        raise pkex.BasePyKatException("A detector '{0}' has already been added".format(obj.name))
                        
                self.__detectors[obj.name] = obj
                self.__add_detector(obj)
                
            elif isinstance(obj, Command):
                
                self.__commands[obj.__class__.__name__] = obj
                self.__add_command(obj)
                
1123
            else:
Daniel Brown's avatar
Daniel Brown committed
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
                raise pkex.BasePyKatException("Object {0} could not be added".format(obj))
                
            obj._on_kat_add(self)
            
        except pkex.BasePyKatException as ex:
            print ex

    def readOutFile(self, filename):
        
        with open(filename,'r') as outfile:
            # read first to lines to get to header line
            outfile.readline()
            outfile.readline()
            
            hdr = outfile.readline().replace('%','').replace('\n','').split(',')
        
1140
1141
1142
1143
1144
1145
        data = np.loadtxt(filename, comments='%',skiprows=4)

        # convert 1D arrays into 2D ones for simpler selection
        if len(data.shape) == 1:
            data = np.array([data])
                            
1146
        if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
            # need to parse 2D outputs slightly different as they are effectively 2D matrices
            # written in linear form
            x = data[0::(1+self.x2axis.steps),0]
            y = data[0:(1+self.x2axis.steps),1]
            # get rows and columns lined up so that we can reshape a single column of all x/y data
            # into a matrix
            z = data[:,2:].transpose().reshape(data.shape[1]-2, 1+self.xaxis.steps, 1+self.x2axis.steps)
            # once you do this the data for y and x axes need swapping
            z = z.swapaxes(1,2)
            return [x, y, z, hdr]
        else:
            shape_len = len(data.shape)
            
1160
            rows,cols = data.shape
Daniel Brown's avatar
Daniel Brown committed
1161
            
1162
1163
1164
            x = data[:,0]
            y = data[:,1:cols]
        
Daniel Brown's avatar
Daniel Brown committed
1165
            return [x, y, hdr]
1166
1167
1168
1169
1170
1171
1172
1173
1174

    def removeLine(self, fragment) :
        for key in self.__blocks:
            objs = self.__blocks[key].contents
            for obj in objs:
                if isinstance(obj, str):
                    if fragment in obj:
                        print "  ** removing line '{0}'".format(obj)
                        objs.remove(obj)
1175
1176

                    
Daniel Brown's avatar
Daniel Brown committed
1177
1178
    def generateKatScript(self) :
        """ Generates the kat file which can then be run """
1179

1180
        def writeBlock():
Daniel Brown's avatar
Daniel Brown committed
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
            for obj in objs:
                if isinstance(obj, str):
                    out.append(obj + '\n')
                    
                elif isinstance(obj, Component) or isinstance(obj, Detector) or isinstance(obj, Command):
                    txt = obj.getFinesseText() 
                    
                    if txt != None:
                        if isinstance(txt,list):
                            for t in txt:
                                out.append(t + "\n")
                        else:
                            out.append(txt + "\n")
1194

1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
        
        out = []    
        import datetime
        strtoday = datetime.datetime.now()
        out.append(strtoday.strftime("%% Generated by PyKat %d.%m.%Y %H:%M:%S\n") )

        # write the FTblocks
        for key in self.__blocks:
            objs = self.__blocks[key].contents

1205
            if key != NO_BLOCK:
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
                if np.size(objs)>0:
                    out.append("\n")
                    out.append("%%% FTblock " + key + "\n")
                    writeBlock()
                    out.append("%%% FTend " + key + "\n")

        # write the NO_BLOCK blocks
        for key in self.__blocks:
            objs = self.__blocks[key].contents


            if key == NO_BLOCK:
                if np.size(objs)>0:
                    out.append("\n")
                    writeBlock()
                
Daniel Brown's avatar
Daniel Brown committed
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
        # now loop through all the nodes and get any gauss commands
        for key in self.nodes.getNodes():
            txt = self.nodes.getNodes()[key].getFinesseText()
            
            if txt != None:
                if isinstance(txt,list):
                    for t in txt: out.append(t+ "\n")
                else:
                    out.append(txt + "\n")
        
1232

1233
1234
1235
1236
1237
1238
1239
1240
1241
        # now get any signal commands
        txt = self.signals.getFinesseText()
        
        if txt != None:
            if isinstance(txt,list):
                for t in txt: out.append(t+ "\n")
            else:
                out.append(txt + "\n")

1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
        if self.vacuum != None:
            
            if isinstance(self.vacuum, collections.Container):
                objs = []
                
                if len(self.vacuum) > 0:
                    for a in self.vacuum:
                        if hasattr(a, 'name'):
                            objs.append(a.name)
                        else:
                            objs.append(str(a))

                    out.append("vacuum {0}\n".format(" ".join(objs)))
                                        
            elif isinstance(self.vacuum, str):
                out.append("vacuum {0}\n".format(self.vacuum))
            else:
                pkex.BasePyKatException("Couldn't understand vacuum input list")

1261
        if self.scale != None and self.scale !='': out.append("scale {0}\n".format(self.scale))
Daniel Brown's avatar
Daniel Brown committed
1262
        if self.phase != None: out.append("phase {0}\n".format(self.phase))
Sean Leavey's avatar
Sean Leavey committed
1263
        if self.trace != None: out.append("trace {0}\n".format(self.trace))
1264
1265
1266
1267
1268
        if self.maxtem != None:
                if self.maxtem == -1:
                        out.append("maxtem off\n")
                else:
                        out.append("maxtem {0}\n".format(self.maxtem))
Daniel Brown's avatar
Daniel Brown committed
1269

1270
1271
        if self.noxaxis == True:
            out.append("noxaxis\n")
1272
            
1273
1274
        if self.yaxis != None:
            out.append("yaxis {0}\n".format(self.yaxis))
1275
1276
1277
1278
         
        if self.printmatrix != None and self.printmatrix == True:
            out.append("printmatrix\n")
            
Daniel Brown's avatar
Daniel Brown committed
1279
1280
        if self.lambda0 != 1064e-9:
            out.append("lambda {0}\n".format(self.lambda0))
1281
            
Daniel Brown's avatar
Daniel Brown committed
1282
1283
        # ensure we don't do any plotting. That should be handled
        # by user themselves
1284
1285
        #out.append("gnuterm no\n")
        #out.append("pyterm no\n")
Daniel Brown's avatar
Daniel Brown committed
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
        
        return out
        
    def openGUI(self):
        if NO_GUI:
            print  "No PyQt4 module was installed so cannot open a GUI"
        else:
            self.app = QCoreApplication.instance() 
            created = False
            
            if self.app == None:
                created = True
                self.app = QApplication([""])
                
            if self.pykatgui == None:
                self.pykatgui = pyKatGUI(self)
                self.pykatgui.main()
            else:
                self.pykatgui.show()
                
            if created: self.app.exec_()
    
    def getComponents(self):
        return self<