ewoksid13.mcp.tools.integration.pyfai_integration_tool#
- ewoksid13.mcp.tools.integration.pyfai_integration_tool(bliss_filenames, pyfai_configurations, detectors=None, scans=None, subscans=None, save_separate_files=False, save_pyfai_config=True, output_root_folder=None, tag='', submit_parameters=None)[source]#
Run a pyFAI integration workflow from an MCP tool call.
It accepts user-provided integration settings, normalizes tool inputs, and triggers workflow submission/execution according to
submit_parameters.- Return type:
List[Dict]
Parameters#
- bliss_filenamesstr | list[str]
One BLISS HDF5 filename or a list of filenames to process.
- pyfai_configurationsstr | list[str] | list[dict]
One pyFAI configuration or a list of configurations (typically
.poni/.jsonfiles).- detectorsstr | list[str], optional
Detector name(s) to filter on. If
None, process all compatible detectors.- scansint | list[int], optional
Scan number(s) to process. If
None, process all scans.- subscansint | list[int], optional
Subscan number(s) to process. If
None, process all subscans.- save_separate_filesbool, default=False
Save integrated data in separate files when
True.- save_pyfai_configbool, default=True
Persist the effective pyFAI configuration near generated outputs.
- output_root_folderstr, optional
Custom output root directory. If
None, default project rules apply.- tagstr, default=””
Suffix added to job/output names to distinguish runs.
- submit_parametersdict, optional
Submission/execution options (for example queue/slurm settings and dry-run behavior via
submit).
Returns#
- list[dict]
A list of dictionaries, each containing the job ID and worker type of a submitted job.
- type bliss_filenames:
Union[str,List[str]]- param bliss_filenames:
- type pyfai_configurations:
Union[str,List[str],List[Dict]]- param pyfai_configurations:
- type detectors:
Union[str,List[str],None]- param detectors:
- type scans:
Union[int,List[int],None]- param scans:
- type subscans:
Union[int,List[int],None]- param subscans:
- type save_separate_files:
Optional[bool]- param save_separate_files:
- type save_pyfai_config:
Optional[bool]- param save_pyfai_config:
- type output_root_folder:
Optional[str]- param output_root_folder:
- type tag:
Optional[str]- param tag:
- type submit_parameters:
Optional[Dict]- param submit_parameters: