finesse.py 61.1 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
# -*- 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
"""
26
27
28
29
30
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals

Daniel Brown's avatar
Daniel Brown committed
31
32
33
34
35
36
37
38
39
import sys
import os
import subprocess
import tempfile
import numpy as np
import datetime
import pickle
import pykat
import warnings
40
41
import re
import math       
Daniel Brown's avatar
Daniel Brown committed
42
import itertools
Daniel Brown's avatar
Daniel Brown committed
43
import ctypes
Daniel Brown's avatar
Daniel Brown committed
44
import ctypes.util
Daniel Brown's avatar
Daniel Brown committed
45
import collections
46
import re
47
import copy
48

49
from collections import namedtuple, OrderedDict
50

Daniel Brown's avatar
Daniel Brown committed
51
from pykat.node_network import NodeNetwork
52
from pykat.detectors import BaseDetector as Detector
Daniel Brown's avatar
Daniel Brown committed
53
54
from pykat.components import Component
from pykat.commands import Command, xaxis
55
from pykat.SIfloat import *
56
from pykat.param import Param, AttrParam
Daniel Brown's avatar
Daniel Brown committed
57

58
59
import pykat.external.six as six

Daniel Brown's avatar
Daniel Brown committed
60
61
import pykat.exceptions as pkex

62
from pykat import USE_GUI, NoGUIException
63
64
65
66
67

if USE_GUI:
    from pykat.gui.gui import pyKatGUI
    from PyQt4.QtCore import QCoreApplication
    from PyQt4.QtGui import QApplication
Daniel Brown's avatar
Daniel Brown committed
68

Daniel Brown's avatar
Daniel Brown committed
69
70
from multiprocessing import Process, Manager

Daniel Brown's avatar
Daniel Brown committed
71
NO_BLOCK = "NO_BLOCK"
72
73
pykat_web = "www.gwoptics.org/pykat"

Daniel Brown's avatar
Daniel Brown committed
74
75
76
77
78
79
80
# 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
81
82
83
def f__lkat_process(callback, cmd, kwargs):
    """
    """
Daniel Brown's avatar
Daniel Brown committed
84
85
86
87
88
    
    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
89
90
91
92
93
94
95
96
97
98
99
100
101

    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: 
102
        print ("Exception caught in python: ", ex.message)
Daniel Brown's avatar
Daniel Brown committed
103
104
105
    finally:
        # This should always be called no matter what
        lkat._pykat_finish(0)
Daniel Brown's avatar
Daniel Brown committed
106
107


108
def f__lkat_trace_callback(lkat, trace_info, getCavities, getNodes, getSpaces):
Daniel Brown's avatar
Daniel Brown committed
109
110
111
112
113
114
115
116
117
118
119
120
    """
    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()

121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
    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
148
149
                                )

150
            trace_info[cav.name] = cav_info
Daniel Brown's avatar
Daniel Brown committed
151

152
153
154
    if getSpaces:
        for s in range(0, inter.num_spaces):
            space = inter.space_list[s]
Daniel Brown's avatar
Daniel Brown committed
155

156
157
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
158
                     
159
                                             
Daniel Brown's avatar
Daniel Brown committed
160
161
class katRun(object):
    def __init__(self):
162
        self.runDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
163
164
165
166
167
168
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
169
        self.yaxis = None
170
        
171
    def plot(self):
172
173
174
        import pylab
        
        pylab.plot(self.x, self.y)
175
        pylab.legend(self.ylabels,0)
176
177
        pylab.xlabel(self.xlabel)
        pylab.show()
Daniel Brown's avatar
Daniel Brown committed
178
        
179
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
180
181
182
183
184
185
186
187
188
189
190
        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):
191
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
192

193
        if len(idx) > 0:
194
195
            out = self.y[:, idx]
            
196
197
198
199
200
201
202
            if len(idx) == 1:
                if self.yaxis == "abs:deg":
                    out = self.y[:, idx[0]]
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]]
            else: 
                if self.yaxis == "abs:deg":
