Merge pull request #589 from douglasjacobsen/info-cmd-update

Update the info command to be more flexible

Author: douglasjacobsen

lib/ramble/docs/tutorials/11_using_internals.rst

@@ -130,16 +130,36 @@ experiments, execute:
 
 .. code-block:: console
 
-    $ ramble info wrfv4
+    $ ramble info -a workloads -v -p "CONUS_12km" wrfv4
 
-
-And examine the section under the ``Workload: CONUS_12km`` header. The
+This prints the information for the ``CONUS_12km`` workload in the wrfv4 application definition.
 ``Executables:`` definition lists the order of executables used for this
 workload. As an example, you might see the following:
 
 .. code-block:: console
 
-    Executables: ['builtin::env_vars', 'builtin::spack_source', 'builtin::spack_activate', 'cleanup', 'copy', 'fix_12km', 'execute']
+    Executables: ['cleanup', 'copy', 'fix_12km', 'execute']
+
+Some executables are provided through the ``builtin`` functionality. These are
+executable commands that are injected by default from the object definitions.
+To be able to see these, you can execute:
+
+.. code-block:: console
+
+    $ ramble info -a builtins -v wrfv4
+
+This command should print something like the following:
+
+.. code-block:: console
+
+  ############
+  # builtins #
+  ############
+  builtin::env_vars:
+      name: env_vars
+      required: True
+      injection_method: prepend
+      depends_on: []
 
 Now, edit the workspace configuration file with:
 

lib/ramble/docs/tutorials/2_running_a_simple_gromacs_experiment.rst

@@ -32,16 +32,17 @@ get information about these workloads:
 
 .. code-block:: console
 
-    $ ramble info gromacs
+    $ ramble info -a workloads -v -p "water*" gromacs
 
-Searching the output for the sections marked ``Workload: water_bare`` and
+Under the workloads marked by ``Workload: water_bare`` and
 ``Workload: water_gmx50``, you should see something like the following output:
 
 .. code-block:: console
 
     Workload: water_gmx50
         Executables: ['pre-process', 'execute-gen']
         Inputs: ['water_gmx50_bare']
+        Tags: []
         Variables:
             size:
                 Description: Workload size
@@ -57,6 +58,7 @@ Searching the output for the sections marked ``Workload: water_bare`` and
     Workload: water_bare
         Executables: ['pre-process', 'execute-gen']
         Inputs: ['water_bare_hbonds']
+        Tags: []
         Variables:
             size:
                 Description: Workload size
@@ -70,27 +72,43 @@ Searching the output for the sections marked ``Workload: water_bare`` and
                 Description: Input path for water bare hbonds
                 Default: {water_bare_hbonds}/{size}
 
-
-
 Here we see that both of these workloads have a ``type`` variable (with
 possible values of ``pme`` and ``rf``) and a ``size`` variable with a variety
 of available sizes.
 
-Towards the bottom of the output you should also see information about a valid
-software configuration:
+To determine a suggested software configuration, you can use:
 
 .. code-block:: console
 
-   Default Compilers:
-    gcc9:
-      pkg_spec = [email protected]
+  $ ramble info -a software_specs,compilers -v gromacs
+
+With this command, you should see output similar to the following:
+
+.. code-block:: console
 
-    Software Specs:
-      impi2021:
-        pkg_spec = [email protected]
-      gromacs:
-        pkg_spec = [email protected]
-        compiler = gcc9
+  ##################
+  # software_specs #
+  ##################
+  impi2018:
+      pkg_spec: [email protected]
+      compiler_spec: None
+      compiler: None
+      package_manager: spack*
+  
+  gromacs:
+      pkg_spec: [email protected]
+      compiler_spec: None
+      compiler: gcc9
+      package_manager: spack*
+  
+  #############
+  # compilers #
+  #############
+  gcc9:
+      pkg_spec: [email protected]
+      compiler_spec: None
+      compiler: None
+      package_manager: spack*
 
 This output does not represent the only possible configuration that works for
 this application, it only presents a good starting point. When using Ramble,

lib/ramble/docs/tutorials/3_modifying_a_gromacs_experiment.rst

@@ -128,16 +128,16 @@ available variables with the following command:
 
 .. code-block:: console
 
-    $ ramble info gromacs
+    $ ramble info -a workloads -v -p "water*" gromacs
 
-
-Focusing on the relevant workloads, you see the following information:
+Which should contain the following information:
 
 .. code-block:: console
 
     Workload: water_gmx50
         Executables: ['pre-process', 'execute-gen']
         Inputs: ['water_gmx50_bare']
+        Tags: []
         Variables:
             size:
                 Description: Workload size
@@ -153,6 +153,7 @@ Focusing on the relevant workloads, you see the following information:
     Workload: water_bare
         Executables: ['pre-process', 'execute-gen']
         Inputs: ['water_bare_hbonds']
+        Tags: []
         Variables:
             size:
                 Description: Workload size

lib/ramble/docs/tutorials/6_configuring_a_scaling_study.rst

@@ -54,11 +54,14 @@ you want to execute. To begin with, select a workload from the output of:
 
 .. code-block:: console
 
-    $ ramble info wrfv4
+    $ ramble info -a workloads wrfv4
 
 For the purposes of this tutorial, the ``CONUS_12km`` workload is recommended
 because it is less computationally expensive than the ``CONUS_2p5km`` workload.
 
+**NOTE**: To get more detailed information about the workload definitions, you
+can use ``ramble info -a workloads -v wrfv4``.
+
 Configure Experiment Definitions
 --------------------------------
 

lib/ramble/ramble/application.py

@@ -271,16 +271,7 @@ def build_phase_order(self):
                     self._pipeline_graphs[pipeline].define_edges(phase_node, internal_order=True)
 
     def _long_print(self):
-        out_str = []
-        out_str.append(rucolor.section_title("Application: ") + f"{self.name}\n")
-        out_str.append("\n")
-
-        out_str.append(rucolor.section_title("Description:\n"))
-        if self.__doc__:
-            out_str.append(f"\t{self.__doc__}\n")
-        else:
-            out_str.append("\tNone\n")
-
+        out_str = ""
         if hasattr(self, "maintainers"):
             out_str.append("\n")
             out_str.append(rucolor.section_title("Maintainers:\n"))