finesse.py 78.4 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
import sys
import os
import subprocess
import tempfile
import numpy as np
import datetime
37
import time
Daniel Brown's avatar
Daniel Brown committed
38
39
40
import pickle
import pykat
import warnings
41
42
import re
import math       
Daniel Brown's avatar
Daniel Brown committed
43
import itertools
Daniel Brown's avatar
Daniel Brown committed
44
import ctypes
Daniel Brown's avatar
Daniel Brown committed
45
import ctypes.util
Daniel Brown's avatar
Daniel Brown committed
46
import collections
47
import re
48
import copy
49

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
try:
    # Python 2
    from itertools import izip_longest
except ImportError:
    # Python 3
    from itertools import zip_longest as izip_longest
"""
try:
    from future_builtins import zip_longest
except ImportError: # not 2.6+ or is 3.x
    try:
        from itertools import izip_longest as zip_longest # < 2.5 or 3.x
    except ImportError:
        print("boom")
        pass
"""
66
67

from math import erfc, pi
68
from collections import namedtuple, OrderedDict
69

Daniel Brown's avatar
Daniel Brown committed
70
from pykat.node_network import NodeNetwork
71
from pykat.detectors import BaseDetector as Detector
Daniel Brown's avatar
Daniel Brown committed
72
73
from pykat.components import Component
from pykat.commands import Command, xaxis
74
from pykat.SIfloat import *
75
from pykat.param import Param, AttrParam
Daniel Brown's avatar
Daniel Brown committed
76

77
78
import pykat.external.six as six

Daniel Brown's avatar
Daniel Brown committed
79
80
import pykat.exceptions as pkex

81
82
83
84
85
86
87
from pykat import USE_GUI, HAS_OPTIVIS, NoGUIException

    
if HAS_OPTIVIS:
    from optivis.bench.labels import Label as optivis_label
    from optivis.geometry import Coordinates as optivis_coord
    import PyQt4
88
89
90
91
92

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
93

Daniel Brown's avatar
Daniel Brown committed
94
95
from multiprocessing import Process, Manager

Daniel Brown's avatar
Daniel Brown committed
96
NO_BLOCK = "NO_BLOCK"
97
98
pykat_web = "www.gwoptics.org/pykat"

Daniel Brown's avatar
Daniel Brown committed
99
100
101
102
103
104
105
# 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
106
107
108
def f__lkat_process(callback, cmd, kwargs):
    """
    """
Daniel Brown's avatar
Daniel Brown committed
109
    
110
    if lkat_location is None:
Daniel Brown's avatar
Daniel Brown committed
111
112
113
        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
114
115
116
117
118
119
120
121
122
123
124
125
126

    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: 
127
        print ("Exception caught in python: ", ex.message)
Daniel Brown's avatar
Daniel Brown committed
128
129
130
    finally:
        # This should always be called no matter what
        lkat._pykat_finish(0)
Daniel Brown's avatar
Daniel Brown committed
131
132


