initexit.py 26.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
#!/usr/bin/env python
# da_initexit.py

"""
Author : peters 

Revision History:
File created on 13 May 2009.

10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
The CycleControl class is found in the module :mod:`da.tools.initexit`. It is derived from the standard python :class:`dictionary` object. It is the only core object of CTDAS that is automatically created in the pipeline, the user (normally) does not need to modify or extend it. The class is created based on options and arguments passes on the command line when submitting your main CTDAS job. 

Valid options are defined in 

.. autofunction:: da.tools.initexit.ParseOptions

With the name of a valid ``rc-file``, the CycleControl object is instantiated and validated. An example rc-file looks
like this:::

    ! Info on the data assimilation cycle

    time.restart        : False
    time.start          : 2000-01-01 00:00:00
    time.finish         : 2000-01-08 00:00:00
    time.cycle          : 7
    time.nlag           : 2
    dir.da_run          : ${HOME}/tmp/test_da

    ! Info on the DA system used

    da.system           : CarbonTracker
    da.system.rc        : carbontracker.rc
    da.platform         : maunaloa

    ! Info on the forward model to be used

    forecast.model      : TM5
    forecast.model.rc   : ${HOME}/Modeling/TM5/ct_new.rc
    forecast.nmembers   : 2

The most important method of the CycleControl object are listed below:

.. autoclass:: da.tools.initexit.CycleControl 
   :members: Initialize, Finalize, SubmitNextCycle, CleanUpCycle, SetupFileStructure, RecoverRun, RandomSeed

Two important attributes of the CycleControl object are:
    (1) DaSystem, an instance of a :ref:`dasystem`
    (2) DaPlatForm, an instance of a :ref:`platform`

Other functions in the module initexit that are related to the control of a DA cycle are:

.. autofunction:: da.tools.initexit.StartLogger 
.. autofunction:: da.tools.initexit.ValidateOptsArgs 


55
56
57
58
59
60
61
62
"""

needed_da_items=[
    'time.start',
    'time.finish',
    'time.nlag',
    'time.cycle',
    'dir.da_run',
63
    'forecast.nmembers']
64
65
66
67
68
69
70
71
72
73
74
75
76
77

# only needed in an earlier implemented where each substep was a separate job
# validprocesses = ['start','done','samplestate','advance','invert']

import logging
import os
import sys
import shutil
import datetime



class CycleControl(dict):
    """
78
    This object controls the CTDAS system flow and functionality.
79
    """
80
81
        
    def __init__(self,opts=[],args={}):
82
        """
Peters, Wouter's avatar
Peters, Wouter committed
83
84
85
86
        The CycleControl object is instantiated with a set of options and arguments.
        The list of arguments must contain the name of an existing ``rc-file``. 
        This rc-file is loaded by method :meth:`~da.tools.initexit.CycleControl.LoadRc` and validated
        by :meth:`~da.tools.initexit.CycleControl.ValidateRC`
87

Peters, Wouter's avatar
Peters, Wouter committed
88
89
        Options for the CycleControl consist of accepted command line flags or arguments 
        in :func:`~da.tools.initexit.CycleControl.ParseOptions`
90

91
92
93
94
95
96
97
98
99
100
101
102
103
        """

        self.LoadRc(args['rc'])
        self.ValidateRC()
        self.opts = opts

        # Add some useful variables to the rc-file dictionary

        self['jobrcfilename']    = self.RcFileName
        self['dir.da_submit']    = os.getcwd()
        self['da.crash.recover'] = '-r' in opts
        self['verbose']          = '-v' in opts
        self.DaSystem            = None # to be filled later
104
        self.RestartFileList     = [] # List of files needed for restart, to be extended later
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

    def __str__(self):
        """
        String representation of a CycleControl object
        """

        msg = "==============================================================="    ; print msg
        msg = "DA Cycle rc-file is %s" % self.RcFileName                                ; print msg
        msg = "DA Cycle run directory is %s" % self['dir.da_run']           ; print msg
        msg = "DA Cycle inverse system is %s" % self['da.system']           ; print msg
        msg = "DA Cycle forecast model is %s" % self['forecast.model']      ; print msg
        msg = "==============================================================="    ; print msg

        return ""


    def LoadRc(self,RcFileName):
        """ 
        This method loads a DA Cycle rc-file with settings for this simulation 
        """
