Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions news/keep-constraints.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* Reuse constraints variables across recipe to avoid rebuilding recipe every time.

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
31 changes: 19 additions & 12 deletions src/diffpy/apps/parametric_refinement/refinement_session.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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(
Expand All @@ -539,18 +542,21 @@ 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]
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])
Expand Down Expand Up @@ -581,16 +587,17 @@ 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()
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)
if recipe._restraints:
recipe.remove_soft_bounds(*recipe._restraints)
return {
"success": bool(result.success),
"status": int(result.status),
Expand Down
100 changes: 100 additions & 0 deletions tests/test_refinement_session.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
Loading