133
def f__lkat_trace_callback(lkat, trace_info, getCavities, getNodes, getSpaces):
Daniel Brown's avatar
Daniel Brown committed
134
135
136
137
138
139
140
141
142
143
144
145
    """
    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()

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
    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
173
174
                                )

175
            trace_info[cav.name] = cav_info
Daniel Brown's avatar
Daniel Brown committed
176

177
178
179
    if getSpaces:
        for s in range(0, inter.num_spaces):
            space = inter.space_list[s]
Daniel Brown's avatar
Daniel Brown committed
180

181
182
            trace_info[space.name] = space_trace(gouyx = space.gouy_x,
                                                 gouyy = space.gouy_y)
Daniel Brown's avatar
Daniel Brown committed
183
                     
184
                                             
185
186
187
188
189
190
def GUILength(L):
    """
    Should scale the lengths in some way to handle km and mm for time being
    """
    return L # * ( 40 * erfc(L/400.0) + 0.01)
            
Daniel Brown's avatar
Daniel Brown committed
191
192
class katRun(object):
    def __init__(self):
193
194
        self.runtime = None
        self.StartDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
195
196
197
198
199
200
        self.x = None
        self.y = None
        self.xlabel = None
        self.ylabels = None
        self.katScript = None
        self.katVersion = None
201
        self.yaxis = None
202
        
203
    def plot(self, logy=False):
204
205
206
        import pylab
        
        pylab.plot(self.x, self.y)
207
        pylab.legend(self.ylabels,0)
208
209
        pylab.xlabel(self.xlabel)
        pylab.show()
Daniel Brown's avatar
Daniel Brown committed
210
        
211
    def savekatRun(self, filename):
Daniel Brown's avatar
Daniel Brown committed
212
213
214
215
216
217
218
219
220
221
222
        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):
223
        idx = [i for i in range(len(self.ylabels)) if self.ylabels[i].split()[0] == str(value)]
224
225
        out = None
        
226
        if len(idx) > 0:
227
            #out = self.y[:, idx]
228
            
229
230
231
232
233
234
235
            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":
236
                    out = self.y[:, idx[0]] * np.exp(1j*math.pi*self.y[:, idx[1]]/180.0)
237
238
                elif self.yaxis == "re:im":
                    out = self.y[:, idx[0]] + 1j*self.y[:, idx[1]]
239

240
            if out is None:
241
242
                out = self.y[:, idx]

243
            if out.size == 1:
244
                return out[0].squeeze()
245
            else:
246
                return out.squeeze()
Daniel Brown's avatar
Daniel Brown committed
247
        else:
248
            raise  pkex.BasePyKatException("No output by the name '{0}' found in the output".format(str(value)))
Daniel Brown's avatar
Daniel Brown committed
249
250
251
      
class katRun2D(object):
    def __init__(self):
252
253
        self.runtime
        self.startDateTime = datetime.datetime.now()
Daniel Brown's avatar
Daniel Brown committed
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
        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)
    
272
    def get(self, value): return self[value].squeeze()
Daniel Brown's avatar
Daniel Brown committed
273
274
    
    def __getitem__(self, value):
275
        idx = [i for i in range(len(self.zlabels)) if self.zlabels[i].split()[0] == str(value)]
Daniel Brown's avatar
Daniel Brown committed
276
277
278
279
280
        
        if len(idx) > 0:
            return self.z[idx].squeeze()
        else:
            raise  pkex.BasePyKatException("No output by the name {0} found".format(str(value)))
281
    
282
        
283
284
class Signals(object):
    class fsig(object):
Daniel Brown's avatar
Daniel Brown committed
285
        def __init__(self, param, name, amplitude, phase, signal):
286
287
288
289
290
            self._params = []
            self.__target = param
            self.__name = name
            self.__amplitude = Param("amp", self, SIfloat(amplitude))
            self.__phase = Param("phase", self, SIfloat(phase))
291
            self.__removed = False
Daniel Brown's avatar
Daniel Brown committed
292
            self.__signal = signal
293
            
294
            # unfortunatenly the target names for fsig are not the same as the
Daniel Brown's avatar
Daniel Brown committed
295
            # various parameter names of the components, e.g. mirror xbeta is x 
296
297
298
            # 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:
299
                raise  pkex.BasePyKatException("Cannot fsig parameter {1} on component {0}".format(str(param._owner().name), param.name))
300
301
302
            
        def _register_param(self, param):
            self._params.append(param)
303
304
305
        
        @property
        def removed(self): return self.__removed
306
  
307
        def remove(self):
308
309
310
            self.__signal._kat.remove(self)
            
        def _on_remove(self):
311
312
313
            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
314
315
                self.__signal.targets.remove(self)
                self.__remove = True
316
        
317
318
319
320
321
        @property
        def name(self): return self.__name

        @property
        def amplitude(self): return self.__amplitude
322
323
324
        @amplitude.setter
        def amplitude(self,value): self.__amplitude.value = SIfloat(value)

325
326
327

        @property
        def phase(self): return self.__phase
328
329
        @phase.setter
        def phase(self,value): self.__phase.value = SIfloat(value)
330
331
332
333
334

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

        @property
335
        def owner(self): return self.__target._owner().name
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
    
        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:
352
            return "fsignal"
353
354
        else:
            return self.targets[0].name
355
356
            
    @property
Daniel Brown's avatar
Daniel Brown committed
357
    def removed(self): return False # we can never remove the Signal object altogethr just the individual fsig targets
358

359
360
    def remove(self):
        for t in self.targets:
Daniel Brown's avatar
Daniel Brown committed
361
            t.remove()
362
363
364
        
        del self.targets[:]
        
365
366
    @property
    def f(self): return self.__f
367
368
    @f.setter
    def f(self,value): self.__f.value = SIfloat(value)
369
    
Daniel Brown's avatar
Daniel Brown committed
370
    def __init__(self, kat):
371
372
373
        self.targets = []
        self._params = []
        self.__f = Param("f", self, 1)
374
375
        self._kat = kat
        
376
377
378
379
380
    def _register_param(self, param):
        self._params.append(param)
        
    def apply(self, target, amplitude, phase, name=None):
        
381
        if target is None:
382
383
            raise  pkex.BasePyKatException("No target was specified for signal to be applied")
        
384
        if name is None:
385
            name = "sig_" + target._owner().name + "_" + target.name
386
        
Daniel Brown's avatar
Daniel Brown committed
387
        self.targets.append(Signals.fsig(target, name, amplitude, phase, self))
388
389
390
391
392
393
        
    def getFinesseText(self):
        rtn = []
        
        for t in self.targets:
            rtn.extend(t.getFinesseText())
Daniel Brown's avatar
Daniel Brown committed
394
395
396
397
398
399
400
401
402
            
            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 "")))

403
404
405
406
407
        for p in self._params:
            rtn.extend(p.getFinesseText())
        
        return rtn
        
Daniel Brown's avatar
Daniel Brown committed
408
409
410
411
412
413
414
415
416
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
    
417
Constant = namedtuple('Constant', 'name, value, usedBy')
418
419
420

id___ = 0

421
class kat(object):  
422

423
424
425
426
427
428
429
430
431
    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.
432
433
434
        global id___
        id___ += 1
        cnew = type(pykat.finesse.kat.__name__ + str("_") + str(id___), (pykat.finesse.kat,), {})
435
436
        return object.__new__(cnew)
    
437
    def __init__(self, kat_file=None, kat_code=None, katdir="", katname="", tempdir=None, tempname=None):
Daniel Brown's avatar
Daniel Brown committed
438
439
        self.scene = None # scene object for GUI
        self.verbose = True
440
        self.__blocks = OrderedDict() # dictionary of blocks that are used
Daniel Brown's avatar
Daniel Brown committed
441
442
443
444
445
446
447
448
449
450
        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
451
        self.__signals = Signals(self)
452
        self.constants = {}
453
        self.vacuum = []
454
455
        self.__prevrunfilename = None
        self.printmatrix = None
456
457
458
459
        
        # initialise default block
        self.__currentTag= NO_BLOCK
        self.__blocks[NO_BLOCK] = Block(NO_BLOCK)
Daniel Brown's avatar
Daniel Brown committed
460
461
462
        
        # Various options for running finesse, typicaly the commands with just 1 input
        # and have no name attached to them.
463
464
        self.retrace = None
        self.deriv_h = None
465
        self.scale = None
Sean Leavey's avatar
Sean Leavey committed
466
        self.__trace = None
Daniel Brown's avatar
Daniel Brown committed
467
468
        self.__phase = None
        self.__maxtem = None
469
        self.__noxaxis = False
Daniel Brown's avatar
Daniel Brown committed
470
        self.__time_code = None
471
        self.__yaxis = "abs" # default yaxis
472
        self.__lambda0 = 1064e-9
Daniel Brown's avatar
Daniel Brown committed
473
474
475
476
477
478
479
480
481
        
        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)
482

483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
    def getAll(self, type):
        """
        Returns a collection of all objects of the type argument that are
        part of this kat object.
        
        Example:
            # returns all cav commands that are present in this kat object
            cavs = kat.getAll(pykat.commands.cavity)
        """
        items = []
        
        for a in (item for item in self.__class__.__dict__):
            b = getattr(self, a)
            
            if isinstance(b, type):
                items.append(b)

        return tuple(items)
        
502
    def __deepcopy__(self, memo):
503
504
505
506
507
508
509
510
511
512
        """
        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.
        """
Daniel Brown's avatar
updates    
Daniel Brown committed
513
        result = self.__class__.__new__(self.__class__.__base__)
514
        memo[id(self)] = result
515
516
517
518
519
520
521
522
523
524
        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])
    
        result.nodes._NodeNetwork__update_nodes_properties()
                
525
526
527
        # Update any weakrefs
        for c in result.components:
            result.components[c]._Component__update_node_setters()
528
        
529
530
        return result
    
531
532
533
    @property
    def signals(self): return self.__signals

534
535
536
537
538
539
540
541
542
543
544
    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
545
546
547
548
549
550
551
552
553
554
555
    @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

556
557
558
559
560
561
562
563
564
565
    @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
566
567
568
    @property
    def maxtem(self): return self.__maxtem
    @maxtem.setter
569
570
571
572
573
    def maxtem(self,value):
        if value == "off":
            self.__maxtem = -1
        else:
            self.__maxtem = int(value)
Daniel Brown's avatar
Daniel Brown committed
574
575
576
577
578
    
    @property
    def phase(self): return self.__phase
    @phase.setter
    def phase(self,value): self.__phase = int(value)
579
        
Daniel Brown's avatar
Daniel Brown committed
580
    @property
581
582
583
    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
584
    
Daniel Brown's avatar
Daniel Brown committed
585
586
587
588
589
590
591
592
    @property
    def components(self):
        return self.__components.copy()
    
    @property
    def detectors(self):
        return self.__detectors.copy()
        
593
594
595
596
    @property
    def commands(self):
        return self.__commands.copy()
        
Daniel Brown's avatar
Daniel Brown committed
597
598
599
    @property
    def noxaxis(self): return self.__noxaxis
    @noxaxis.setter
600
    def noxaxis(self,value): self.__noxaxis = bool(value) 
Daniel Brown's avatar
Daniel Brown committed
601

602
603
    @staticmethod
    def logo():
604
        print ("""                                              ..-