203
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
204
205
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
206
            
207
            if out.size == 1:
208
                return out[0].squeeze()
209
            else:
210
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
211
        else:
212
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
213
214
215
      
class katRun2D(object):
    def __init__(self):
216
        self.runDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
        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)
    
235
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
236
237
    
    def __getitem__(self, value):
238
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
239
240
241
242
243
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
244
    
245
        
246
247
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
248
        def __init__(self, param, name, amplitude, phase, signal):
249
250
251
252
253
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
254
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
255
256
            self.__signal = signal
			
257
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
258
            # various parameter names of the components, e.g. mirror xbeta is x 
259
260
261
            # 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:
262
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
263
264
265
            
        def _register_param(self, param):
            self._params.append(param)
266
267
268
        
        @property
        def removed(self): return self.__removed
269
  
270
        def remove(self):
271
272
273
            self.__signal._kat.remove(self)
            
        def _on_remove(self):
274
275
276
            if self.__removed:
                raise pkex.BasePyKatException("Signal {0} has already been marked as removed".format(self.name))
            else:
Daniel Brown's avatar
Daniel Brown committed
277
278
                self.__signal.targets.remove(self)
                self.__remove = True
279
        
280
281
282
283
284
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
285
286
287
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

288
289
290

        @property
        def phase(self): return self.__phase
291
292
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
293
294
295
296
297

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

        @property
298
        def owner(self): return self.__target._owner().name
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
    
        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:
315
            return "fsignal"
316
317
        else:
            return self.targets[0].name
318
319
            
    @property
Daniel Brown's avatar
Daniel Brown committed
320
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
321

322
323
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
324
            t.remove()
325
326
327
        
        del self.targets[:]
        
328
329
    @property
    def f(self): return self.__f
330
331
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
332
    
Daniel Brown's avatar
Daniel Brown committed
333
    def __init__(self, kat):
334
335
336
        self.targets = []
        self._params = []
        self.__f = Param("f", self, 1)
337
338
        self._kat = kat
        
339
340
341
342
343
344
345
346
347
    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:
348
            name = "sig_" + target._owner().name + "_" + target.name
349
        
Daniel Brown's avatar
Daniel Brown committed
350
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
351
352
353
354
355
356
        
    def getFinesseText(self):
        rtn = []
        
        for t in self.targets:
            rtn.extend(t.getFinesseText())
Daniel Brown's avatar
Daniel Brown committed
357
358
359
360
361
362
363
364
365
            
            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 if t.amplitude != None else "")))

366
367
368
369
370
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
371
372
373
374
375
376
377
378
379
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
    
380
381
382
Constant = namedtuple('Constant', 'name, value, usedBy')
    
class kat(object):  
Daniel Brown's avatar
Daniel Brown committed
383
384
        
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
385
386
387

        cls = type(self)
        self.__class__ = type(cls.__name__, (cls,), {})
Daniel Brown's avatar
Daniel Brown committed
388
389
390
        
        self.scene = None # scene object for GUI
        self.verbose = True
391
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
392
393
394
395
396
397
398
399
400
401
        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
Daniel Brown's avatar
Daniel Brown committed
402
        self.__signals = Signals(self)
403
        self.constants = {}
404
        self.vacuum = []
405
406
        self.__prevrunfilename = None
        self.printmatrix = None
407
408
409
410
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
411
412
413
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
414
415
        self.retrace = None
        self.deriv_h = None
416
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
417
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
418
419
        self.__phase = None
        self.__maxtem = None
420
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
421
        self.__time_code = None
422
        self.__yaxis = "abs" # default yaxis
423
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
424
425
426
427
428
429
430
431
432
        
        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)
433

434
435
436
437
438
439
440
441
442
443
444
445
446
447
    def __deepcopy__(self, memo):
        cls = self.__class__
        result = cls.__new__(cls)
        memo[id(self)] = result
        
        for k, v in self.__dict__.items():
            setattr(result, k, copy.deepcopy(v, memo))
        
        # Update any weakrefs
        for c in result.components:
            result.components[c]._Component__update_node_setters()
            
        return result
    
