40.Add fremake tools

fre/__init__.py

@@ -1,7 +1,6 @@
-from fre.fre import *
 from fre.frecheck import *
 from fre.frelist import *
-from fre.fremake import *
+from .make import *
 from fre.frepp import *
 from fre.frerun import *
 from fre.frecatalog import *

fre/fre.py

@@ -13,8 +13,7 @@
 from fre import frecheck
 from fre.frecheck.frecheck import *
 
-from fre import fremake
-from fre.fremake.fremake import *
+from .make import checkout_create, compile_create, makefile_create, dockerfile_create, fremake_run
 
 from fre import frepp
 from fre.frepp.frepp import *
@@ -54,7 +53,7 @@ def freList():
     pass
 
 @fre.group('make')
-def freMake():
+def fremake():
     """ - access fre make subcommands """
     pass
 
@@ -124,97 +123,187 @@ def mask_atmos_plevel(context, infile, outfile, psfile):
 """
 fre make subcommands to be processed
 """
-@freMake.command()
-@click.option('--uppercase', '-u', is_flag=True, help = 'Print statement in uppercase.')
-def checkout(uppercase):
-    """ - Execute fre make checkout """
-    statement = "execute fre make checkout script" 
-    if uppercase:
-        statement = statement.upper()
-    click.echo(statement)
-
-@freMake.command()
-@click.option("-y", 
-              "--yamlfile", 
-              type=str, 
-              help="Experiment yaml compile FILE", 
+
+@fremake.command()
+@click.option("-y",
+              "--yamlfile",
+              type=str,
+              help="Experiment yaml compile FILE",
               required=True) # used click.option() instead of click.argument() because we want to have help statements
-@click.option("-p", 
-              "--platform", 
+@click.option("-p",
+              "--platform",
               multiple=True, #replaces nargs=-1 since we are using click.option() instead of click.argument()
-              type=str, 
+              type=str,
               help="Hardware and software FRE platform space separated list of STRING(s). This sets platform-specific data and instructions", required=True)
-@click.option("-t", "--target", 
+@click.option("-t", "--target",
               multiple=True, #replaces nargs=-1 since we are using click.option() instead of click.argument()
-              type=str, 
-              help="FRE target space separated list of STRING(s) that defines compilation settings and linkage directives for experiments. Predefined targets refer to groups of directives that exist in the mkmf template file (referenced in buildDocker.py). Possible predefined targets include 'prod', 'openmp', 'repro', 'debug, 'hdf5'; however 'prod', 'repro', and 'debug' are mutually exclusive (cannot not use more than one of these in the target list). Any number of targets can be used.", 
+              type=str,               help="FRE target space separated list of STRING(s) that defines compilation settings and linkage directives for experiments. Predefined targets refer to groups of directives that exist in the mkmf template file (referenced in buildDocker.py). Possible predefined targets include 'prod', 'openmp', 'repro', 'debug, 'hdf5'; however 'prod', 'repro', and 'debug' are mutually exclusive (cannot not use more than one of these in the target list). Any number of targets can be used.",
               required=True)
-@click.option("-f", 
-              "--force-checkout", 
-              is_flag=True, 
-              help="Force checkout to get a fresh checkout to source directory in case the source directory exists")
-@click.option("-F", 
-              "--force-compile", 
-              is_flag=True, 
-              help="Force compile to compile a fresh executable in case the executable directory exists")
-@click.option("-K", 
-              "--keep-compiled", 
-              is_flag=True, 
-              help="Keep compiled files in the executable directory for future use")
-@click.option("--no-link", 
-              is_flag=True, 
-              help="Do not link the executable")
-@click.option("-E", 
-              "--execute", 
-              is_flag=True, 
+@click.option("-e",
+              "--execute",
+              is_flag=True,
               help="Execute all the created scripts in the current session")
-@click.option("-n", 
-              "--parallel", 
+@click.option("-n",
+              "--parallel",
               type=int,
-              metavar='', 
-              default=1, 
+              metavar='',
+              default=1,
               help="Number of concurrent model compiles (default 1)")
-@click.option("-j", 
-              "--jobs", 
-              type=int, 
+@click.option("-j",
+              "--jobs",
+              type=int,
               metavar='',
-              default=4, 
+              default=4,
               help="Number of jobs to run simultaneously. Used for make -jJOBS and git clone recursive --jobs=JOBS")
-@click.option("-npc", 
-              "--no-parallel-checkout", 
-              is_flag=True, 
+@click.option("-npc",
+              "--no-parallel-checkout",
+              is_flag=True,
               help="Use this option if you do not want a parallel checkout. The default is to have parallel checkouts.")
-@click.option("-s", 
-              "--submit", 
-              is_flag=True, 
+@click.option("-s",
+              "--submit",
+              is_flag=True,
               help="Submit all the created scripts as batch jobs")
-@click.option("-v", 
-              "--verbose", 
-              is_flag=True, 
+@click.option("-v",
+              "--verbose",
+              is_flag=True,
               help="Get verbose messages (repeat the option to increase verbosity level)")
-@click.option("-w", 
-              "--walltime", 
+@click.pass_context
+def run_fremake(context, yamlfile, platform, target, execute, parallel, jobs, no_parallel_checkout, submit, verbose):
+    """ - Perform all fremake functions to run checkout and compile model"""
+    context.forward(fremake_run)
+
+####
+@fremake.command()
+@click.option("-y",
+              "--yamlfile",
+              type=str,
+              help="Experiment yaml compile FILE",
+              required=True) # used click.option() instead of click.argument() because we want to have help statements
+@click.option("-p",
+              "--platform",
+              multiple=True, #replaces nargs=-1 since we are using click.option() instead of click.argument()
+              type=str,
+              help="Hardware and software FRE platform space separated list of STRING(s). This sets platform-specific data and instructions", required=True)
+@click.option("-t", "--target",
+              multiple=True, #replaces nargs=-1 since we are using click.option() instead of click.argument()
+              type=str,
+              help="FRE target space separated list of STRING(s) that defines compilation settings and linkage directives for experiments. Predefined targets refer to groups of directives that exist in the mkmf template file (referenced in buildDocker.py). Possible predefined targets include 'prod', 'openmp', 'repro', 'debug, 'hdf5'; however 'prod', 'repro', and 'debug' are mutually exclusive (cannot not use more than one of these in the target list). Any number of targets can be used.",
+              required=True)
+@click.option("-j",
+              "--jobs",
+              type=int,
+              metavar='',
+              default=4,
+              help="Number of jobs to run simultaneously. Used for make -jJOBS and git clone recursive --jobs=JOBS")
+@click.option("-npc",
+              "--no-parallel-checkout",
+              is_flag=True,
+              help="Use this option if you do not want a parallel checkout. The default is to have parallel checkouts.")
+@click.option("-e",
+              "--execute",
+              is_flag=True,
+              default=False,
+              help="Use this to run the created checkout script.")
+@click.option("-v",
+              "--verbose",
+              is_flag=True,
+              help="Get verbose messages (repeat the option to increase verbosity level)")
+@click.pass_context
+def create_checkout(context,yamlfile,platform,target,no_parallel_checkout,jobs,execute,verbose):
+    """ - Write the checkout script """
+    context.forward(checkout_create)
+
+#####
+@fremake.command
+@click.option("-y",
+              "--yamlfile",
+              type=str,
+              help="Experiment yaml compile FILE",
+              required=True) # used click.option() instead of click.argument() because we want to have help statements
+@click.option("-p",
+              "--platform",
+              multiple=True, #replaces nargs=-1 since we are using click.option() instead of click.argument()
+              type=str,
+              help="Hardware and software FRE platform space separated list of STRING(s). This sets platform-specific data and instructions", required=True)
+@click.option("-t", "--target",
+              multiple=True, #replaces nargs=-1 since we are using click.option() instead of click.argument()
+              type=str,
+              help="FRE target space separated list of STRING(s) that defines compilation settings and linkage directives for experiments. Predefined targets refer to groups of directives that exist in the mkmf template file (referenced in buildDocker.py). Possible predefined targets include 'prod', 'openmp', 'repro', 'debug, 'hdf5'; however 'prod', 'repro', and 'debug' are mutually exclusive (cannot not use more than one of these in the target list). Any number of targets can be used.",
+              required=True)
+@click.pass_context
+def create_makefile(context,yamlfile,platform,target):
+    """ - Write the makefile """
+    context.forward(makefile_create)
+
+#####
+
+@fremake.command
+@click.option("-y",
+              "--yamlfile",
+              type=str,
+              help="Experiment yaml compile FILE",
+              required=True) # used click.option() instead of click.argument() because we want to have help statements
+@click.option("-p",
+              "--platform",
+              multiple=True, #replaces nargs=-1 since we are using click.option() instead of click.argument()
+              type=str,
+              help="Hardware and software FRE platform space separated list of STRING(s). This sets platform-specific data and instructions", required=True)
+@click.option("-t", "--target",
+              multiple=True, #replaces nargs=-1 since we are using click.option() instead of click.argument()
+              type=str,
+              help="FRE target space separated list of STRING(s) that defines compilation settings and linkage directives for experiments. Predefined targets refer to groups of directives that exist in the mkmf template file (referenced in buildDocker.py). Possible predefined targets include 'prod', 'openmp', 'repro', 'debug, 'hdf5'; however 'prod', 'repro', and 'debug' are mutually exclusive (cannot not use more than one of these in the target list). Any number of targets can be used.",
+              required=True)
+@click.option("-j",
+              "--jobs",
+              type=int,
+              metavar='',
+              default=4,
+              help="Number of jobs to run simultaneously. Used for make -jJOBS and git clone recursive --jobs=JOBS")
+@click.option("-n", 
+              "--parallel",
               type=int, 
-              metavar='', 
-              help="Maximum wall time NUM (in minutes) to use")
-@click.option("--mail-list", 
-              type=str, 
-              help="Email the comma-separated STRING list of emails rather than [email protected]")
+              metavar='', default=1,
+              help="Number of concurrent model compiles (default 1)")
+@click.option("-e",
+              "--execute",
+              is_flag=True,
+              default=False,
+              help="Use this to run the created checkout script.")
+@click.option("-v",
+              "--verbose",
+              is_flag=True,
+              help="Get verbose messages (repeat the option to increase verbosity level)")
+@click.pass_context
+def create_compile(context,yamlfile,platform,target,jobs,parallel,execute,verbose):
+    """ - Write the compile script """
+    context.forward(compile_create)
+
+#####
+
+@fremake.command
+@click.option("-y",
+              "--yamlfile",
+              type=str,
+              help="Experiment yaml compile FILE",
+              required=True) # used click.option() instead of click.argument() because we want to have help statements
+@click.option("-p",
+              "--platform",
+              multiple=True, #replaces nargs=-1 since we are using click.option() instead of click.argument()
+              type=str,
+              help="Hardware and software FRE platform space separated list of STRING(s). This sets platform-specific data and instructions", required=True)
+@click.option("-t", "--target",
+              multiple=True, #replaces nargs=-1 since we are using click.option() instead of click.argument()
+              type=str,
+              help="FRE target space separated list of STRING(s) that defines compilation settings and linkage directives for experiments. Predefined targets refer to groups of directives that exist in the mkmf template file (referenced in buildDocker.py). Possible predefined targets include 'prod', 'openmp', 'repro', 'debug, 'hdf5'; however 'prod', 'repro', and 'debug' are mutually exclusive (cannot not use more than one of these in the target list). Any number of targets can be used.",
+              required=True)
+@click.option("-e",
+              "--execute",
+              is_flag=True,
+              help="Build Dockerfile that has been generated by create-docker.")
 @click.pass_context
-def fremakefunction(context, yamlfile, platform, target, force_checkout, force_compile, keep_compiled, no_link, execute, parallel, jobs, no_parallel_checkout, submit, verbose, walltime, mail_list):
-    """ - Execute fre make func """
-    context.forward(fremake.fremake.fremake)
-
-# # this is the command that will execute all of `fre make`, but I need to test whether it will be able to pass specific flags to different areas when it they each have different flags
-# @freMake.command()
-# @click.option('--uppercase', '-u', is_flag=True, help = 'Print statement in uppercase.')
-# @click.pass_context
-# def executeAll(context, uppercase):
-#     """ - Execute all commands under fre make"""
-#     context.forward(checkout)
-#     context.forward(compile)
-#     context.forward(container)
-#     context.forward(list)
+def create_dockerfile(context,yamlfile,platform,target,execute):
+    """ - Write the dockerfile """
+    context.forward(dockerfile_create)
 
 #############################################
 
@@ -376,6 +465,7 @@ def install(context, experiment, platform, target):
               type=str, 
               help="YAML file to be used for parsing", 
               required=True)
+
 @click.pass_context
 def configure(context,yamlfile,experiment,platform,target):
     """ - Execute fre pp configure """