125
        import da.tools.rc as rc
126
127
128
129
130
131
132
133
134
135
136
137
138
139

        rcdata = rc.read(RcFileName)
        for k,v in rcdata.iteritems():
            self[k] = v
        self.RcFileName     = RcFileName
        self.DaRcLoaded    = True

        msg                 = 'DA Cycle rc-file (%s) loaded successfully'%self.RcFileName ; logging.info(msg)

        return True


    def ValidateRC(self):
        """ 
Peters, Wouter's avatar
Peters, Wouter committed
140
141
        Validate the contents of the rc-file given a dictionary of required keys. 
        Currently required keys are :attr:`~da.tools.initexit.needed_da_items`
142
143
144
145
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
        """
        from da.tools.general import ToDatetime

        for k,v in self.iteritems():
            if v == 'True' : self[k] = True
            if v == 'False': self[k] = False
            if 'date' in k : self[k] = ToDatetime(v)
            if 'time.start' in k : 
                self[k] = ToDatetime(v)
            if 'time.end' in k : 
                self[k] = ToDatetime(v)
            if 'time.finish' in k : 
                self[k] = ToDatetime(v)

        for key in needed_da_items:

            if not self.has_key(key):
                status,msg = ( False,'Missing a required value in rc-file : %s' % key)
                logging.error(msg)
                raise IOError,msg

        status,msg = ( True,'DA Cycle settings have been validated succesfully' )  ; logging.debug(msg)

        return None

    def ParseTimes(self):
        """ 
        Parse time related parameters into datetime objects for later use 
        """
        from da.tools.general import AdvanceTime

        startdate = self['time.start']
        finaldate = self['time.finish']                  

        if finaldate <= startdate:
            msg   = 'The start date (%s) is not greater than the end date (%s), please revise'%(startdate.strftime('%Y%m%d'),finaldate.strftime('%Y%m%d')) 
            logging.error(msg)
            raise ValueError
        #
        cyclelength = self['time.cycle']                 # get time step

# Determine end date

        if cyclelength == 'infinite':
            enddate = finaldate
        else:
            enddate = AdvanceTime(startdate,cyclelength)

        #
        if enddate > finaldate:  # do not run beyon finaldate
            enddate = finaldate

        self['time.start']   = startdate
        self['time.end']     = enddate
        self['time.finish']  = finaldate
        self['cyclelength']  = cyclelength

        msg = "==============================================================="    ; logging.info(msg)
        msg = "DA Cycle start date is %s"   % startdate.strftime('%Y-%m-%d %H:%M')      ; logging.info(msg)
        msg = "DA Cycle end   date is %s"   % enddate.strftime('%Y-%m-%d %H:%M')        ; logging.info(msg)
        msg = "DA Cycle final date is %s"   % finaldate.strftime('%Y-%m-%d %H:%M')      ; logging.info(msg)
        msg = "DA Cycle cycle length is %s" % cyclelength                               ; logging.info(msg)
        msg = "DA Cycle restart is %s"      % str(self['time.restart'])     ; logging.info(msg)
        msg = "==============================================================="    ; logging.info(msg)

        return None

    def RandomSeed(self,action='read'):
Peters, Wouter's avatar
Peters, Wouter committed
210
211
212
213
214
        """ 
        Get the randomseed and save it, or read the random seed and set it. The seed is currently stored
        in a python :mod:`pickle` file, residing in the save directory

        """
215
216
217
        import cPickle
        import numpy as np

