finesse.py 71.7 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
from __future__ import print_function
Daniel Brown's avatar
Daniel Brown committed
27
28
29
30
31
32
import sys
import os
import subprocess
import tempfile
import numpy as np
import datetime
Daniel Brown's avatar
Daniel Brown committed
33
import time
Daniel Brown's avatar
Daniel Brown committed
34
35
36
import pickle
import pykat
import warnings
37
import re   
Daniel Brown's avatar
Daniel Brown committed
38
import itertools
Daniel Brown's avatar
Daniel Brown committed
39
import ctypes
Daniel Brown's avatar
Daniel Brown committed
40
import ctypes.util
Daniel Brown's avatar
Daniel Brown committed
41
import collections
42
import re
43
import copy
44

45
from math import erfc, pi
46

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

import pykat.exceptions as pkex

Daniel Brown's avatar
Daniel Brown committed
57
from pykat import USE_GUI, HAS_OPTIVIS, NoGUIException
58

Daniel Brown's avatar
Daniel Brown committed
59
60
61
62
63
if HAS_OPTIVIS:
    from optivis.bench.labels import Label as optivis_label
    from optivis.geometry import Coordinates as optivis_coord
    import PyQt4
    
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
160
161

def GUILength(L):
    """
162
    Should scale the lengths in some way to handle km and mm for time being
163
    """                                  
Daniel Brown's avatar
Daniel Brown committed
164
    return L # * ( 40 * erfc(L/400.0) + 0.01)
165
    
Daniel Brown's avatar
Daniel Brown committed
166
167
class katRun(object):
    def __init__(self):
Daniel Brown's avatar
Daniel Brown committed
168
169
        self.runtime = None
        self.StartDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
170
171
172
173
174
175
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
176
        self.yaxis = None
177
        
Daniel Brown's avatar
Daniel Brown committed
178
    def plot(self, logy=False):
179
180
181
        import pylab
        
        pylab.plot(self.x, self.y)
Daniel Brown's avatar
Daniel Brown committed
182
183
            
        pylab.legend(self.ylabels, 0)
184
185
        pylab.xlabel(self.xlabel)
        pylab.show()
Daniel Brown's avatar
Daniel Brown committed
186
        
187
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
188
189
190
191
192
193
194
195
196
197
198
        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):
199
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
200
201
        out = None
        
202
        if len(idx) > 0:
203
204
205
206
207
208
209
            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":
210
                    out = self.y[:, idx[0]] * np.exp(1j*pi*self.y[:, idx[1]]/180.0)
211
212
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
213
            
214
215
216
            if out == None:
                out = self.y[:, idx]
            
217
            if out.size == 1:
218
                return out[0].squeeze()
219
            else:
220
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
221
        else:
222
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
223
224
225
      
class katRun2D(object):
    def __init__(self):
Daniel Brown's avatar
Daniel Brown committed
226
227
        self.runtime
        self.startDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
        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)
    
246
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
247
248
    
    def __getitem__(self, value):
249
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
250
251
252
253
254
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
255
    
256
        
257
258
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
259
        def __init__(self, param, name, amplitude, phase, signal):
260
261
262
263
264
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
265
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
266
267
            self.__signal = signal
			
268
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
269
            # various parameter names of the components, e.g. mirror xbeta is x 
270
271
272
            # 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:
273
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
274
275
276
            
        def _register_param(self, param):
            self._params.append(param)
277
278
279
        
        @property
        def removed(self): return self.__removed
280
  
281
        def remove(self):
282
283
284
            self.__signal._kat.remove(self)
            
        def _on_remove(self):
285
286
287
            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
288
289
                self.__signal.targets.remove(self)
                self.__remove = True
290
        
291
292
293
294
295
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
296
297
298
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

299
300
301

        @property
        def phase(self): return self.__phase
302
303
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
304
305
306
307
308

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

        @property
309
        def owner(self): return self.__target._owner().name
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
    
        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:
326
            return "fsignal"
327
328
        else:
            return self.targets[0].name
329
330
            
    @property
Daniel Brown's avatar
Daniel Brown committed
331
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
332

333
334
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
335
            t.remove()
336
337
338
        
        del self.targets[:]
        
339
340
    @property
    def f(self): return self.__f
341
342
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
343
    
Daniel Brown's avatar
Daniel Brown committed
344
    def __init__(self, kat):
345
346
347
        self.targets = []
        self._params = []
        self.__f = Param("f", self, 1)
348
349
        self._kat = kat
        
350
351
352
353
354
355
356
357
358
    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:
359
            name = "sig_" + target._owner().name + "_" + target.name
360
        