605
    PyKat {0:7}         _                  '(
Daniel Brown's avatar
Daniel Brown committed
606
607
608
609
610
611
                          \\`.|\\.__...-\"\"""-_." )
       ..+-----.._        /  ' `            .-'
   . '            `:      7/* _/._\\    \\   (
  (        '::;;+;;:      `-"' =" /,`"" `) /
  L.        \\`:::a:f            c_/     n_'
  ..`--...___`.  .    ,  
612
   `^-....____:   +.      {1}\n""".format(pykat.__version__, pykat_web))
Daniel Brown's avatar
Daniel Brown committed
613
    
614
    def loadKatFile(self, katfile, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
615
        commands=open(katfile).read()
616
        self.parseCommands(commands, blocks=blocks)
Daniel Brown's avatar
Daniel Brown committed
617
    
618
    def parseKatCode(self, code, blocks=None):
Daniel Brown's avatar
Daniel Brown committed
619
        #commands = code.split("\n")
620
        self.parseCommands(code, blocks=blocks)
621
622
623
624
625
626
627

    def processConstants(self, commands):
        """
        Before fully parsing a bunch of commands firstly any constants or variables
        to be recorded and replaced.
        """
        
Daniel Brown's avatar
Daniel Brown committed
628
629
630
631
632
        try:
            constants = self.constants
        
            for line in commands:
                values = line.split()
633
            
Daniel Brown's avatar
Daniel Brown committed
634
                if len(values)>0 and values[0] == 'const':
635
                
Daniel Brown's avatar
Daniel Brown committed
636
637
638
639
640
                    if len(values) >= 3:
                        if values[1] in constants:
                            raise pkex.BasePyKatException('const command with the name "{0}" already used'.format(values[1]))
                        else:
                            constants[str(values[1])] = Constant(values[1], values[2], [])
641
                    else:
Daniel Brown's avatar
Daniel Brown committed
642
                        raise pkex.BasePyKatException('const command "{0}" was not the correct format'.format(line))
643
        
Daniel Brown's avatar
Daniel Brown committed
644
            commands_new = []
645
        
Daniel Brown's avatar
Daniel Brown committed
646
647
            for line in commands:
                values = line.split()
648
            
Daniel Brown's avatar
Daniel Brown committed
649
650
651
652
653
                if len(values) > 0 and values[0] != 'const':
                    # check if we have a var/constant in this line
                    if line.find('$') >= 0:
                        for key in constants.keys():
                            # TODO: need to fix this for checking mulitple instances of const in a single line
654
                        
Daniel Brown's avatar
Daniel Brown committed
655
                            chars = [' ', '+', '-', '*', '/', ')']
656

Daniel Brown's avatar
Daniel Brown committed
657
658
                            for c in chars:
                                none_found = False
659
                            
Daniel Brown's avatar
Daniel Brown committed
660
661
662
663
664
665
                                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
666
                        
Daniel Brown's avatar
Daniel Brown committed
667
668
669
                            if line.endswith('$'+key):
                                constants[key].usedBy.append(line)
                                line = line.replace('$'+key, str(constants[key].value))
670
                        
Daniel Brown's avatar
Daniel Brown committed
671
                    commands_new.append(line)
672
    
Daniel Brown's avatar
Daniel Brown committed
673
            self.constants = constants
674
        
Daniel Brown's avatar
Daniel Brown committed
675
676
677
678
679
            return commands_new
            
        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error processing constants:", ex)
            sys.exit(1)
680
681
682
683
684
685
686
687
688
689
690
    
    def removeBlock(self, name):
        
        if name not in self.__blocks:
            pkex.PrintError("Error removing block:", pkex.BasePyKatException('Block "{0}" was not found'.format(name)))
            sys.exit(1)
    
        for o in self.__blocks[name].contents:
            self.remove(o)
        
        del self.__blocks[name]
Daniel Brown's avatar
Daniel Brown committed
691
        
692
    def parseCommands(self, commands, blocks=None):
693
694
        try:
            blockComment = False
Daniel Brown's avatar
Daniel Brown committed
695
        
696
            commands=self.remove_comments(commands)
697
        
698
            commands=self.processConstants(commands)
Daniel Brown's avatar
Daniel Brown committed
699
        
700
701
            after_process = [] # list of commands that should be processed after 
                               # objects have been set and created
Daniel Brown's avatar
Daniel Brown committed
702
        
703
            for line in commands:
704
705
706
707
708
                if len(line.strip()) >= 2:
                    line = line.strip()

                    # Looking for block start or end
                    values = line.split()
709
            
710
711
712
                    if values[0] == "%%%":
                        if values[1] == "FTblock":
                            newTag = values[2]
713
                    
714
715
                            if self.__currentTag != None and self.__currentTag != NO_BLOCK: 
                                warnings.warn("found block {0} before block {1} ended".format(newTag, self.__currentTag))    
716
                        
717
718
                            if newTag in self.__blocks:
                                raise pkex.BasePyKatException("Block `{0}` has already been read".format(newTag))
719
                        
720
721
                            self.__blocks[newTag] = Block(newTag) # create new list to store all references to components in block
                            self.__currentTag = newTag
722
                    
723
724
                        if values[1] == "FTend":
                            self.__currentTag = NO_BLOCK
725
                    
726
                        continue
Daniel Brown's avatar
Daniel Brown committed
727

728
729
730
                    # only include listed blocks, if we have specfied them
                    if blocks != None and self.__currentTag not in blocks:
                        continue
731
                
732
733
734
                    # don't read comment lines
                    if line[0] == "#" or line[0] == "%":
                        continue
735
            
736
737
738
739
740
741
742
                    # 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
743
            
744
745
                    first = line.split(" ",1)[0]
                    obj = None
746

747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
                    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)
779
780
                    elif(first[0:2] == "hd"):
                        obj = pykat.detectors.hd.parseFinesseText(line)
781
782
                    elif(first.startswith("qhd")):
                        obj = pykat.detectors.qhd.parseFinesseText(line)
783
784
785
                    elif(first == "x2axis" or first == "x2axis*"):
                        obj = pykat.commands.x2axis.parseFinesseText(line)
                    elif(first == "gauss" or first == "gauss*" or first == "gauss**"):
786
                        after_process.append((line, self.__currentTag))
787
                    elif(first == "scale"):
788
                        after_process.append((line, self.__currentTag))
789
                    elif(first == "pdtype"):
790
                        after_process.append((line, self.__currentTag))
791
                    elif(first == "cav"):
792
793
794
795
796
797
798
                        after_process.append((line, self.__currentTag))
                    elif(first == "func"):
                        after_process.append((line, self.__currentTag))
                    elif(first == "variable"):
                        after_process.append((line, self.__currentTag))
                    elif(first == "lock"):
                        after_process.append((line, self.__currentTag))
799
                    elif(first == "attr"):
800
                        after_process.append((line, self.__currentTag))
801
802
803
804
805
806
807
                    elif(first == "noxaxis"):
                        self.noxaxis = True
                    elif(first == "lambda"):
                        v = line.split()
                        self.lambda0 = SIfloat(v[-1])
                    elif(first == "yaxis"):
                        v = line.split()
808
                
809
810
811
812
813
814
815
816
817
818
819
820
821
                        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":
822
                                self.maxtem = -1
823
                            else:
824
                                self.maxtem = int(v[1])
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
                    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))
841
                        else:
842
843
844
                            self.deriv_h = float(v[1])
                    elif(first == "gnuterm" or first == "pyterm"):
                        if self.verbose:
845
                            print ("Ignoring Gnuplot/Python terminal command '{0}'".format(line))
Daniel Brown's avatar
Daniel Brown committed
846
                    elif(first == "fsig"):
847
                        after_process.append((line, self.__currentTag))
848
849
                    elif(first == "noplot"):
                        obj = line
850
                        #self.__blocks[self.__currentTag].contents.append(line) 
851
                    else:
852
                        if self.verbose:
853
                            print ("Parsing `{0}` into pykat object not implemented yet, added as extra line.".format(line))
854
                    
855
856
857
                        obj = line
                        # manually add the line to the block contents
                        self.__blocks[self.__currentTag].contents.append(line) 
858
            
859
                    if obj != None and not isinstance(obj, six.string_types):
860
861
                        if self.hasNamedObject(obj.name):
                            getattr(self, obj.name).remove()
862
                            print ("Removed existing object '{0}' of type {1} to add line '{2}'".format(obj.name, obj.__class__, line))
863
                    
864
                        self.add(obj, block=self.__currentTag)
865
866
                
                
867
868
            # now process all the varous gauss/attr etc. commands which require
            # components to exist first before they can be processed
869
870
            for item in after_process:
                line = item[0]
871
                first = line.split(" ",1)[0] 
872
873
                block = item[1]
                
874
875
                if first == "gauss" or first == "gauss*" or first == "gauss**":
                    pykat.commands.gauss.parseFinesseText(line, self)
876
877
                    
                elif (first == "cav"):
878
879
880
881
882
883
884
885
886
887
                    self.add(pykat.commands.cavity.parseFinesseText(line, self), block=block)
                    
                elif (first == "lock"):
                    self.add(pykat.commands.lock.parseFinesseText(line, self), block=block)
                    
                elif (first == "func"):
                    self.add(pykat.commands.func.parseFinesseText(line, self), block=block)
                    
                elif (first == "variable"):
                    self.add(pykat.commands.variable.parseFinesseText(line, self), block=block)
888
                    
889
890
891
                elif (first == "scale"):
                    v = line.split()
                    accepted = ["psd","psd_hf","asd","asd_hf","meter", "ampere", "degs"]
Daniel Brown's avatar
Daniel Brown committed
892
                
893
894
                    if len(v) == 3:
                        component_name = v[2]
Daniel Brown's avatar
Daniel Brown committed
895
                    
896
897
898
899
900
901
902
                        if v[1].lower() in accepted:
                            val = v[1]
                        else:
                            try:
                                val = SIfloat(v[1])
                            except ValueError as ex:
                                raise pkex.BasePyKatException("Line `{0}`:\nAccepted scale values are decimal numbers or %s." % (line,str(accepted)))
Daniel Brown's avatar
Daniel Brown committed
903
                            
904
905
906
907
908
909
910
911
912
                        if component_name in self.__detectors :
                            self.__detectors[component_name].scale.append(val)
                        else:
                            raise pkex.BasePyKatException("scale command `{0}` refers to non-existing output".format(component_name))
                    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])
913
                    else:
914
915
916
917
918
919
920
921
922
                        raise pkex.BasePyKatException("scale command `{0}` is incorrect.".format(line))
                elif (first == "pdtype"):
                    v = line.split()
                    if len(v) == 3:
                        component_name = v[1]
                        if component_name in self.__detectors :
                            self.__detectors[component_name].pdtype = v[2]
                        else:
                            raise pkex.BasePyKatException("pdtype command `{0}` refers to non-existing detector".format(component_name))
923
                    else:
924
925
926
                        raise pkex.BasePyKatException("pdtype command `{0}` is incorrect.".format(line))
                elif(first == "attr"):
                    v = line.split()
927

928
929
                    if len(v) < 4:
                        raise pkex.BasePyKatException("attr command `{0}` is incorrect.".format(line))
Daniel Brown's avatar
Daniel Brown committed
930
                    else:
931
932
933
934
935
936
937
                        # 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))
Daniel Brown's avatar
Daniel Brown committed
938
                
939
940
                        if len(v[2:]) % 2 == 1:
                            raise pkex.BasePyKatException("Attr command '{0}' must specify both parameter and value pairs".format(line))
Daniel Brown's avatar
Daniel Brown committed
941
                                                
942
943
944
                        # convert split list to key value pairs
                        #kv = dict(itertools.izip_longest(*[iter(v[2:])] * 2, fillvalue=None))
                        kv = dict(izip_longest(*[iter(v[2:])] * 2, fillvalue=None))
Daniel Brown's avatar
Daniel Brown committed
945

946
                        comp.parseAttributes(kv)
947
                    
948
                elif(first == "fsig"):
949
                
950
                    v = line.split()
951
                
952
                    name = str(v[1])
Daniel Brown's avatar
Daniel Brown committed
953
                
954
955
                    if v[2] not in self.__components:
                        raise pkex.BasePyKatException("Could not find the component '{0}'. Line: '{1}'".format(v[2], line))
956
                
957
                    comp = self.__components[v[2]]
Daniel Brown's avatar
Daniel Brown committed
958
                
959
                    if comp._default_fsig() is None:
960
                        raise pkex.BasePyKatException("Component '{0}' cannot be fsig'd. Line: '{1}'".format(comp.name, line))
Daniel Brown's avatar
Daniel Brown committed
961
                    
962
963
                    param = None
                    amp = None
Daniel Brown's avatar
Daniel Brown committed
964
                
965
                    if len(v) == 5:
966
                        param is None
967
968
                        freq = float(v[3])
                        phase = float(v[4])
969
970
971
972
973
974
975
976
977
978
                    elif len(v) == 6:
                        if v[3].isdigit():
                            freq = float(v[3])
                            phase = float(v[4])
                            amp = float(v[5])
                        else:
                            param = v[3]
                            freq = float(v[4])
                            phase = float(v[5])
                    elif len(v) == 7:
979
980
981
                        param = v[3]
                        freq = float(v[4])
                        phase = float(v[5])
982
983
984
                        amp = float(v[6])
                    else:
                        raise pkex.BasePyKatException("'{0}' isnot a valid fsig command".format(line))
985
986
                    
                    self.signals.f = freq
987
                    self.signals.apply(comp._default_fsig(), amp, phase, name)
988
                
989
990
                else:
                    raise pkex.BasePyKatException("Haven't handled parsing of '{0}'".format(line))
991
                    
992
            self.__currentTag = NO_BLOCK 
993
        
994
995
996
997
998

        except pkex.BasePyKatException as ex:
            pkex.PrintError("Error parsing line: '%s':"%  line, ex)
            sys.exit(1)
            
Daniel Brown's avatar
Daniel Brown committed
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
    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:
1011
            print (ex)
Daniel Brown's avatar
Daniel Brown committed
1012

Daniel Brown's avatar
Daniel Brown committed
1013
            
Daniel Brown's avatar
Daniel Brown committed
1014
1015
1016
1017
1018
1019
1020
    def getProcess(self, callback, **kwargs):
        """
        """
        
        cmd = "\n".join(self.generateKatScript())
        
        return Process(target=f__lkat_process, args=(callback, cmd, kwargs))
1021
1022

    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
1023
1024
1025
1026
        """ 
        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
1027
        printout=1 prints the Finesse banner
1028
        printerr shows the Finesse progress (set kat.verbose=1 to see warnings and errors)
1029
1030
1031
1032
1033
        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
1034
1035
1036
1037
1038
        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
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
        """
        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')
                
1050
                if self.__finesse_dir is None :
1051
                    raise pkex.MissingFinesseEnvVar()
Daniel Brown's avatar
Daniel Brown committed
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
            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)):
1067
                raise pkex.MissingFinesse()
Daniel Brown's avatar
Daniel Brown committed
1068
                
1069
1070
            if self.verbose: print ("--------------------------------------------------------------")
            if self.verbose: print ("Running kat - Started at " + str(start))
Daniel Brown's avatar
Daniel Brown committed
1071
            
1072
            if hasattr(self, "x2axis") and self.noxaxis == False:
Daniel Brown's avatar
Daniel Brown committed
1073
1074
1075
1076
                r = katRun2D()
            else:
                r = katRun()
                
1077
            r.yaxis = self.yaxis
1078
            
1079
            r.katScript = "".join(self.generateKatScript())
1080
1081
            r.katScript += "time\n"

1082
1083
1084
1085
1086
1087
1088
            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
1089
1090
            
            # create a kat file which we will write the script into
1091
            if self.__tempname is None:
Daniel Brown's avatar
Daniel Brown committed
1092
                katfile = tempfile.NamedTemporaryFile(mode ='w', suffix=".kat", dir=self.__tempdir, delete=False)
Daniel Brown's avatar
Daniel Brown committed
1093
1094
1095
1096
1097
            else:
                filepath =os.path.join(self.__tempdir, self.__tempname+".kat" )
                katfile = open( filepath, 'w' ) 
                
            katfile.writelines(r.katScript)