218
        filename = os.path.join(self['dir.restart.current'],'randomseed.pickle')
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240

        if action == 'write':
            f        = open(filename,'wb')
            seed     = np.random.get_state()
            dummy    = cPickle.dump (seed,f,-1)
            dummy    = f.close()

            msg      = "Saved the random seed generator values to file"

        if action == 'read':
            f        = open(filename,'rb')
            seed     = cPickle.load(f)
            dummy    = np.random.set_state(seed)
            dummy    = f.close()

            msg      = "Retrieved the random seed generator values from file"

        logging.info(msg)

        return None

    def Initialize(self):
241
242
243
244
245
        """ 
        This method determines how to proceed with the cycle. Three options are implemented:

            1. Fresh start  : set up the required file structure for this simulation and start
            2. Restart      : use latest da_runtime variables from the exec dir and restart
246
            3. Recover      : restart after crash by getting data from restart/one-ago folder
247
248
249

        The choice that gets executed depends on the presence of 

Peters, Wouter's avatar
Peters, Wouter committed
250
251
            1. the ``-r`` option on the command line, this triggers a recover
            2. the ``time.restart : True`` option in the da.rc file
252
253

        The latter is automatically set if the filter submits the next cycle at the end of the current one, 
Peters, Wouter's avatar
Peters, Wouter committed
254
255
256
257
258
259
260
261
262
263
264
        through method :meth:`~da.tools.initexit.CycleControl.SubmitNextCycle`.

        The specific call tree under each scenario is:

            1. 
                * dummy = :meth:`~da.tools.initexit.CycleControl.SetupFileStructure()`  <- Create directory tree
            2. 
                * dummy = :meth:`~da.tools.initexit.CycleControl.SetupFileStructure()`
                * dummy = :meth:`~da.tools.initexit.CycleControl.RandomSeed`    <- Read the random seed from file
            3. 
                * dummy = :meth:`~da.tools.initexit.CycleControl.SetupFileStructure()`
265
                * dummy = :meth:`~da.tools.initexit.CycleControl.RecoverRun()`          <- Recover files from restart/one-ago dir, reset ``time.start``
Peters, Wouter's avatar
Peters, Wouter committed
266
267
268
269
270
271
272
                * dummy = :meth:`~da.tools.initexit.CycleControl.RandomSeed` 

        And is always followed by a call to

        * ParseTimes()
        * WriteRc('jobfilename')

273

274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
        """        

#
# case 1: A recover from a previous crash, this is signaled by flag "-r"
#
        if self['da.crash.recover']:

            msg   = "Recovering simulation from data in: %s" % self['dir.da_run']  ; logging.info(msg)

            dummy = self.SetupFileStructure()

            dummy = self.RecoverRun()

            dummy = self.RandomSeed('read')
#
# case 2: A continuation, this is signaled by rc-item time.restart = True
#
        elif self['time.restart']:

            msg   = "Restarting filter from previous step"  ; logging.info(msg)

            dummy = self.SetupFileStructure()

            dummy = self.RandomSeed('read')
#
# case 3: A fresh start, this is signaled by rc-item time.restart = False
#
        elif not self['time.restart']:
            msg   = "First time step in filter sequence"   ; logging.info(msg)

            dummy = self.SetupFileStructure()

            # expand jobrcfilename to include exec dir from now on.

            self['jobrcfilename'] = os.path.join(self['dir.exec'],self['jobrcfilename'])


        self.ParseTimes()
        self.WriteRC(self['jobrcfilename'])

        return None


    def SetupFileStructure(self):
        """ 
        Create file structure needed for data assimilation system.
Peters, Wouter's avatar
Peters, Wouter committed
320
321
322
323
324
325
326
327
328
        In principle this looks like:

            * ``${da_rundir}``
            * ``${da_rundir}/input``
            * ``${da_rundir}/output``
            * ``${da_rundir}/exec``
            * ``${da_rundir}/diagnostics``
            * ``${da_rundir}/analysis``
            * ``${da_rundir}/jobs``
329
330
            * ``${da_rundir}/restart/current``
            * ``${da_rundir}/restart/one-ago``
Peters, Wouter's avatar
Peters, Wouter committed
331

332
333
334
335
336
337
        .. note: The exec dir will actually be a simlink to the directory where
                 the observation operator executable lives. This directory is passed through
                 the ``da.rc`` file. 

        .. note: The observation input files will be placed in the exec dir,
                 and the resulting simulated values will be retrieved from there as well.
Peters, Wouter's avatar
Peters, Wouter committed
338

339
340
341
342
343
344
345
346
347
348
349
350
351
        """
        from da.tools.general import CreateDirs