Daniel Brown's avatar
Daniel Brown committed
361
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
362
363
364
365
366
367
        
    def getFinesseText(self):
        rtn = []
        
        for t in self.targets:
            rtn.extend(t.getFinesseText())
Daniel Brown's avatar
Daniel Brown committed
368
369
370
371
372
373
374
375
376
            
            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 "")))

377
378
379
380
381
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
382
383
384
385
386
387
388
389
390
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
    
391
392
393
Constant = namedtuple('Constant', 'name, value, usedBy')
    
class kat(object):  
Daniel Brown's avatar
Daniel Brown committed
394
        
395
396
397
398
399
400
401
402
403
404
405
    def __new__(cls, *args, **kwargs):
        # This may seem like an arbitrary step but here we are creating a 
        # new class that is a base class of itself. This is because when
        # the kat object adds new components it also adds properties for
        # each of these. There properties are unique to each kat object,
        # but properties are part of the class definition. Thus if two
        # kat objects share the same class definition they also have the
        # same properties regardless of whether they have the actual
        # object added to it. So we create an instance specific class.
        return object.__new__(type(pykat.finesse.kat.__name__, (pykat.finesse.kat,), {}), *args, **kwargs)
        
Daniel Brown's avatar
Daniel Brown committed
406
407
408
409
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
        
        self.scene = None # scene object for GUI
        self.verbose = True
410
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
411
412
413
414
415
416
417
418
419
420
        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
421
        self.__signals = Signals(self)
422
        self.constants = {}
423
        self.vacuum = []
424
425
        self.__prevrunfilename = None
        self.printmatrix = None
426
427
428
429
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
430
431
432
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
433
434
        self.retrace = None
        self.deriv_h = None
435
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
436
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
437
438
        self.__phase = None
        self.__maxtem = None
439
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
440
        self.__time_code = None
441
        self.__yaxis = "abs" # default yaxis
442
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
443
444
445
446
447
448
449
450
451
        
        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)
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
			
    def __deepcopy__(self, memo):
        """
        When deep copying a kat object we need to take into account
        the instance specific properties. This is because when
        the kat object adds new components it also adds properties for
        each of these. There properties are unique to each kat object,
        but properties are part of the class definition. Thus if two
        kat objects share the same class definition they also have the
        same properties regardless of whether they have the actual
        object added to it. So we create an instance specific class.
        """
        result = self.__class__.__new__(self.__class__)
        memo[id(self)] = result
        result.__dict__ = copy.deepcopy(self.__dict__, memo)
        
        # Find all properties in class we are copying
        # and deep copy these to the new class instance
        for x in self.__class__.__dict__.items():
            if isinstance(x[1], property):
                setattr(result.__class__, x[0], x[1])
                        
        return result
		
476
477
478
    @property
    def signals(self): return self.__signals

479
480
481
482
483
484
485
486
487
488
489
    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
490
491
492
493
494
495
496
497
498
499
500
    @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

501
502
503
504
505
506
507
508
509
510
    @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
511
512
513
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
514
515
516
517
518
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
519
520
521
522
523
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
524
        
Daniel Brown's avatar
Daniel Brown committed
525
    @property
Daniel Brown's avatar
Daniel Brown committed
526
527
528
    def timeCode(self): return self.__time_code
    @timeCode.setter
    def timeCode(self,value): self.__time_code = bool(value)
Daniel Brown's avatar
Daniel Brown committed
529
    
Daniel Brown's avatar
Daniel Brown committed
530
531
532
533
534
535
536
537
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
Daniel Brown's avatar
Daniel Brown committed
538
539
540
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
541
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
542

543
544
    @staticmethod
    def logo():