448
449
450
    @property
    def signals(self): return self.__signals

451
452
453
454
455
456
457
458
459
460
461
    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
462
463
464
465
466
467
468
469
470
471
472
    @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

473
474
475
476
477
478
479
480
481
482
    @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
483
484
485
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
486
487
488
489
490
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
491
492
493
494
495
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
496
        
Daniel Brown's avatar
Daniel Brown committed
497
    @property
498
499
500
    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
501
    
Daniel Brown's avatar
Daniel Brown committed
502
503
504
505
506
507
508
509
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
Daniel Brown's avatar
Daniel Brown committed
510
511
512
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
513
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
514

515
516
    @staticmethod
    def logo():
517
        print ("""                                              ..-
518
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
519
520
521
522
523
524
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
525
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web))
Daniel Brown's avatar
Daniel Brown committed
526
    
527
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
528
        commands=open(katfile).read()
529
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
530
    
531
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
532
        #commands = code.split("\n")
533
        self.parseCommands(code, blocks=blocks)
534
535
536
537
538
539
540
541
542

    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:
543
            values = line.split()
544
545
546
            
            if len(values)>0 and values[0] == 'const':
                
Daniel Brown's avatar
Daniel Brown committed
547
                if len(values) >= 3:
548
549
550
                    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
551
                        constants[str(values[1])] = Constant(values[1], values[2], [])
552
553
554
555
556
557
                else:
                    raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
        
        commands_new = []
        
        for line in commands:
558
            values = line.split()
559
            
560
            if len(values) > 0 and values[0] != 'const':
561
562
563
                # check if we have a var/constant in this line
                if line.find('$') >= 0:
                    for key in constants.keys():
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
                        # 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):
579
580
581
582
583
584
585
586
                            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
587
        
588
    def parseCommands(self, commands, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
589
590
591
        blockComment = False
        
        commands=self.remove_comments(commands)
592
593
        
        commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
594
595
596
597
        
        after_process = [] # list of commands that should be processed after 
                           # objects have been set and created
        
598
        for line in commands:
599
600
601
602
603
604
605
606
607
608
            try:
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
                
                    if values[0] == "%%%":
                        if values[1] == "FTblock":
                            newTag = values[2]
Daniel Brown's avatar
Daniel Brown committed
609
                        
610
611
                            if self.__currentTag != None and self.__currentTag != NO_BLOCK: 
                                warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
Daniel Brown's avatar
Daniel Brown committed
612
                            
613
614
                            if newTag in self.__blocks:
                                raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
Daniel Brown's avatar
Daniel Brown committed
615
                            
616
617
                            self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
                            self.__currentTag = newTag
Daniel Brown's avatar
Daniel Brown committed
618
                        
619
620
                        if values[1] == "FTend":
                            self.__currentTag = NO_BLOCK
Daniel Brown's avatar
Daniel Brown committed
621
                        
622
                        continue
Daniel Brown's avatar
Daniel Brown committed
623

624
625
626
627
628
629
630
                    # only include listed blocks, if we have specfied them
                    if blocks != None and self.__currentTag not in blocks:
                        continue
                    
                    # don't read comment lines
                    if line[0] == "#" or line[0] == "%":
                        continue
Daniel Brown's avatar
Daniel Brown committed
631
                
632
633
634
635
636
637
638
                    # 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
Daniel Brown's avatar
Daniel Brown committed
639
                
640
641
                    first = line.split(" ",1)[0]
                    obj = None
642
                    
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
                    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)
                    elif(first == "sq"):
                        obj = pykat.components.squeezer.parseFinesseText(line)
                    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)
                    elif(first[0:2] == "ad"):
                        obj = pykat.detectors.ad.parseFinesseText(line)
                    elif(first[0:2] == "bp"):
                        obj = pykat.detectors.bp.parseFinesseText(line)
                    elif(first[0:4] == "gouy"):
                        obj = pykat.detectors.gouy.parseFinesseText(line)
                    elif(first[0:2] == "pd" and first != "pdtype"):
                        obj = pykat.detectors.pd.parseFinesseText(line)
                    elif(first == "qshot" or first == "qshotS" or first == "qshotN"):
                        obj = pykat.detectors.qshot.parseFinesseText(line)
                    elif(first == "qnoised" or first == "qnoisedS" or first == "qnoisedN"):
                        obj = pykat.detectors.qnoised.parseFinesseText(line)
                    elif(first == "xaxis" or first == "xaxis*"):
                        obj = pykat.commands.xaxis.parseFinesseText(line)
675
676
                    elif(first[0:2] == "hd"):
                        obj = pykat.detectors.hd.parseFinesseText(line)
677
678
                    elif(first.startswith("qhd")):
                        obj = pykat.detectors.qhd.parseFinesseText(line)
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
                    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)
                    elif(first == "scale"):
                        after_process.append(line)
                    elif(first == "pdtype"):
                        after_process.append(line)
                    elif(first == "attr"):
                        after_process.append(line)
                    elif(first == "noxaxis"):
                        self.noxaxis = True
                    elif(first == "lambda"):
                        v = line.split()
                        self.lambda0 = SIfloat(v[-1])
                    elif(first == "yaxis"):
                        v = line.split()
                    
                        self.yaxis = v[-1]
                    elif(first == "phase"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("phase command `{0}` is incorrect.".format(line))
                        else:
                            self.phase = int(v[1])
                    elif(first == "maxtem"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("maxtem command `{0}` is incorrect.".format(line))
                        else:
                            if v[1] == "off":
                            	self.maxtem = -1
                            else:
    	                        self.maxtem = int(v[1])
                    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]
                    elif(first == "retrace"):
                        v = line.split()
                        if len(v) > 2:
                            raise pkex.BasePyKatException("Retrace command `{0}` is incorrect.".format(line))
                        elif len(v) == 2:
                            self.retrace = v[1]                        
                    elif(first == "deriv_h"):
                        v = line.split()
                        if len(v) != 2:
                            raise pkex.BasePyKatException("deriv_h command `{0}` is incorrect.".format(line))
729
                        else:
730
731
732
                            self.deriv_h = float(v[1])
                    elif(first == "gnuterm" or first == "pyterm"):
                        if self.verbose:
733
                            print ("Ignoring Gnuplot/Python terminal command '{0}'".format(line))
Daniel Brown's avatar
Daniel Brown committed
734
735
                    elif(first == "fsig"):
                        after_process.append(line)
736
737
738
                    elif(first == "noplot"):
                        obj = line
                        self.__blocks[self.__currentTag].contents.append(line) 
739
                    else:
740
                        if self.verbose:
741
                            print ("Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line))
742
                        
743
744
745
                        obj = line
                        # manually add the line to the block contents
                        self.__blocks[self.__currentTag].contents.append(line) 
Daniel Brown's avatar
Daniel Brown committed
746
                
747
                    if obj != None and not isinstance(obj, six.string_types):
748
749
                        if self.hasNamedObject(obj.name):
                            getattr(self, obj.name).remove()
750
                            print ("Removed existing object '{0}' of type {1} to add line '{2}'".format(obj.name, obj.__class__, line))
751
                        
752
753
                        self.add(obj)
            except:
754
755
756
                print ("--------------------------------------------------------")
                print ("Error parsing line: " + line)
                print ("--------------------------------------------------------")
757
758
759
                raise
                
                
Daniel Brown's avatar
Daniel Brown committed
760
761
762
        # 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:
763
            first = line.split(" ",1)[0]            
Daniel Brown's avatar
Daniel Brown committed
764
            if first == "gauss" or first == "gauss*" or first == "gauss**":
765
                pykat.commands.gauss.parseFinesseText(line, self)
766
            elif (first == "scale"):
767
                v = line.split()
768
                accepted = ["psd","psd_hf","asd","asd_hf","meter", "ampere", "degs"]
Daniel Brown's avatar
Daniel Brown committed
769
                
770
771
                if len(v) == 3:
                    component_name = v[2]
Daniel Brown's avatar
Daniel Brown committed
772
                    
773
                    if v[1].lower() in accepted:
Daniel Brown's avatar
Daniel Brown committed
774
775
776
777
                        val = v[1]
                    else:
                        try:
                            val = SIfloat(v[1])
778
                        except ValueError as ex:
Daniel Brown's avatar
Daniel Brown committed
779
780
                            raise pkex.BasePyKatException("Line `{0}`:\nAccepted scale values are decimal numbers or %s." % (line,str(accepted)))
                            
781
                    if component_name in self.__detectors :
Daniel Brown's avatar
Daniel Brown committed
782
                        self.__detectors[component_name].scale.append(val)
783
                    else:
784
                        raise pkex.BasePyKatException("scale command `{0}` refers to non-existing output".format(component_name))
785
786
787
788
789
                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])
790
                else:
791
                    raise pkex.BasePyKatException("scale command `{0}` is incorrect.".format(line))
792
            elif (first == "pdtype"):
793
                v = line.split()
794
795
796
                if len(v) == 3:
                    component_name = v[1]
                    if component_name in self.__detectors :
Andreas Freise's avatar
Andreas Freise committed
797
                        self.__detectors[component_name].pdtype = v[2]
798
                    else:
799
                        raise pkex.BasePyKatException("pdtype command `{0}` refers to non-existing detector".format(component_name))
800
                else:
801
                    raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
802
803
            elif(first == "attr"):
                v = line.split()
804

Daniel Brown's avatar
Daniel Brown committed
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
                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)
823
                    
824
825
826
827
            elif(first == "fsig"):
                
                v = line.split()
                
Daniel Brown's avatar
Daniel Brown committed
828
829
830
831
                name = str(v[1])
                
                if v[2] not in self.__components:
                    raise pkex.BasePyKatException("Could not find the component '{0}'. Line: '{1}'".format(v[2], line))
832
                
Daniel Brown's avatar
Daniel Brown committed
833
834
835
836
837
838
839
840
841
842
                comp = self.__components[v[2]]
                
                if comp._default_fsig() == None:
                    raise pkex.BasePyKatException("Component '{0}' cannot be fsig'd. Line: '{1}'".format(comp.name, line))
                    
                param = None
                amp = None
                
                if len(v) == 5:
                    param == None
843
844
                    freq = float(v[3])
                    phase = float(v[4])
Daniel Brown's avatar
Daniel Brown committed
845
                elif len(v) == 6:
846
847
848
849
                    if v[3].isdigit():
                        freq = float(v[3])
                        phase = float(v[4])
                        amp = float(v[5])
Daniel Brown's avatar
Daniel Brown committed
850
                    else:
851
852
853
                        param = v[3]
                        freq = float(v[4])
                        phase = float(v[5])
Daniel Brown's avatar
Daniel Brown committed
854
855
                elif len(v) == 7:
                    param = v[3]
856
857
858
                    freq = float(v[4])
                    phase = float(v[5])
                    amp = float(v[6])
Daniel Brown's avatar
Daniel Brown committed
859
860
                else:
                    raise pkex.BasePyKatException("'{0}' isnot a valid fsig command".format(line))
861
                
Daniel Brown's avatar
Daniel Brown committed
862
                self.signals.apply(comp._default_fsig(), amp, phase, name)
863
864
865
866
                
            else:
                raise pkex.BasePyKatException("Haven't handled parsing of '{0}'".format(line))
                    
Daniel Brown's avatar
Daniel Brown committed
867
        self.__currentTag = NO_BLOCK 
868
        
Daniel Brown's avatar
Daniel Brown committed
869
870
871
872
873
874
875
876
877
878
879
880
    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:
881
            print (ex)
Daniel Brown's avatar
Daniel Brown committed
882

Daniel Brown's avatar
Daniel Brown committed
883
            
Daniel Brown's avatar
Daniel Brown committed
884
885
886
887
888
889
890
891
    def getProcess(self, callback, **kwargs):
        """
        """
        
        cmd = "\n".join(self.generateKatScript())
        
        return Process(target=f__lkat_process, args=(callback, cmd, kwargs))
           
892
    def run(self, printout=0, printerr=0, plot=None, save_output=False, save_kat=False, kat_name=None, cmd_args=None) :
Daniel Brown's avatar
Daniel Brown committed
893
894
895
896
        """ 
        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
897
        printout=1 prints the Finesse banner
898
        printerr shows the Finesse progress (set kat.verbose=1 to see warnings and errors)
899
900
901
902
903
        plot (string) - Sets gnuterm for plotting
        save_output (bool) - if true does not delete out file
        save_kat (bool) - if true does not delete kat file
        kat_name (string) - name of kat file if needed, will be randomly generated otherwise
        cmd_args (list of strings) - command line flags to pass to FINESSE
Daniel Brown's avatar
Daniel Brown committed
904
905
906
907
908
909
910
911
912
913
914
915
        """
        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 :
916
                    raise pkex.MissingFinesseEnvVar()
Daniel Brown's avatar
Daniel Brown committed
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
            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)):
932
                raise pkex.MissingFinesse()
Daniel Brown's avatar
Daniel Brown committed
933
                
934
935
            if self.verbose: print ("--------------------------------------------------------------")
            if self.verbose: print ("Running kat - Started at " + str(start))
Daniel Brown's avatar
Daniel Brown committed
936
            
937
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
938
939
940
941
                r = katRun2D()
            else:
                r = katRun()
                
942
            r.yaxis = self.yaxis
943
944
945
            
            r.katScript = "".join(self.generateKatScript()) 
            
946
947
948
949
950
951
952
            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
953
954
955
956
957
958
959
960
961
962
            
            # 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()
963

964
            if printout == 1 or plot != None:
965
966
967
                cmd=[kat_exec]
            else:
                cmd=[kat_exec, '--perl1']
Daniel Brown's avatar
Daniel Brown committed
968
969
970
            
            if self.__time_code:
                cmd.append('--perf-timing')
971
972
973
974
            
            if cmd_args != None:
                cmd.extend(cmd_args)
                
Daniel Brown's avatar
Daniel Brown committed
975
976
977
978
979
980
            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)
981
                            
Daniel Brown's avatar
Daniel Brown committed
982
983
984
            p=subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
            err = ""
            
985
            #if self.verbose: print "Finesse output:"            
986
987
            for aline in iter(p.stderr.readline, b""):
                line = unicode(aline, "utf-8")
988
                if len(line) > 0:
989
                    # remove any ANSI commands
990
991
992
                    #ansi = re.compile(r'\x1b[^m]*m')
                    #line = ansi.sub('', line)
                    line = re.sub(r'\x1b[^m]*m', '', line, re.UNICODE)
993

994
995
                    # warnings and errors start with an asterisk 
                    # so if verbose show them
996
997
998
                    if line.lstrip().startswith('*PROG*'):
                        line = line[8:-1]
                        vals = line.split("-",1)
999
1000
1001
1002
1003
                        action = vals[0].strip()
                        prc = vals[1].strip()[:]
                    
                        if printerr == 1:
                            sys.stdout.write("\r{0} {1}".format(action, prc))
1004
1005
                    elif line.lstrip().startswith('*'):
                        if self.verbose: sys.stdout.write(line)        
Daniel Brown's avatar
Daniel Brown committed
1006
1007
1008
1009
1010
1011
1012
                    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))
1013
                            
1014
1015
                    else:
                        err += line
1016

Daniel Brown's avatar
Daniel Brown committed
1017
            
Daniel Brown's avatar
Daniel Brown committed
1018
            [out,errpipe] = p.communicate()
1019
            
1020
            if printout == 1: 
1021
                print (out)
Andreas Freise's avatar
Andreas Freise committed
1022
            else:
1023
                if printerr == 1: print ("")
1024

Daniel Brown's avatar
Daniel Brown committed
1025
1026
1027
1028
1029
            # get the version number
            ix = out.find('build ') + 6
            ix2 = out.find(')',ix)
            r.katVersion = out[ix:ix2]
            
1030
1031
            r.runDateTime = datetime.datetime.now()

1032
            # If Finesse returned an error, just print that and exit!
Daniel Brown's avatar
Daniel Brown committed
1033
            if p.returncode != 0:
1034
                print (err)
1035
                sys.exit(1) 
1036
            
1037
1038
            self.__prevrunfilename = katfile.name
            
Daniel Brown's avatar
Daniel Brown committed
1039
            root = os.path.splitext(katfile.name)
1040
            base = os.path.basename(root[0])            
Daniel Brown's avatar
Daniel Brown committed
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
            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)

1054
                if self.verbose: print ("\nOutput data saved to '{0}'".format(newoutfile))
Daniel Brown's avatar
Daniel Brown committed
1055
            
1056
1057
            if hasattr(self, "x2axis") and self.noxaxis == False:
                [r.x,r.y,r.z,hdr] = self.readOutFile(outfile)
Daniel Brown's avatar
Daniel Brown committed
1058
                
1059
1060
                r.xlabel = hdr[0]
                r.ylabel = hdr[1]
1061
                r.zlabels = [s.strip() for s in hdr[2:]]
1062
                #r.zlabels = map(str.strip, hdr[2:])
1063
1064
            else:
                [r.x,r.y,hdr] = self.readOutFile(outfile)
Daniel Brown's avatar
Daniel Brown committed
1065
            
1066
                r.xlabel = hdr[0]
1067
                r.ylabels = [s.strip() for s in hdr[1:]]
1068
                #r.ylabels = map(str.strip, hdr[1:]) // replaced 090415 adf 
1069
                    
Daniel Brown's avatar
Daniel Brown committed
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
            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)         
                
1082
                if self.verbose: print ("Kat file saved to '{0}'".format(newkatfile))
Daniel Brown's avatar
Daniel Brown committed
1083
                
Sean Leavey's avatar
Sean Leavey committed
1084
            if self.trace != None and self.trace > 0:
1085
                #print ("{0}".format(out))
Sean Leavey's avatar
Sean Leavey committed
1086
1087
1088
                #if self.trace & 1:
                    #search = out.find(' --- highest order of TEM modes')
                    #if search > -1:
1089
                        #print ("Trace 1: {0}".format(out[search:]))
Sean Leavey's avatar
Sean Leavey committed
1090
1091

                # for now, just try to print the trace block in full
1092
                print (out[out.find(' ---') :])
Daniel Brown's avatar
Daniel Brown committed
1093
1094
1095
1096
1097
1098
1099
1100

            katfile.close()
            perfData = []
            
            if self.__time_code:
                perffile = open(root[0] + ".perf",'r')
                
                for l in perffile.readlines():
1101
                    vals = l.strip().split()
1102
                    perfData.append((vals[0], float(vals[1]), float(vals[2]), float(vals[3])))
Daniel Brown's avatar
Daniel Brown committed
1103
                    
1104
                return [r, perfData]
Daniel Brown's avatar
Daniel Brown committed
1105
            else:
1106
                return r
1107
1108
            
        except pkex.FinesseRunError as fe:
1109
            print (fe)
Daniel Brown's avatar
Daniel Brown committed
1110
        finally:
1111
1112
            if self.verbose: print ("")
            if self.verbose: print ("Finished in " + str(datetime.datetime.now()-start))
Daniel Brown's avatar
Daniel Brown committed
1113
            
1114
    def remove(self, obj):
Daniel Brown's avatar
Daniel Brown committed
1115
        if not isinstance(obj, pykat.finesse.Signals) and not (obj.name in self.__components  or obj.name in self.__detectors or obj.name in self.__commands or obj in self.signals.targets):
1116
            raise pkex.BasePyKatException("{0} is not currently in the simulation"