Expose ExperimentInfo::populateInstrumentParameters (#39184)

ekapadi · Kort Travis · web-flow · commit fd03112235b7 · 2025-04-10T21:37:49.000-04:00
* Expose 'ExperimentInfo::populateInstrumentParameters' to the Python api.

* Added release note.

---------

Co-authored-by: Kort Travis &lt;traviska@ornl.gov&gt;
diff --git a/Framework/PythonInterface/mantid/api/src/Exports/ExperimentInfo.cpp b/Framework/PythonInterface/mantid/api/src/Exports/ExperimentInfo.cpp
@@ -119,5 +119,7 @@ void export_ExperimentInfo() {
            ":class:`~mantid.geometry.ComponentInfo` "
            "object.")
       .def("setSample", setSample, args("self", "sample"))
-      .def("setRun", setRun, args("self", "run"));
+      .def("setRun", setRun, args("self", "run"))
+      .def("populateInstrumentParameters", &ExperimentInfo::populateInstrumentParameters, (arg("self")),
+           "Update parameters in the instrument-parameter map. Logs must be loaded before calling this method");
 }
diff --git a/docs/source/release/v6.12.0/Framework/Python/New_features/38684.rst b/docs/source/release/v6.12.0/Framework/Python/New_features/38684.rst
@@ -0,0 +1 @@
+- Exposed `ExperimentInfo.populateInstrumentParameters` to the Python api.  This will facilitate the update of parameterized instruments from Python, allowing parameters to be directly transferred as properties without converting to and from `string`.

Original file line number	Diff line number	Diff line change
`@@ -119,5 +119,7 @@ void export_ExperimentInfo() {`
`119`	`119`	":class:`~mantid.geometry.ComponentInfo` "
`120`	`120`	`"object.")`
`121`	`121`	`.def("setSample", setSample, args("self", "sample"))`
`122`		`- .def("setRun", setRun, args("self", "run"));`
	`122`	`+ .def("setRun", setRun, args("self", "run"))`
	`123`	`+ .def("populateInstrumentParameters", &ExperimentInfo::populateInstrumentParameters, (arg("self")),`
	`124`	`+ "Update parameters in the instrument-parameter map. Logs must be loaded before calling this method");`
`123`	`125`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+- Exposed `ExperimentInfo.populateInstrumentParameters` to the Python api. This will facilitate the update of parameterized instruments from Python, allowing parameters to be directly transferred as properties without converting to and from `string`.