Introduce better argument order (#213)

Fixes argument order so that liskov can be more easily integrated in to the ICON build system.

Author: samkellerhals

liskov/README.md

@@ -8,23 +8,32 @@ To install the icon4py-liskov package, follow the instructions in the `README.md
 
 ## Description
 
-The icon4py-liskov package includes the `icon_liskov` CLI tool which takes a fortran file as input and processes it with the ICON-Liskov DSL Preprocessor. This preprocessor adds the necessary `USE` statements and generates OpenACC `DATA CREATE` statements and declares DSL input/output fields based on directives in the input file. The preprocessor also processes stencils defined in the input file using the `START STENCIL` and `END STENCIL` directives, inserting the necessary code to run the stencils and adding nvtx profile statements if specified with the `--profile` or `-p` flag. Additionally, specifying the `--metadatagen` or `-m` flag will result in the generation of runtime metadata at the top of the generated file. Note that this requires `git` to be available in the shell from which `icon_liskov` is executed.
+The icon4py-liskov package includes the `icon_liskov` CLI tool which takes a fortran file as input and processes it with the ICON-Liskov DSL Preprocessor, generating code and inserting that into the target output file.
+
+`icon_liskov` can either operate in **integration** or **serialisation** mode. In **integration** mode liskov generates calls to Fortran wrapper functions which enable calling icon4py DSL code inside of ICON from Fortran. In **serialisation** mode ppser serialbox statements are generated allowing the serialisation of all variables in all stencils decorated with liskov directives.
 
 ### Usage
 
-To use the `icon_liskov` tool, run the following command:
+#### Integration mode
+
+```bash
+icon_liskov integrate [--profile] [--metadatagen] <input_filepath> <output_filepath>
+```
+
+Options:
+
+- `profile`: adds nvtx profile statements to the stencils (optional).
+- `metadatagen`: generates a metadata header at the top of the file which includes information on icon_liskov such as the version used.
+
+#### Serialisation mode
 
 ```bash
-icon_liskov <input_filepath> <output_filepath> [--profile] [--metadatagen] [--ppser]
+icon_liskov serialise [--multinode] <input_filepath> <output_filepath>
 ```
 
-The following are descriptions of the arguments and options:
+Options:
 
-- input_filepath: path to the input file to be processed.
-- output_filepath: path to the output file.
-- profile flag: adds nvtx profile statements to the stencils (optional).
-- metadatagen flag: generates a metadata header at the top of the file which includes information on icon_liskov such as the version used.
-- ppser flag: activates serialisation mode and will trigger the generation of ppser serialisation statements serialising all variables at the start and end of each stencil directive.
+- `multinode`: ppser init contains the rank of the MPI process to facilitate writing files in a multinode context.
 
 **Note**: By default the data will be saved at the default folder location of the currently run experiment and will have a prefix of `liskov-serialisation`.
 

liskov/src/icon4py/liskov/cli.py

@@ -28,31 +28,12 @@
 
 @click.group(invoke_without_command=True)
 @click.pass_context
-@click.argument(
-    "input_path",
-    type=click.Path(
-        exists=True, dir_okay=False, resolve_path=True, path_type=pathlib.Path
-    ),
-)
-@click.argument(
-    "output_path",
-    type=click.Path(dir_okay=False, resolve_path=True, path_type=pathlib.Path),
-)
-def main(ctx, input_path, output_path):
-    """Command line interface for interacting with the ICON-Liskov DSL Preprocessor.
-
-    Arguments:
-        INPUT_PATH: Path to input file containing Liskov directives.
-        OUTPUT_PATH: Path to new file to be generated.
-    """
+def main(ctx):
+    """Command line interface for interacting with the ICON-Liskov DSL Preprocessor."""
     if ctx.invoked_subcommand is None:
         click.echo(
             "Need to choose one of the following commands:\nintegrate\nserialise"
         )
-    else:
-        ctx.ensure_object(dict)
-        ctx.obj["INPUT"] = input_path
-        ctx.obj["OUTPUT"] = output_path
 
 
 @main.command()
@@ -68,17 +49,23 @@ def main(ctx, input_path, output_path):
     is_flag=True,
     help="Add metadata header with information about program.",
 )
-@click.pass_context
-def integrate(ctx, profile, metadatagen):
+@click.argument(
+    "input_path",
+    type=click.Path(
+        exists=True, dir_okay=False, resolve_path=True, path_type=pathlib.Path
+    ),
+)
+@click.argument(
+    "output_path",
+    type=click.Path(dir_okay=False, resolve_path=True, path_type=pathlib.Path),
+)
+def integrate(input_path, output_path, profile, metadatagen):
     mode = "integration"
-    inp = ctx.obj["INPUT"]
-    out = ctx.obj["OUTPUT"]
-
-    iface = parse_fortran_file(inp, out, mode)
+    iface = parse_fortran_file(input_path, output_path, mode)
     iface_gt4py = load_gt4py_stencils(iface)
     run_code_generation(
-        inp,
-        out,
+        input_path,
+        output_path,
         mode,
         iface_gt4py,
         profile=profile,
@@ -94,13 +81,20 @@ def integrate(ctx, profile, metadatagen):
     help="Specify whether it is a multinode run. Will generate mpi rank information.",
     default=False,
 )
-@click.pass_context
-def serialise(ctx, multinode):
+@click.argument(
+    "input_path",
+    type=click.Path(
+        exists=True, dir_okay=False, resolve_path=True, path_type=pathlib.Path
+    ),
+)
+@click.argument(
+    "output_path",
+    type=click.Path(dir_okay=False, resolve_path=True, path_type=pathlib.Path),
+)
+def serialise(input_path, output_path, multinode):
     mode = "serialisation"
-    inp = ctx.obj["INPUT"]
-    out = ctx.obj["OUTPUT"]
-    iface = parse_fortran_file(inp, out, mode)
-    run_code_generation(inp, out, mode, iface, multinode=multinode)
+    iface = parse_fortran_file(input_path, output_path, mode)
+    run_code_generation(input_path, output_path, mode, iface, multinode=multinode)
 
 
 if __name__ == "__main__":

liskov/tests/test_cli.py

@@ -64,6 +64,6 @@ def outfile(tmp_path):
 )
 def test_cli(make_f90_tmpfile, cli, outfile, file_name, file_content, cmd, cmd_flags):
     fpath = str(make_f90_tmpfile(content=file_content))
-    args = [fpath, outfile, cmd, *cmd_flags]
+    args = [cmd, *cmd_flags, fpath, outfile]
     result = cli.invoke(main, args)
     assert result.exit_code == 0