# Create the run directory for this DA job, including I/O structure

        filtertime  = self['time.start'].strftime('%Y%m%d')

        self['dir.exec']        = os.path.join(self['dir.da_run'],'exec')
        self['dir.input']       = os.path.join(self['dir.da_run'],'input')
        self['dir.output']      = os.path.join(self['dir.da_run'],'output',filtertime)
        self['dir.diagnostics'] = os.path.join(self['dir.da_run'],'diagnostics')
        self['dir.analysis']    = os.path.join(self['dir.da_run'],'analysis')
        self['dir.jobs']        = os.path.join(self['dir.da_run'],'jobs')
352
353
354
        self['dir.restart']     = os.path.join(self['dir.da_run'],'restart')
        self['dir.restart.current']    = os.path.join(self['dir.restart'],'current')
        self['dir.restart.oneago']     = os.path.join(self['dir.restart'],'one-ago')
355
356
357
358
359
360
361
362

        CreateDirs(self['dir.da_run'])
        CreateDirs(os.path.join(self['dir.exec']))
        CreateDirs(os.path.join(self['dir.input']))
        CreateDirs(os.path.join(self['dir.output']))
        CreateDirs(os.path.join(self['dir.diagnostics']))
        CreateDirs(os.path.join(self['dir.analysis']))
        CreateDirs(os.path.join(self['dir.jobs']))
363
364
365
        CreateDirs(os.path.join(self['dir.restart']))
        CreateDirs(os.path.join(self['dir.restart.current']))
        CreateDirs(os.path.join(self['dir.restart.oneago']))
366
367
368
369
370

        msg = 'Succesfully created the file structure for the assimilation job'  ; logging.info(msg)


    def RecoverRun(self):
Peters, Wouter's avatar
Peters, Wouter committed
371
372
        """
        Prepare a recovery from a crashed run. This consists of: 
373
        
374
            - copying all data from the restart/one-ago folder (:meth:`~da.tools.initexit.CycleControl.MoveRestartData`),
Peters, Wouter's avatar
Peters, Wouter committed
375
376
377
            - replacing all ``rc-file`` items with those from ``da_runtime.rc`` 
            - resetting the seed of the random number generator to the value it had before the crash (:meth:`~da.tools.initexit.CycleControl.RandomSeed`)
            
378
379
        """

380
        # Move all data from the restart/one-ago directory to the restart/current directory
381

382
        dummy = self.MoveRestartData(io_option='restore')
383

384
        # Replace rc-items with those from the crashed run's last rc-file (now in restart.current dir)
385

386
        file_rc_rec = os.path.join(self['dir.restart.current'],'da_runtime.rc')
387
388
389
390
391
392
393
        rc_rec      = rc.read(file_rc_rec)

        for k,v in rc_rec.iteritems():
            self[k] = v

        self.ValidateRC()

394
        msg         = "Replaced rc-items.... "                            ; logging.debug(msg)
395
396
397
398
399
400
        msg         = "Next cycle start date is %s" % self['time.start']  ; logging.debug(msg)

        return None

    def Finalize(self):
        """
401
402
403
404
        Finalize the da cycle, this means writing the save data and rc-files for the next run. 
        The following sequence of actions occur:

            * Write the randomseed to file for reuse in next cycle
Peters, Wouter's avatar
Peters, Wouter committed
405
            * Write a new ``rc-file`` with ``time.restart : True``, and new ``time.start`` and ``time.end``
406
407
408
409
            * Collect all needed data needed for check-pointing (restart from current system state)
            * Move the previous check pointing data out of the way, and replace with current
            * Submit the next cycle

410
411
412
413
        """

        dummy = self.RandomSeed('write')
        dummy = self.WriteNewRCfile()
