From 73c67224a318b8006da4ce141e7cbaa9b337a74c Mon Sep 17 00:00:00 2001 From: Yuchen Xiao Date: Sun, 15 Nov 2026 12:38:09 -0500 Subject: [PATCH 1/3] feat: reuse constrain variables across `solve` --- news/keep-constraints.rst | 23 ++++ .../refinement_session.py | 24 +++-- tests/test_refinement_session.py | 100 ++++++++++++++++++ 3 files changed, 137 insertions(+), 10 deletions(-) create mode 100644 news/keep-constraints.rst diff --git a/news/keep-constraints.rst b/news/keep-constraints.rst new file mode 100644 index 0000000..d1db649 --- /dev/null +++ b/news/keep-constraints.rst @@ -0,0 +1,23 @@ +**Added:** + +* Reuse constraints variables across recipe to avoid rebuilding recipe every time. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/src/diffpy/apps/parametric_refinement/refinement_session.py b/src/diffpy/apps/parametric_refinement/refinement_session.py index 3003dff..5325d83 100644 --- a/src/diffpy/apps/parametric_refinement/refinement_session.py +++ b/src/diffpy/apps/parametric_refinement/refinement_session.py @@ -509,8 +509,9 @@ def _solve( ftol=1e-8, xtol=1e-8, ): - recipe = FitRecipe() - self.recipes_dict[name] = recipe + if name not in self.recipes_dict: + self.recipes_dict[name] = FitRecipe() + recipe = self.recipes_dict[name] if weights is None: weights = numpy.ones(len(profiles)) if residual_equations is None: @@ -521,6 +522,8 @@ def _solve( for i in range(len(metas)): profiles[i].meta.update(metas[i]) for i in range(len(models)): + if models[i].name in recipe._contributions: + continue if isinstance(models[i], ParametricModelEquation): models[i].set_profile(profiles[i]) models[i]._contribution.set_residual_equation( @@ -539,11 +542,13 @@ def _solve( if constraints: for var_name, value in constraints[0].items(): - if var_name not in recipe._parameters: + if var_name in recipe._parameters: + recipe._parameters[var_name].value = value + else: recipe.create_new_variable(var_name, value) - for constrained_name, constraint_eq_str in constraints[1].items(): - constrained_var = self.get_variable(constrained_name)["obj"] - recipe.add_constraint(constrained_var, constraint_eq_str) + for constrained_name, eq_str in constraints[1].items(): + par = self.get_variable(constrained_name)["obj"] + recipe.add_constraint(par, eq_str) variables = [self.get_variable(name)["obj"] for name in variable_names] variable_names = ["_".join(name.split(".")) for name in variable_names] @@ -587,10 +592,9 @@ def _solve( except TypeError: result_string = "Refinement Finished." - if constraints: - for constrained_name, constraint_eq_str in constraints[1].items(): - constrained_var = self.get_variable(constrained_name)["obj"] - recipe.remove_constraint(constrained_var) + for par in list(recipe._constraints): + recipe.remove_constraint(par) + return { "success": bool(result.success), "status": int(result.status), diff --git a/tests/test_refinement_session.py b/tests/test_refinement_session.py index a89ee44..1352ca8 100644 --- a/tests/test_refinement_session.py +++ b/tests/test_refinement_session.py @@ -282,6 +282,106 @@ def test_constraints(): assert len(recipe._constraints) == 0 +def test_constraints_reuse_recipe(): + # C1: Solve with a=b=c constraints, then solve again with the same recipe + # and add alpha=beta=gamma=90 constraints (fixed, not refined). + # Expect the refined parameters are close to the true values. + session = RefinementSession() + session.add_profile_from_file( + profile_name="ni_profile", profile_path=str(_DATA_DIR / "Ni.gr") + ) + session.set_profile_calculation_range( + profile_name="ni_profile", + xmin=1.5, + xmax=20, + dx=0.01, + ) + session.update_profile_meta( + profile_name="ni_profile", + meta={"qmin": 0.1}, + ) + session.add_pdf_model( + model_name="pdf", + structure_file_path=str(_DATA_DIR / "Ni.cif"), + finite=False, + ) + session.set_variables_value( + name_value_dict={ + "pdf.phase.lattice.a": 3.52, + "pdf.scale": 0.4, + "pdf.phase.Ni0.Uiso": 0.005, + "pdf.delta2": 2, + "pdf.qdamp": 0.04, + "pdf.qbroad": 0.02, + }, + ) + uiso_constraints = { + "pdf.phase.Ni0.Uiso": "uiso", + "pdf.phase.Ni1.Uiso": "uiso", + "pdf.phase.Ni2.Uiso": "uiso", + "pdf.phase.Ni3.Uiso": "uiso", + } + lattice_constraints = { + "pdf.phase.lattice.a": "lattice", + "pdf.phase.lattice.b": "lattice", + "pdf.phase.lattice.c": "lattice", + } + angle_constraints = { + "pdf.phase.lattice.alpha": "angle", + "pdf.phase.lattice.beta": "angle", + "pdf.phase.lattice.gamma": "angle", + } + variable_names = [ + "lattice", + "pdf.scale", + "uiso", + "pdf.delta2", + "pdf.qdamp", + "pdf.qbroad", + ] + recipe_name = "ni_recipe" + session.solve( + name=recipe_name, + profile_names=["ni_profile"], + model_names=["pdf"], + constraints=[ + {"lattice": 3.52, "uiso": 0.005}, + {**lattice_constraints, **uiso_constraints}, + ], + variable_names=variable_names, + ) + session.solve( + name=recipe_name, + profile_names=["ni_profile"], + model_names=["pdf"], + constraints=[ + {"lattice": 3.52, "uiso": 0.005, "angle": 90}, + {**lattice_constraints, **uiso_constraints, **angle_constraints}, + ], + variable_names=variable_names, + ) + name_to_cmi_name = { + "pdf.scale": "s0", + "pdf.phase.lattice.a": "G1_a", + "pdf.phase.Ni0.Uiso": "G1_Uiso_0", + "pdf.delta2": "G1_delta2", + "pdf.qdamp": "qdamp", + "pdf.qbroad": "qbroad", + } + ni_refined_parameters = run_ni_example() + for name, cmi_name in name_to_cmi_name.items(): + assert numpy.isclose( + session.get_variable(name)["value"], + ni_refined_parameters[cmi_name], + rtol=1e-2, + ) + for angle in ["alpha", "beta", "gamma"]: + assert ( + session.get_variable(f"pdf.phase.lattice.{angle}")["value"] == 90 + ) + assert len(session.recipes_dict[recipe_name]._constraints) == 0 + + def test_refine_multi_contribution(): session = RefinementSession() session.add_profile_from_file( From 49106fa1d7ce80de6e238919213679022c7258e4 Mon Sep 17 00:00:00 2001 From: Yuchen Xiao Date: Sun, 15 Nov 2026 14:24:02 -0500 Subject: [PATCH 2/3] chore: fix `tests_on_pr` --- src/diffpy/apps/parametric_refinement/refinement_session.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/diffpy/apps/parametric_refinement/refinement_session.py b/src/diffpy/apps/parametric_refinement/refinement_session.py index 5325d83..8fb3744 100644 --- a/src/diffpy/apps/parametric_refinement/refinement_session.py +++ b/src/diffpy/apps/parametric_refinement/refinement_session.py @@ -554,8 +554,9 @@ def _solve( variable_names = ["_".join(name.split(".")) for name in variable_names] tag_manager = recipe._tagmanager for i, var in enumerate(variables): - if var in recipe._parameters.values(): - tag_manager.tag(var, "listed_var") + existing = recipe._parameters.get(variable_names[i]) + if existing is not None: + tag_manager.tag(existing, "listed_var") continue if var.name in recipe._parameters: recipe.delete_variable(recipe._parameters[var.name]) From d9e73352688e3509c3fafb39516a1d1234498af1 Mon Sep 17 00:00:00 2001 From: Yuchen Xiao Date: Sun, 15 Nov 2026 16:07:45 -0500 Subject: [PATCH 3/3] feat: reuse restraints across `solve` --- src/diffpy/apps/parametric_refinement/refinement_session.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/diffpy/apps/parametric_refinement/refinement_session.py b/src/diffpy/apps/parametric_refinement/refinement_session.py index 8fb3744..303ca03 100644 --- a/src/diffpy/apps/parametric_refinement/refinement_session.py +++ b/src/diffpy/apps/parametric_refinement/refinement_session.py @@ -587,6 +587,7 @@ def _solve( ftol=ftol, xtol=xtol, ) + recipe.residual(result.x) # NOTE: non-scalar value will raise error in `get_results_string` try: result_string = FitResults(recipe).get_results_string() @@ -595,7 +596,8 @@ def _solve( for par in list(recipe._constraints): recipe.remove_constraint(par) - + if recipe._restraints: + recipe.remove_soft_bounds(*recipe._restraints) return { "success": bool(result.success), "status": int(result.status),