.. Copyright 2023 Lawrence Livermore National Security, LLC and other
   Benchpark Project Developers. See the top-level COPYRIGHT file for details.

   SPDX-License-Identifier: Apache-2.0

========================
Compare Experiment Specs
========================
``lib/scripts/diffExperimentSpecs.py``

Compare two experiment specs `.yaml` files generated by ``benchpark experiment init``.
This script enables the user to compare changes to a ``experiment.py`` between commits
by comparing ``.yaml`` files generated from ``benchpark experiment init ...``.
This script is helpful when it is unclear if changes made to ``experiment.py`` will affect the resulting experiment spec.

Stages that occur during this script:
   - ``benchpark experiment init``

Example: Change n_ranks in Saxpy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In this example, we modify the ``saxpy+openmp`` experiment to see how the script identifies the differences.
On the branch ``myBranch``, we change ``self.add_experiment_variable("n_ranks", "8")`` to ``self.add_experiment_variable("n_ranks", "4")``. 

.. code-block:: console

   $ benchpark-python diffExperimentSpecs.py -n myBranch -e saxpy+openmp

   saxpy+openmp
         saxpy/openmp/ramble.yaml
                  The YAML files benchpark-old/saxpy/openmp/ramble.yaml and benchpark-new/saxpy/openmp/ramble.yaml are different. Here are the differences:
                     {'values_changed': {"root['ramble']['applications']['saxpy']['workloads']['problem']['experiments']['saxpy_problem_single_node_openmp_caliper_none_{n_nodes}_{n_threads_per_proc}_{n}']['variables']['n_ranks']": {'new_value': 4,
                                                                                                                                                                                                                                       'old_value': 8}}}