Source code for src.main

# Copyright 2024, Battelle Energy Alliance, LLC All Rights Reserved
"""
Created on April 1, 2024
@author: wangc

This module is the POEM Template interface, which use the user provided input XML
file to construct the corresponding RAVEN workflows i.e. RAVEN input XML file.
"""
import os
import sys
import logging
import argparse

sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..'))

from POEM.src.poem.PoemTemplate import PoemTemplate
from POEM.src.poem.PoemTemplateInterface import PoemTemplateInterface

import POEM.src._utils as POEM_utils
RAVEN_FRAMEWORK_LOC, RAVEN_EXEC = POEM_utils.get_raven_loc()
sys.path.append(RAVEN_FRAMEWORK_LOC)

logging.basicConfig(format='%(asctime)s %(name)-20s %(levelname)-8s %(message)s', datefmt='%d-%b-%y %H:%M:%S', level=logging.DEBUG)
# To enable the logging to both file and console, the logger for the main should be the root,
# otherwise, a function to add the file handler and stream handler need to be created and called by each module.
# logger = logging.getLogger(__name__)
logger = logging.getLogger()
# # create file handler which logs debug messages
fh = logging.FileHandler(filename='poem.log', mode='w')
fh.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s %(name)-20s %(levelname)-8s %(message)s')
fh.setFormatter(formatter)
# add the handlers to the logger
logger.addHandler(fh)

def runWorkflow(destination):
  """
    Runs the workflow at the destination.
    @ In, destination, str, path and filename of RAVEN input file
    @ Out, res, int, system results of running the code
  """
  # where are we putting the file?
  destDir = os.path.dirname(os.path.normpath(destination))
  workflow = os.path.basename(destination)
  cwd = os.getcwd()
  os.chdir(destDir)
  logger.info(f'RAVEN framework location: {RAVEN_FRAMEWORK_LOC}')
  logger.info(f'RAVEN executable: {RAVEN_EXEC}')
  logger.info(f'RAVEN input file: {workflow}')

  osName = POEM_utils.getOperatingSystem()
  logger.info(f'Operating system: {osName}')
  if osName == 'windows':
    command = '{prefix} {command} {workflow}'.format(prefix='bash', command=RAVEN_EXEC,
                                          workflow=workflow)
  else:
    command = '{command} {workflow}'.format(command=RAVEN_EXEC,
                                          workflow=workflow)
  res = os.system(command)
  os.chdir(cwd)
  return res


def main():
  logger.info('Welcome to the POEM!')
  parser = argparse.ArgumentParser(description='POEM Templated RAVEN Runner')
  parser.add_argument('-i', '--input', nargs=1, required=True, help='POEM input filename')
  # parser.add_argument('-t', '--template', nargs=1, required=True, help='POEM template filename')
  parser.add_argument('-o', '--output', nargs=1, help='POEM output filename')
  parser.add_argument('-nr', '--norun', action='store_true', help='Run POEM')

  args = parser.parse_args()
  args = vars(args)
  inFile = args['input'][0]
  baseName = os.path.basename(inFile)
  workDir = os.path.dirname(os.path.abspath(os.path.normpath(inFile)))
  # print(workDir, baseName)
  logger.info('POEM input file: %s', inFile)
  # tempFile = args['template'][0]
  # logger.info('POEM template file: %s', tempFile)
  if args['output'] is not None:
    outFile = args['output'][0]
    logger.info('POEM output file: %s', outFile)
  else:
    outFile = os.path.join(workDir, 'raven_' + baseName)
    logger.warning('Output file is not specifies, default output file with name ' + outFile + ' will be used')

  norun = args['norun']

  # read capital budgeting input file
  templateInterface = PoemTemplateInterface(inFile)
  templateInterface.readInput()
  outputDict, miscDict = templateInterface.getOutput()
  tempFile = templateInterface.getTemplateFile()

  # create template class instance
  templateClass = PoemTemplate()
  # load template
  templateClass.loadTemplate(tempFile)
  logger.info(' ... workflow successfully loaded ...')
  # create modified template
  template = templateClass.createWorkflow(outputDict, miscDict)
  logger.info(' ... workflow successfully modified ...')
  # write files
  here = os.path.abspath(os.path.dirname(inFile))
  # TODO: There is a problem with RAVEN template class when run=True
  ravenInput = os.path.join(here, outFile)
  templateClass.writeWorkflow(template, ravenInput, run=False)
  # Temp solution, directly run it
  if not norun:
    runWorkflow(ravenInput)

  logger.info('')
  logger.info(' ... workflow successfully created and run ...')
  logger.info(' ... Complete!')

if __name__ == '__main__':
  sys.exit(main())