414
        dummy = self.MoveRestartData(io_option='store')
415
        dummy = self.CollectRestartData()
416
417
        dummy = self.SubmitNextCycle()

418
    def CollectRestartData(self):
419
        """ Collect files needed for the restart of this cycle in case of a crash, or for the continuation of the next cycle. 
420
421
422
423
            All files needded are written to the restart/current directory. The list of files included is read from the 
            attribute "RestartFileList" which is a simple list of files that can be appended by other objects/methods that
            require restart data to be saved.

424
425
426
427
428
429
            .. note: Before collecting the files in the ``RestartFileList``, the restart/current directory will be emptied and
                     recreated. This prevents files from accumulating in the restart/current and restart/one-ago folders. It 
                     also means that if a file is missing from the ``RestartFileList``, it will not be available for check-pointing
                     if your run crashes or dies!

            Currently, the following files are included:
430

431
432
433
                * The ``da_runtime.rc`` file
                * The savestate.nc file
                * The files in the ``ObservationOperator.RestartFileList``, i.e., restart data for the transport model
434

435
436
            .. note: We assume that the restart files for the :class:`~da.baseclasses.observationoprator.ObservationOperator` 
            reside in a separate folder, i.e, the ObservationOperator does *not* write directly to the restart dir!
437
438
439

        """

440
441
442
        self.RestartFileList.append( os.path.join(self['dir.exec'],'da_runtime.rc') )
        self.RestartFileList.append( os.path.join(self['dir.output'],'savestate.nc') )
        #self.RestartFileList.append( os.path.join(self['dir.exec'],'randomseed.pickle') )
443

444
        targetdir   = os.path.join(self['dir.restart.current'])
445

446
447
448
449
        msg         = "Purging the current restart directory before collecting new data"         ; logging.info(msg)

        CreateDirs(os.path.join(targetdir),forceclean=True)

450
        msg         = "Collecting the required restart data"                                      ; logging.info(msg)
451
452
        msg         = "           to   directory: %s " % targetdir                                ; logging.debug(msg)

453
454
455
456
        for file in self.RestartFileList:

            if os.path.isdir(file): # skip dirs
                continue
457
458
459
460
461

            msg         = "           [copy] .... %s " % file                                     ; logging.debug(msg)
            dummy       = shutil.copy(file,file.replace(os.path.split(file)[0],targetdir) )


462
    def MoveRestartData(self, io_option='restore'):
Peters, Wouter's avatar
Peters, Wouter committed
463
464
465
        """ 
        :

466
        Store or restore model state to/from a restart directory. 
467

468
            Two IO options are available:
469

470
471
            (1) io_option = restore    : Get data from restart.oneago directory
            (2) io_option = store      : Save data to restart.oneago directory
472

473
            In case of a 'store' command the restart.oneago folder is re-created so that the contents are empty to begin with.
474
475
476
477
478
479
480

        """
        from da.tools.general import CreateDirs

        if io_option not in ['store','restore']:
            raise ValueError,'Invalid option specified for io_option (%s)' % io_option

481
        if io_option == 'store':
482

483
484
            targetdir = self['dir.restart.oneago']
            sourcedir = self['dir.restart.current']
485

486
        elif io_option == 'restore':
487

488
489
            sourcedir = self['dir.restart.oneago']
            targetdir = self['dir.restart.current']
490
491
492
493
494
495

# If "store" is requested, recreate target dir, cleaning the contents 

        if io_option == 'store':
            CreateDirs(os.path.join(targetdir),forceclean=True)

496
        msg         = "Performing a %s of data" % (io_option)                                     ; logging.debug(msg)