545
        print("""                                              ..-
546
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
547
548
549
550
551
552
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
553
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web))
Daniel Brown's avatar
Daniel Brown committed
554
    
555
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
556
        commands=open(katfile).read()
557
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
558
    
559
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
560
        #commands = code.split("\n")
561
        self.parseCommands(code, blocks=blocks)
562
563
564
565
566
567
568
569
570

    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:
571
            values = line.split()
572
573
574
            
            if len(values)>0 and values[0] == 'const':
                
Daniel Brown's avatar
Daniel Brown committed
575
                if len(values) >= 3:
576
577
578
                    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
579
                        constants[str(values[1])] = Constant(values[1], values[2], [])
580
581
582
583
584
585
                else:
                    raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
        
        commands_new = []
        
        for line in commands:
586
            values = line.split()
587
            
588
            if len(values) > 0 and values[0] != 'const':
589
590
591
                # check if we have a var/constant in this line
                if line.find('$') >= 0:
                    for key in constants.keys():
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
                        # 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):
607
608
609
610
611
612
613
614
                            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
615
        
616
    def parseCommands(self, commands, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
617
618
619
        blockComment = False
        
        commands=self.remove_comments(commands)
620
621
        
        commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
622
623
624
625
        
        after_process = [] # list of commands that should be processed after 
                           # objects have been set and created
        
626
        for line in commands:
627
628
629
630
631
632
633
634
635
636
            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
637
                        
638
639
                            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
640
                            
641
642
                            if newTag in self.__blocks:
                                raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
Daniel Brown's avatar
Daniel Brown committed
643
                            
644
645
                            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
646
                        
647
648
                        if values[1] == "FTend":
                            self.__currentTag = NO_BLOCK
Daniel Brown's avatar
Daniel Brown committed
649
                        
650
                        continue
Daniel Brown's avatar
Daniel Brown committed
651

652
653
654
655
656
657
658
                    # 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
659
                
660
661
662
663
664
665
666
                    # 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
667
                
668
669
                    first = line.split(" ",1)[0]
                    obj = None
670
                    
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
                    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)
703
704
                    elif(first[0:2] == "hd"):
                        obj = pykat.detectors.hd.parseFinesseText(line)
705
706
                    elif(first.startswith("qhd")):
                        obj = pykat.detectors.qhd.parseFinesseText(line)
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
                    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))
757
                        else:
758
759
760
                            self.deriv_h = float(v[1])
                    elif(first == "gnuterm" or first == "pyterm"):
                        if self.verbose:
761
                            print("Ignoring Gnuplot/Python terminal command '{0}'".format(line))
Daniel Brown's avatar
Daniel Brown committed
762
763
                    elif(first == "fsig"):
                        after_process.append(line)
764
765
766
                    elif(first == "noplot"):
                        obj = line
                        self.__blocks[self.__currentTag].contents.append(line) 
767
                    else:
768
                        if self.verbose:
769
                            print("Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line))
770
                        
771
772
773
                        obj = line
                        # manually add the line to the block contents
                        self.__blocks[self.__currentTag].contents.append(line) 
Daniel Brown's avatar
Daniel Brown committed
774
                
775
776
777
                    if obj != None and not isinstance(obj, str):
                        if self.hasNamedObject(obj.name):
                            getattr(self, obj.name).remove()
778
                            print("Removed existing object '{0}' of type {1} to add line '{2}'".format(obj.name, obj.__class__, line))
779
                        
780
781
                        self.add(obj)
            except:
782
783
784
                print("--------------------------------------------------------")
                print("Error parsing line: " + line)
                print("--------------------------------------------------------")
785
786
787
                raise
                
                
Daniel Brown's avatar
Daniel Brown committed
788
789
790
        # 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:
791
            first = line.split(" ",1)[0]            
Daniel Brown's avatar
Daniel Brown committed
792
            if first == "gauss" or first == "gauss*" or first == "gauss**":
793
                pykat.commands.gauss.parseFinesseText(line, self)
794
            elif (first == "scale"):
795
                v = line.split()
796
                accepted = ["psd","psd_hf","asd","asd_hf","meter", "ampere", "degs"]
Daniel Brown's avatar
Daniel Brown committed
797
                
798
799
                if len(v) == 3:
                    component_name = v[2]
Daniel Brown's avatar
Daniel Brown committed
800
                    
801
                    if v[1].lower() in accepted:
Daniel Brown's avatar
Daniel Brown committed
802
803
804
805
                        val = v[1]
                    else:
                        try:
                            val = SIfloat(v[1])
806
                        except ValueError as ex:
Daniel Brown's avatar
Daniel Brown committed
807
808
                            raise pkex.BasePyKatException("Line `{0}`:\nAccepted scale values are decimal numbers or %s." % (line,str(accepted)))
                            
809
                    if component_name in self.__detectors :
Daniel Brown's avatar
Daniel Brown committed
810
                        self.__detectors[component_name].scale.append(val)
811
                    else:
812
                        raise pkex.BasePyKatException("scale command `{0}` refers to non-existing output".format(component_name))
813
814
815
816
817
                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])
818
                else:
819
                    raise pkex.BasePyKatException("scale command `{0}` is incorrect.".format(line))
820
            elif (first == "pdtype"):
821
                v = line.split()
822
823
824
                if len(v) == 3:
                    component_name = v[1]
                    if component_name in self.__detectors :
Andreas Freise's avatar
Andreas Freise committed
825
                        self.__detectors[component_name].pdtype = v[2]
826
                    else:
827
                        raise pkex.BasePyKatException("pdtype command `{0}` refers to non-existing detector".format(component_name))
828
                else:
829
                    raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
830
831
            elif(first == "attr"):
                v = line.split()
832

Daniel Brown's avatar
Daniel Brown committed
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
                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)
851
                    
852
853
854
855
            elif(first == "fsig"):
                
                v = line.split()
                
Daniel Brown's avatar
Daniel Brown committed
856
857
858
859
                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))
860
                
Daniel Brown's avatar
Daniel Brown committed
861
862
863
864
865
866
867
868
869
870
                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
Daniel Brown's avatar
Daniel Brown committed
871
872
                    freq = SIfloat(v[3])
                    phase = SIfloat(v[4])
Daniel Brown's avatar
Daniel Brown committed
873
                elif len(v) == 6:
Daniel Brown's avatar
Daniel Brown committed
874
875
876
877
                    if v[3][0].isdigit():
                        freq = SIfloat(v[3])
                        phase = SIfloat(v[4])
                        amp = SIfloat(v[5])
Daniel Brown's avatar
Daniel Brown committed
878
                    else:
Daniel Brown's avatar
Daniel Brown committed
879
880
881
882
                        param = str(v[3])
                        freq = SIfloat(v[4])
                        phase = SIfloat(v[5])
                        
Daniel Brown's avatar
Daniel Brown committed
883
884
                elif len(v) == 7:
                    param = v[3]
Daniel Brown's avatar
Daniel Brown committed
885
886
887
                    freq = SIfloat(v[4])
                    phase = SIfloat(v[5])
                    amp = SIfloat(v[6])
Daniel Brown's avatar
Daniel Brown committed
888
889
                else:
                    raise pkex.BasePyKatException("'{0}' isnot a valid fsig command".format(line))
890
                
Daniel Brown's avatar
Daniel Brown committed
891
                self.signals.f = freq
Daniel Brown's avatar
Daniel Brown committed
892
                self.signals.apply(comp._default_fsig(), amp, phase, name)
893
894
895
896
                
            else:
                raise pkex.BasePyKatException("Haven't handled parsing of '{0}'".format(line))
                    
Daniel Brown's avatar
Daniel Brown committed
897
        self.__currentTag = NO_BLOCK 
898
        
Daniel Brown's avatar
Daniel Brown committed
899
900
901
902
903
904
905
906
907
908
909
910
    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:
911
            print(ex)
Daniel Brown's avatar
Daniel Brown committed
912

Daniel Brown's avatar
Daniel Brown committed
913
            
Daniel Brown's avatar
Daniel Brown committed
914
915
916
917
918
919
920
921
    def getProcess(self, callback, **kwargs):
        """
        """
        
        cmd = "\n".join(self.generateKatScript())
        
        return Process(target=f__lkat_process, args=(callback, cmd, kwargs))
           
Daniel Brown's avatar
Daniel Brown committed
922
    def run(self, printout=0, printerr=0, plot=None, save_output=False, save_kat=False, kat_name=None, cmd_args=None, getTraceData=False):
Daniel Brown's avatar
Daniel Brown committed
923
924
925
926
        """ 
        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
927
        printout=1 prints the Finesse banner
928
        printerr shows the Finesse progress (set kat.verbose=1 to see warnings and errors)
929
930
931
932
933
        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
934
935
936
937
938
        getTraceData (bool) - If true a list of dictionaries is returned along with the
                              output file. Each dictionary is the result of the beam tracing
                              that Finesse performs, the keys are the node names and the values
                              are the x and y beam parameters. If no tracing is done a None
                              is returned.
Daniel Brown's avatar
Daniel Brown committed
939
940
941
942
943
944
945
946
947
948
949
950
        """
        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 :
951
                    raise pkex.MissingFinesseEnvVar()
Daniel Brown's avatar
Daniel Brown committed
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
            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)):
967
                raise pkex.MissingFinesse()
Daniel Brown's avatar
Daniel Brown committed
968
                
969
970
            if self.verbose: print("--------------------------------------------------------------")
            if self.verbose: print("Running kat - Started at " + str(start))
Daniel Brown's avatar
Daniel Brown committed
971
            
972
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
973
974
975
976
                r = katRun2D()
            else:
                r = katRun()
                
977
            r.yaxis = self.yaxis
Daniel Brown's avatar
Daniel Brown committed
978
            r.katScript = "".join(self.generateKatScript())   
Daniel Brown's avatar
Daniel Brown committed
979
980
            r.katScript += "time\n"
            
981
982
983
984
985
986
987
            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
988
989
990
991
992
993
994
995
996
997
            
            # 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()
998

999
            if printout == 1 or plot != None:
1000
                cmd=[kat_exec]