diff --git a/docs/add-a-system-config.rst b/docs/add-a-system-config.rst index 50781b5f..25ad4aee 100644 --- a/docs/add-a-system-config.rst +++ b/docs/add-a-system-config.rst @@ -242,7 +242,7 @@ The following yaml files are examples of what is generated for the modified_x86 manager (Spack) should use to build the benchmarks on this system. ``software.yaml`` becomes the spack section in the `Ramble configuration file -`_. +`_. .. code-block:: yaml diff --git a/docs/add-an-experiment.rst b/docs/add-an-experiment.rst index 9f182948..579b7bf4 100644 --- a/docs/add-an-experiment.rst +++ b/docs/add-an-experiment.rst @@ -56,10 +56,10 @@ For example, to run the AMG2023 strong scaling experiment for problem 1, using C Initializing an experiment generates the following yaml files: -- ``ramble.yaml`` defines the `Ramble specs `_ for building, running, analyzing and archiving experiments. +- ``ramble.yaml`` defines the `Ramble specs `_ for building, running, analyzing and archiving experiments. - ``execution_template.tpl`` serves as a template for the final experiment script that will be concretized and executed. -A detailed description of Ramble configuration files is available at `Ramble workspace_config `_. +A detailed description of Ramble configuration files is available at `Ramble workspace_config `_. For more advanced usage, such as customizing hardware allocation or performance profiling see :doc:`modifiers`. diff --git a/docs/analyze-experiment.rst b/docs/analyze-experiment.rst index 93b0c875..4c1e1132 100644 --- a/docs/analyze-experiment.rst +++ b/docs/analyze-experiment.rst @@ -12,5 +12,5 @@ Once the experiments completed running, the command:: ramble --disable-progress-bar --workspace-dir . workspace analyze can be used to analyze figures of merit and evaluate -`success/failure `_ +`success/failure ` of the experiments. Ramble generates a file with summary of the results in ``$workspace``. diff --git a/docs/benchpark-setup.rst b/docs/benchpark-setup.rst index 4025e21d..2fc5f0c1 100644 --- a/docs/benchpark-setup.rst +++ b/docs/benchpark-setup.rst @@ -45,7 +45,7 @@ with the following directory structure:: The ``setup.sh`` script calls the Spack and Ramble setup scripts. It optionally accepts parameters to ``ramble workspace setup`` as `documented in Ramble -`_, +`_, including ``--dry-run`` and ``--phases make_experiments``. Now you are ready to compile your experiments as described in :doc:`build-experiment`. diff --git a/docs/modifiers.rst b/docs/modifiers.rst index 72bb50a4..ac48ab9e 100644 --- a/docs/modifiers.rst +++ b/docs/modifiers.rst @@ -7,7 +7,7 @@ Benchpark Modifiers ===================== In Benchpark, a ``modifier`` follows the `Ramble Modifier -`_ +`_ and is an abstract object that can be applied to a large set of reproducible specifications. Modifiers are intended to encapsulate reusable patterns that perform a specific configuration of an experiment. This may include injecting