497
498
499
500
501
502
503
504
505
        msg         = "           from directory: %s " % sourcedir                                ; logging.debug(msg)
        msg         = "           to   directory: %s " % targetdir                                ; logging.debug(msg)


        for file in os.listdir(sourcedir):

            file = os.path.join(sourcedir,file)

            if os.path.isdir(file): # skip dirs
506

507
508
                msg         = "           [skip] .... %s " % file                                     ; logging.debug(msg)
                continue    
509
            else:
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543

                msg         = "           [copy] .... %s " % file                                                ; logging.debug(msg)
                dummy       = shutil.copy(file,file.replace(sourcedir,targetdir) )

#
    def WriteNewRCfile(self):
        """ Write the rc-file for the next DA cycle. Note that the start time for the next cycle is the end time of this one, while 
            the end time for the next cycle is the current end time + one cycle length. The resulting rc-file is written to:
            
            (1) to the dir.exec so that it can be used when resubmitting the next cycle
            
        """
        from da.tools.general import AdvanceTime

        # These first two lines advance the filter time for the next cycle

        self['time.start']        = self['time.end']
        self['time.end']          = AdvanceTime(self['time.end'],self['cyclelength'])

        # The rest is info needed for a system restart

        self['time.restart']     = True
        #self['time.start']       = self['time.start'].strftime('%Y-%m-%d %H:%M:%S')
        #self['time.finish']      = self['time.finish'].strftime('%Y-%m-%d %H:%M:%S')

        fname                                = os.path.join(self['dir.exec'],'da_runtime.rc')
        self['da.restart.fname'] = fname
        dummy                                = rc.write(fname,self)

        msg = 'Wrote new da_runtime.rc (%s)'%fname ; logging.debug(msg)


    def WriteRC(self,fname):
        """ Write RC file after each process to reflect updated info """
544
        import da.tools.rc as rc
545
546
547
548
549
550
551

        dummy  = rc.write(fname,self)
        msg    = 'Wrote expanded rc-file (%s)'%(fname) ; logging.debug(msg)
        return None

    def SubmitNextCycle(self):
        """ 
Peters, Wouter's avatar
Peters, Wouter committed
552
        Submit the next job of a DA cycle, this consists of 
553
554
555
            * Changing to the working directory from which the job was started initially
            * create a line to start the master script again with a newly created rc-file
            * Submitting the jobfile 
Peters, Wouter's avatar
Peters, Wouter committed
556
557
558

        If the end of the cycle series is reached, no new job is submitted.

559
560
561
562
563
564
565
566
567
        """
        import subprocess
        import os


        DaPlatForm = self.DaPlatForm

        if self['time.start'] < self['time.finish']:

568
            jobcommand              = '%s rc=%s'% (sys.argv[0], self['da.restart.fname'], ) 
569
570
            dummy                   = os.chdir(self['dir.da_submit'] )
            jobid                   = DaPlatForm.SubmitJob(jobcommand) 
571
572
573
574
575
576
        else:
            logging.info('Final date reached, no new cycle started')

        return None

    def SubmitSubStep(self,stepname):
Peters, Wouter's avatar
Peters, Wouter committed
577
578
579
580
581
582
583
584
        """ 
        Submit the next substep of a DA cycle, this consists of 
            * getting a job template as returned by :meth:`~da.tools.baseclasses.platform.GetJobTemplate`
            * adding the lines needed to start a next run with a newly created rc-file
            * Writing the jobfile as done by :meth:`~da.tools.baseclasses.platform.WriteJob`
            * Submitting the jobfile as done by :meth:`~da.tools.baseclasses.platform.WriteJob`

        """
585
586
587
588
589
590
591
592
593
594
        import subprocess
        import os
        from string import join


        DaPlatForm = self.DaPlatForm

        jobparams               = {'jobname':'das.%s'%stepname}
        template                = DaPlatForm.GetJobTemplate(jobparams)
        template                += 'cd %s\n'%os.getcwd()
595
        template                += '%s rc=%s process=%s %s' % (sys.argv[0],self['jobrcfilename'],stepname,join(self.opts,''),) 
