add comment and print statements showing whats been initialized

Author: cadenmyers13

src/diffpy/srfit/fitbase/fitrecipe.py

@@ -1498,25 +1498,38 @@ def _prepare_results_for_initialization(self, results):
             raise ValueError(
                 "results must be a FitResults object, str, or pathlib.Path"
             )
-        # Remove metrics like Rw from the dict, leaving only parameter values
+        # Remove metrics like Rw from the dict, leaving only parameter values.
+        # If a non-refinable quantity is ever stored as a tuple in the
+        # results dictionary, it will be incorrectly treated as a parameter
+        # and included here, which could lead to errors.
         parameters_dict = {
             k: v for k, v in results_dict.items() if isinstance(v, tuple)
         }
         return parameters_dict
 
-    def initialize_recipe_from_results(self, results):
+    def initialize_recipe_from_results(self, results, verbose=True):
         """Initialize the variable values from a previous fit result.
 
         Parameters
         ----------
         results : FitResults object, str, or pathlib.Path object
             The results from a previous fit. These results should
             have the same parameters as the current FitRecipe.
+        verbose : bool, optional
+            If True, print the initialized parameter values. Default is True.
         """
         parameters_dict = self._prepare_results_for_initialization(results)
+
+        if verbose:
+            print("\nInitializing FitRecipe from results")
+            print("-" * 40)
+        if verbose and parameters_dict:
+            width = max(len(name) for name in parameters_dict)
         for name, (value, uncertainty) in parameters_dict.items():
             if name in self._parameters:
                 self._parameters[name].setValue(value)
+                if verbose:
+                    print(f"{name:<{width}} = {value}")
 
 
 # End of file

src/diffpy/srfit/fitbase/fitresults.py

@@ -918,8 +918,11 @@ def initializeRecipe(recipe, results):
 
     ::
 
-        from diffpy.srfit.fitbase import FitRecipe, FitResults
         from scipy.optimize import leastsq
+        import numpy as np
+        from diffpy.srfit.fitbase import (
+            Profile, FitRecipe, FitResults, FitContribution
+            )
 
         def optimize_recipe(recipe):
             residuals = recipe.residual
@@ -928,8 +931,8 @@ def optimize_recipe(recipe):
 
 
         profile = Profile()
-        x = linspace(0, pi, 10)
-        y = sin(x)
+        x = np.linspace(0, np.pi, 10)
+        y = np.sin(x)
         profile.set_observed_profile(x, y)
         contribution = FitContribution("c1")
         contribution.set_profile(profile)
@@ -944,6 +947,10 @@ def optimize_recipe(recipe):
         results = FitResults(recipe)
 
         new_recipe = FitRecipe("my_recipe")
+        new_recipe.add_contribution(contribution)
+        new_recipe.add_variable(contribution.amplitude, 0)
+        new_recipe.add_variable(contribution.wave_number, 0)
+        new_recipe.add_variable(contribution.phase_shift, 0)
         new_recipe.initialize_recipe_from_results(results)
     """
     mpairs = resultsDictionary(results)