596
597
598
599
600
        jobfile                 = DaPlatForm.WriteJob(self,template,stepname)
        jobid                   = DaPlatForm.SubmitJob(jobfile) 

        return None

601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
    def CleanUpCycle(self):
        """
        Move the log file, clean up rundir after a cycle has finished
        """

        # move log file to rundir/jobs
        jobdir      = os.path.join(self['dir.da_run'],"jobs")
        logfile     = 'das.o%s'%self.DaPlatForm.GetMyID()

        if os.path.exists(logfile):
            joblogfile  = os.path.join(jobdir,'cycle.%s.log'%self['time.sample.start'].strftime('%Y%m%d')) 
            dummy       = shutil.move(logfile,joblogfile)
            msg         = "....Moved %s to %s"%(logfile,joblogfile)   ; logging.debug(msg)

            msg = "The complete log file is now at: %s"%(joblogfile)   ; logging.info(msg)


618
619
620
621
622
623
624
625
626
627
628

def StartLogger():
    """ start the logging of messages to screen"""

# start the logging basic configuration by setting up a log file

    logging.basicConfig(level    = logging.INFO,
                        format   = ' [%(levelname)-7s] (%(asctime)s) py-%(module)-20s : %(message)s',
                        datefmt  = '%Y-%m-%d %H:%M:%S')

def ParseOptions():
629
630
631
632
633
634
635
636
637
638
639
640
641
    """ 
    Function parses options from the command line and returns the arguments as a dictionary.
    Accepted command line arguments are:

    ========  =======
    Argument  Meaning
    ========  =======
    -v        verbose output in log files
    -h        display help
    -r        start a simulation by recovering from a previous crash
    ========  =======

    """
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
    import getopt
    import sys

# Parse keywords, the only option accepted so far is the "-h" flag for help

    opts=[]
    args=[]
    try:                                
        opts, args = getopt.gnu_getopt(sys.argv[1:], "-hrv")
    except getopt.GetoptError, msg:           
        logging.error('%s'%msg)
        sys.exit(2)      

    for options in opts:
        options=options[0].lower()
        if options == '-h':
            print ""
            print helptext
            sys.exit(2)      
        if options == '-r':
            logging.info('-r flag specified on command line: recovering from crash')
        if options == '-v':
            logging.info('-v flag specified on command line: extra verbose output')
            dummy  = logging.root.setLevel(logging.DEBUG)

# Parse arguments and return as dictionary

    arguments={}
    for item in args:
        #item=item.lower()

# Catch arguments that are passed not in "key=value" format

        if '=' in item:
            key, arg = item.split('=')
        else:
            logging.error('%s'%'Argument passed without description (%s)' % item)
            raise getopt.GetoptError,arg

        arguments[key]=arg

683
    if opts: optslist=[item[0] for item in opts]
684

685
    return optslist, arguments
686
687

def ValidateOptsArgs(opts,args):
688
689
690
691
692
    """ 
 Validate the options and arguments passed from the command line before starting the cycle. The validation consists of checking for the presence of an argument "rc", and the existence of
 the specified rc-file.  
 
    """
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712

    if not args.has_key("rc"):
        msg = "There is no rc-file specified on the command line. Please use rc=yourfile.rc"   ; logging.error(msg)
        raise IOError,msg
    elif not os.path.exists(args['rc']):
        msg = "The specified rc-file (%s) does not exist " % args['rc'] ;  logging.error(msg)
        raise IOError,msg

    # WP not needed anymore
    #if not args.has_key('process'):
    #    msg = "There is no process specified on the command line, assuming process=Start"   ; logging.info(msg)
    #    args['process'] = 'start'
    #if args['process'].lower() not in validprocesses:
    #    msg = "The specified process (%s) is not valid"%args['process']   ; logging.error(msg)
    #    raise IOError,msg

    return opts,args


if __name__ == "__main__":
713
714
715
716
717

    sys.path.append('../../')
    opts,args = ParseOptions()
    print opts
    print args
718