MX Beamline Automation tasks

How to use

These tasks come from bes. It can be installed with

pip install bes

ℹ️ These tasks are used at the following ESRF beamlines: ID23-1, ID23-2, ID30A-1, ID30A-3, ID30B

autoMesh

Identifier:

bes.actors.autoMesh.run

Task type:

ppfmethod

Required inputs:

beamline, icat_beamline, workflowParameters, raw_directory, run_number

Optional inputs:

proposal, isHorizontalRotationAxis, pyarch_html_dir, dataCollectionGroupComment, numberOfPositions, targetApertureName, mxcubeParameters, doTwoMeshes, workflow_index, loopMinWidth, loopMaxWidth, besParameters, workflow_title, workflow_type

Outputs:

return_value

besTestExecution

Identifier:

bes.actors.besTestExecution.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

callBackHost, callBackPort, sleep

Outputs:

return_value

best3d_characterisation_mxv1

Identifier:

bes.actors.best3d_characterisation_mxv1.run

Task type:

ppfmethod

Required inputs:

beamline, mxv1StrategyResultFile, directory, run_number, expTypePrefix, prefix, suffix, flux, beamSizeX, beamSizeY, workflow_type, workflow_working_dir, list_node_id, workflowParameters

Optional inputs:

sampleInfo, transmission, resolution, omegaMin, apertureSize, minExposureTime, pyarch_html_dir, strategyOption, anomalousData, crystalSizeX, crystalSizeY, crystalSizeZ, aimedCompleteness, aimedMultiplicity, sampleSusceptibility, forcedSpaceGroup, characterisationComment, doseLimit, rFriedel, complexity, aimedIOverSigmaAtHighestResolution, mxcubeParameters

Outputs:

return_value

burnStrategyNoReferenceImages

Identifier:

bes.actors.burnStrategyNoReferenceImages.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, characterisationOscillationRange, characterisationExposureTime, characterisationTransmission

Optional inputs:

resolution, automatic_mode, collection_software, mxcubeParameters

Outputs:

return_value

burn_strategy_display_results

Identifier:

bes.actors.burn_strategy_display_results.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, result_rdfit_htmlPage, result_rdfit_jsonPath, result_rdfit_scaleIntensityPlot

Optional inputs:

pyarch_html_dir, list_node_id, mxcubeParameters

Outputs:

return_value

calibrateKappa

Identifier:

bes.actors.calibrateKappa.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

isHorizontalRotationAxis, mxcubeParameters

Outputs:

return_value

centerRotationAxis_move180Degrees

Identifier:

bes.actors.centerRotationAxis_move180Degrees.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, run_number, newMotorPositions, savedMotorPositions

Optional inputs:

mxcubeParameters

Outputs:

return_value

centerRotationAxis_moveToNewAxisPosition

Identifier:

bes.actors.centerRotationAxis_moveToNewAxisPosition.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, newMotorPositions, motorInitialPositions, grid_info, phiy_scan1, phiz_scan1, run_number, meshPositionFiles

Optional inputs:

diffractionSignalDetection, mxcubeParameters

Outputs:

return_value

centerRotationAxis_prepareFirst1Dscan

Identifier:

bes.actors.centerRotationAxis_prepareFirst1Dscan.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, raw_directory, process_directory, run_number, prefix, suffix, gridExposureTime, gridOscillationRange, lineScanLength, lineScanOverSampling

Optional inputs:

gridTransmission, mxcubeParameters, meshPositionsAcquired, centre_beam_before_scans

Outputs:

return_value

centreBeam

Identifier:

bes.actors.centreBeam.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

Outputs:

return_value

centrePin

Identifier:

bes.actors.centrePin.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

findLargestMesh, pyarch_html_dir, isHorizontalRotationAxis, numberOfPositions, targetApertureName, mxcubeParameters

Outputs:

return_value

characterisationCheckDataCollection

Identifier:

bes.actors.characterisationCheckDataCollection.run

Task type:

ppfmethod

Required inputs:

inputFile, workingDirectory

Optional inputs:

beamline, proposal, logFile

Outputs:

return_value

characterisationCompare

Identifier:

bes.actors.characterisationCompare.run

Task type:

ppfmethod

Required inputs:

outputFile, indexingOutput

Optional inputs:

Outputs:

return_value

characterisationEdna2Indexing

Identifier:

bes.actors.characterisationEdna2Indexing.run

Task type:

ppfmethod

Required inputs:

indexingInput, workingDirectory

Optional inputs:

Outputs:

return_value

characterisationError

Identifier:

bes.actors.characterisationError.run

Task type:

ppfmethod

Required inputs:

outputFile

Optional inputs:

logFile

Outputs:

return_value

characterisationPrepareEdna2

Identifier:

bes.actors.characterisationPrepareEdna2.run

Task type:

ppfmethod

Required inputs:

inputFile

Optional inputs:

Outputs:

return_value

checkDistlServer

Identifier:

bes.actors.checkDistlServer.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters

Optional inputs:

mxcubeParameters

Outputs:

return_value

checkMoveOfPhi

Identifier:

bes.actors.checkMoveOfPhi.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

mxcubeParameters

Outputs:

return_value

checkMoveToNewKappaAngles

Identifier:

bes.actors.checkMoveToNewKappaAngles.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, phi, kappa, kappa_phi, newPhi, newKappa, newKappa_phi

Optional inputs:

mxcubeParameters

Outputs:

return_value

checkMoveToNewSamplePosition

Identifier:

bes.actors.checkMoveToNewSamplePosition.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, sampx, sampy, phiy, newSampx, newSampy, newPhiy

Optional inputs:

mxcubeParameters

Outputs:

return_value

chipx_collect

Identifier:

bes.actors.chipx_collect.run

Task type:

ppfmethod

Required inputs:

beamline, prefix, run_number, exposureTime, oscillationWidth, workflowParameters, transmission, resolution, raw_directory, sample_node_id

Optional inputs:

no_lines, mxcubeParameters

Outputs:

return_value

chipx_collect_dialog

Identifier:

bes.actors.chipx_collect_dialog.run

Task type:

ppfmethod

Required inputs:

beamline, directory, collection_software, workflowParameters

Optional inputs:

transmission, no_lines, exposureTime, oscillationWidth, resolution, mxcubeParameters

Outputs:

return_value

chipx_collect_sections_dialog

Identifier:

bes.actors.chipx_collect_sections_dialog.run

Task type:

ppfmethod

Required inputs:

beamline, directory, collection_software, workflowParameters

Optional inputs:

transmission, no_lines, exposureTime, resolution, mxcubeParameters

Outputs:

return_value

chipx_left_position

Identifier:

bes.actors.chipx_left_position.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, raw_directory, mxcubeParameters

Optional inputs:

Outputs:

return_value

chipx_right_position

Identifier:

bes.actors.chipx_right_position.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, raw_directory, mxcubeParameters

Optional inputs:

Outputs:

return_value

collectAndSpectraUserInput

Identifier:

bes.actors.collectAndSpectraUserInput.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, motorPositions

Optional inputs:

collection_software, mxcubeParameters

Outputs:

return_value

collect_centerSamplePos

Identifier:

bes.actors.collect_centerSamplePos.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, workflow_type, sampleInfo

Optional inputs:

mxcubeParameters

Outputs:

return_value

collect_centerSamplePos1

Identifier:

bes.actors.collect_centerSamplePos1.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, workflow_type, sampleInfo

Optional inputs:

mxcubeParameters

Outputs:

return_value

collect_centerSamplePos2

Identifier:

bes.actors.collect_centerSamplePos2.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, workflow_type, sampleInfo

Optional inputs:

mxcubeParameters

Outputs:

return_value

collect_start

Identifier:

bes.actors.collect_start.run

Task type:

ppfmethod

Required inputs:

beamline, directory, process_directory, beamParameters, prefix, expTypePrefix, run_number, mxv1StrategyResultFile, motorPositions, suffix, workflowParameters

Optional inputs:

sampleInfo, resolution, mxv1ResultCharacterisationFile, cellSpaceGroup, autoMeshPhiPosition, mxcubeParameters, fineSlicedReferenceImages, characterisation_id, kappa_settings_id, position_id, besParameters

Outputs:

return_value

commonPrepareDehydration

Identifier:

bes.actors.commonPrepareDehydration.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

commonPrepareEnhancedCharacterisation

Identifier:

bes.actors.commonPrepareEnhancedCharacterisation.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

commonPrepareLowDoseDC

Identifier:

bes.actors.commonPrepareLowDoseDC.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

commonPrepareTestBest3DCharacterisation

Identifier:

bes.actors.commonPrepareTestBest3DCharacterisation.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_default_parameters

Identifier:

bes.actors.common_default_parameters.run

Task type:

ppfmethod

Required inputs:

directory, prefix, run_number, beamline, motorPositions, workflowParameters

Optional inputs:

expTypePrefix, suffix, characterisationExposureTime, gridExposureTime, collectExposureTime, transmission, gridTransmission, collectTransmission, characterisationTransmission, doRefDataCollectionReview, plateMode, gridSnapShots, lineScanLength, fineSlicedReferenceImages, process_partial_data_sets, characterisation_id, position_id, kappa_settings_id, mxcubeParameters

Outputs:

return_value

common_prepare_MXPressF_twoMeshes

Identifier:

bes.actors.common_prepare_MXPressF_twoMeshes.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_burn_strategy

Identifier:

bes.actors.common_prepare_burn_strategy.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_centreBeam

Identifier:

bes.actors.common_prepare_centreBeam.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

beamline

Outputs:

return_value

common_prepare_chipx_collect

Identifier:

bes.actors.common_prepare_chipx_collect.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_chipx_collect_sections

Identifier:

bes.actors.common_prepare_chipx_collect_sections.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_chipx_left_position

Identifier:

bes.actors.common_prepare_chipx_left_position.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_chipx_right_position

Identifier:

bes.actors.common_prepare_chipx_right_position.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_distanceCalibration

Identifier:

bes.actors.common_prepare_distanceCalibration.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

beamline

Outputs:

return_value

common_prepare_energyInterleavedMAD

Identifier:

bes.actors.common_prepare_energyInterleavedMAD.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

beamline

Outputs:

return_value

common_prepare_helical_characterisation

Identifier:

bes.actors.common_prepare_helical_characterisation.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_kappa

Identifier:

bes.actors.common_prepare_kappa.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_mesh1D

Identifier:

bes.actors.common_prepare_mesh1D.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mesh2D

Identifier:

bes.actors.common_prepare_mesh2D.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mesh2D_auto

Identifier:

bes.actors.common_prepare_mesh2D_auto.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mesh_and_burn

Identifier:

bes.actors.common_prepare_mesh_and_burn.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mesh_and_collect

Identifier:

bes.actors.common_prepare_mesh_and_collect.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mesh_and_collect_from_file

Identifier:

bes.actors.common_prepare_mesh_and_collect_from_file.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mesh_ice_rings

Identifier:

bes.actors.common_prepare_mesh_ice_rings.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_meshbest3d

Identifier:

bes.actors.common_prepare_meshbest3d.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mxpress_setup

Identifier:

bes.actors.common_prepare_mxpress_setup.run

Task type:

ppfmethod

Required inputs:

directory, beamline

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa

Identifier:

bes.actors.common_prepare_mxpressa.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_3500Gy

Identifier:

bes.actors.common_prepare_mxpressa_3500Gy.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_aperture_100um

Identifier:

bes.actors.common_prepare_mxpressa_aperture_100um.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_aperture_10um

Identifier:

bes.actors.common_prepare_mxpressa_aperture_10um.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_aperture_15um

Identifier:

bes.actors.common_prepare_mxpressa_aperture_15um.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_aperture_30um

Identifier:

bes.actors.common_prepare_mxpressa_aperture_30um.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_aperture_50um

Identifier:

bes.actors.common_prepare_mxpressa_aperture_50um.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_aperture_Outbeam

Identifier:

bes.actors.common_prepare_mxpressa_aperture_Outbeam.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_dozor

Identifier:

bes.actors.common_prepare_mxpressa_dozor.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_dozorm

Identifier:

bes.actors.common_prepare_mxpressa_dozorm.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_globalp

Identifier:

bes.actors.common_prepare_mxpressa_globalp.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_globalp_full

Identifier:

bes.actors.common_prepare_mxpressa_globalp_full.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_globalp_minimal

Identifier:

bes.actors.common_prepare_mxpressa_globalp_minimal.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_globalp_quick

Identifier:

bes.actors.common_prepare_mxpressa_globalp_quick.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_htx

Identifier:

bes.actors.common_prepare_mxpressa_htx.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressa_meshBest

Identifier:

bes.actors.common_prepare_mxpressa_meshBest.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_mxpresse

Identifier:

bes.actors.common_prepare_mxpresse.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mxpresse_red

Identifier:

bes.actors.common_prepare_mxpresse_red.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mxpresse_sad

Identifier:

bes.actors.common_prepare_mxpresse_sad.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mxpressemulti

Identifier:

bes.actors.common_prepare_mxpressemulti.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressf

Identifier:

bes.actors.common_prepare_mxpressf.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mxpressi

Identifier:

bes.actors.common_prepare_mxpressi.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mxpressk

Identifier:

bes.actors.common_prepare_mxpressk.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mxpressl

Identifier:

bes.actors.common_prepare_mxpressl.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mxpressm

Identifier:

bes.actors.common_prepare_mxpressm.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

grid_info, expTypePrefix

Outputs:

return_value

common_prepare_mxpresso

Identifier:

bes.actors.common_prepare_mxpresso.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mxpresso_540

Identifier:

bes.actors.common_prepare_mxpresso_540.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_mxpressp

Identifier:

bes.actors.common_prepare_mxpressp.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressp_sad

Identifier:

bes.actors.common_prepare_mxpressp_sad.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressr

Identifier:

bes.actors.common_prepare_mxpressr.run

Task type:

ppfmethod

Required inputs:

beamline, directory, prefix

Optional inputs:

mxcubeParameters

Outputs:

return_value

common_prepare_mxpressr_180

Identifier:

bes.actors.common_prepare_mxpressr_180.run

Task type:

ppfmethod

Required inputs:

beamline, directory, prefix

Optional inputs:

mxcubeParameters

Outputs:

return_value

common_prepare_mxpressr_180_setup

Identifier:

bes.actors.common_prepare_mxpressr_180_setup.run

Task type:

ppfmethod

Required inputs:

directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpressr_dehydration

Identifier:

bes.actors.common_prepare_mxpressr_dehydration.run

Task type:

ppfmethod

Required inputs:

beamline, directory, prefix

Optional inputs:

mxcubeParameters

Outputs:

return_value

common_prepare_mxpressr_dehydration_1min_1pc

Identifier:

bes.actors.common_prepare_mxpressr_dehydration_1min_1pc.run

Task type:

ppfmethod

Required inputs:

beamline, directory, prefix

Optional inputs:

mxcubeParameters

Outputs:

return_value

common_prepare_mxpressr_dehydration_2min_1pc

Identifier:

bes.actors.common_prepare_mxpressr_dehydration_2min_1pc.run

Task type:

ppfmethod

Required inputs:

beamline, directory, prefix

Optional inputs:

mxcubeParameters

Outputs:

return_value

common_prepare_mxpressr_dehydration_2min_5pc

Identifier:

bes.actors.common_prepare_mxpressr_dehydration_2min_5pc.run

Task type:

ppfmethod

Required inputs:

beamline, directory, prefix

Optional inputs:

mxcubeParameters

Outputs:

return_value

common_prepare_mxpressr_dehydration_5min_5pc

Identifier:

bes.actors.common_prepare_mxpressr_dehydration_5min_5pc.run

Task type:

ppfmethod

Required inputs:

beamline, directory, prefix

Optional inputs:

mxcubeParameters

Outputs:

return_value

common_prepare_mxpressr_dehydration_setup

Identifier:

bes.actors.common_prepare_mxpressr_dehydration_setup.run

Task type:

ppfmethod

Required inputs:

beamline, directory, prefix

Optional inputs:

mxcubeParameters

Outputs:

return_value

common_prepare_mxpressr_setup

Identifier:

bes.actors.common_prepare_mxpressr_setup.run

Task type:

ppfmethod

Required inputs:

directory

Optional inputs:

Outputs:

return_value

common_prepare_mxpresss

Identifier:

bes.actors.common_prepare_mxpresss.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

Outputs:

return_value

common_prepare_mxscore

Identifier:

bes.actors.common_prepare_mxscore.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

grid_info, expTypePrefix

Outputs:

return_value

common_prepare_radiation_damage

Identifier:

bes.actors.common_prepare_radiation_damage.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_serial_data_collection

Identifier:

bes.actors.common_prepare_serial_data_collection.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_smallXrayCentring

Identifier:

bes.actors.common_prepare_smallXrayCentring.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

besParameters, workflow_parameters, expTypePrefix

Outputs:

return_value

common_prepare_testAutoInsitu

Identifier:

bes.actors.common_prepare_testAutoInsitu.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

beamline

Outputs:

return_value

common_prepare_testAutoMesh

Identifier:

bes.actors.common_prepare_testAutoMesh.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_testCenterRotationAxis

Identifier:

bes.actors.common_prepare_testCenterRotationAxis.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_testCenterRotationAxis_totalIntensity

Identifier:

bes.actors.common_prepare_testCenterRotationAxis_totalIntensity.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_testCollectAndSpectra

Identifier:

bes.actors.common_prepare_testCollectAndSpectra.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

beamline

Outputs:

return_value

common_prepare_testInterleavedMad

Identifier:

bes.actors.common_prepare_testInterleavedMad.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

beamline

Outputs:

return_value

common_prepare_testInversedLineScan

Identifier:

bes.actors.common_prepare_testInversedLineScan.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_threeMeshScans

Identifier:

bes.actors.common_prepare_threeMeshScans.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_time_resolved_mesh

Identifier:

bes.actors.common_prepare_time_resolved_mesh.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_twoMeshScans

Identifier:

bes.actors.common_prepare_twoMeshScans.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_vertcial_line_scan

Identifier:

bes.actors.common_prepare_vertcial_line_scan.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_visual_kappa

Identifier:

bes.actors.common_prepare_visual_kappa.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

common_prepare_xrayCentring

Identifier:

bes.actors.common_prepare_xrayCentring.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_xrayCentringAndCharacterisation

Identifier:

bes.actors.common_prepare_xrayCentringAndCharacterisation.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_prepare_xrayCentring_auto

Identifier:

bes.actors.common_prepare_xrayCentring_auto.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

expTypePrefix

Outputs:

return_value

common_workflow_finished_message

Identifier:

bes.actors.common_workflow_finished_message.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

message_text

Outputs:

return_value

correctID30A1phiy

Identifier:

bes.actors.correctID30A1phiy.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, motorPositions

Optional inputs:

mxcubeParameters

Outputs:

return_value

createLucidBackgroundImage

Identifier:

bes.actors.createLucidBackgroundImage.run

Task type:

ppfmethod

Required inputs:

directory

Optional inputs:

mxcubeParameters

Outputs:

return_value

createThumbnailsForPyarch

Identifier:

bes.actors.createThumbnailsForPyarch.run

Task type:

ppfmethod

Required inputs:

image_path, jpeg_path, jpeg_thumbnail_path

Optional inputs:

Outputs:

return_value

cryoemInitDataArchive

Identifier:

bes.actors.cryoemInitDataArchive.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

REFID, REQUESTID

Outputs:

return_value

cryoemInitGridProcess

Identifier:

bes.actors.cryoemInitGridProcess.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

REFID, REQUESTID

Outputs:

return_value

crystfel

Identifier:

bes.actors.crystfel.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, meshPositionFile, run_number, expTypePrefix, workflow_working_dir, prefix, suffix, workflow_id, grid_info, workflow_title, workflow_type, data_threshold, data_collection_max_positions, radius

Optional inputs:

list_node_id, firstImagePath, pyarch_html_dir, diffractionSignalDetection, resultMeshPath, mxcubeParameters

Outputs:

return_value

dehydrationAskIfContinue

Identifier:

bes.actors.dehydrationAskIfContinue.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, continue_dehydration, doDataCollection, automatic_mode

Optional inputs:

collection_software, transmission, mxcubeParameters, snapShots, characterisationExposureTime, no_reference_images, angle_between_reference_images

Outputs:

return_value

dehydrationAutomaticCarryOn

Identifier:

bes.actors.dehydrationAutomaticCarryOn.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, currentRH, endRH, step, steppingSign, automatic_mode

Optional inputs:

mxcubeParameters

Outputs:

return_value

dehydrationCarryOn

Identifier:

bes.actors.dehydrationCarryOn.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, currentRH, endRH, step, steppingSign, automatic_mode

Optional inputs:

mxcubeParameters

Outputs:

return_value

dehydrationDefaultValues

Identifier:

bes.actors.dehydrationDefaultValues.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

dehydrationDefineGradient

Identifier:

bes.actors.dehydrationDefineGradient.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, characterisationExposureTime, characterisationTransmission

Optional inputs:

automaticMode, mxcubeParameters, collection_software

Outputs:

return_value

dehydrationImageAnalysis

Identifier:

bes.actors.dehydrationImageAnalysis.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, dehydrationResults, list_node_id, mxv1StrategyResultFile, directory, run_number, expTypePrefix, prefix, suffix, startTime, currentRH, targetRH, continue_dehydration

Optional inputs:

diffractionSignalDetection, firstListDehydrationNodeId, transmission, firstDehydrationLoop, pyarch_html_dir, mxcubeParameters, firstImagePath

Outputs:

return_value

dehydrationInitLoop

Identifier:

bes.actors.dehydrationInitLoop.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, startRH, endRH, delay, motorPositions

Optional inputs:

bestPositionFound, pyarch_html_dir, mxcubeParameters

Outputs:

return_value

dehydrationNextStep

Identifier:

bes.actors.dehydrationNextStep.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, targetRH, steppingSign, step, doDataCollection, run_number, delay, phi_start

Optional inputs:

mxcubeParameters

Outputs:

return_value

dehydrationSetStartRH

Identifier:

bes.actors.dehydrationSetStartRH.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters

Optional inputs:

startRH, delay, mxcubeParameters

Outputs:

return_value

displayErrorMessage

Identifier:

bes.actors.displayErrorMessage.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

beamline, directory, workflowParameters, errorMessage, message_text, automatic_mode, collection_software, mxcubeParameters

Outputs:

return_value

distanceCalibrationDataCollections

Identifier:

bes.actors.distanceCalibrationDataCollections.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, raw_directory, process_directory, dataCollectionOscillationRange, prefix, expTypePrefix, run_number, suffix, csvOfResolutions, collectExposureTime, transmission, motorPositions, workflow_type, workflow_index, workflow_working_dir

Optional inputs:

sample_node_id, mxcubeParameters

Outputs:

return_value

distanceCalibrationUserInput

Identifier:

bes.actors.distanceCalibrationUserInput.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, motorPositions, prefix

Optional inputs:

collection_software, mxcubeParameters

Outputs:

return_value

eEDNACheckResults

Identifier:

bes.actors.eEDNACheckResults.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, run_number, mxv1ResultCharacterisationFile, doRefDataCollectionReview, lowResolution, highResolution

Optional inputs:

resolution, newDataCollection, mxcubeParameters, runGphlWorkflow, edna_characterisation_success

Outputs:

return_value

eEDNANoReferenceImages

Identifier:

bes.actors.eEDNANoReferenceImages.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, characterisationOscillationRange, characterisationExposureTime, characterisationTransmission

Optional inputs:

automatic_mode, resolution, collection_software, mxcubeParameters

Outputs:

return_value

ednaCharacterisation

Identifier:

bes.actors.ednaCharacterisation.run

Task type:

ppfmethod

Required inputs:

inputFile, outputFile, workingDirectory

Optional inputs:

logFile, ednaStartScript, pluginName, timeout

Outputs:

return_value

ednaPluginLauncher

Identifier:

bes.actors.ednaPluginLauncher.run

Task type:

ppfmethod

Required inputs:

inputFile, outputFile, workingDirectory, pluginName

Optional inputs:

debug, timeout

Outputs:

return_value

edna_characterisation_mxv1

Identifier:

bes.actors.edna_characterisation_mxv1.run

Task type:

ppfmethod

Required inputs:

beamline, proposal, mxv1StrategyResultFile, directory, run_number, expTypePrefix, prefix, suffix, flux, beamSizeX, beamSizeY, workflow_type, workflow_working_dir, list_node_id, workflowParameters

Optional inputs:

sampleInfo, characterisationTransmission, resolution, pyarch_html_dir, strategyOption, anomalousData, crystalSizeX, crystalSizeY, crystalSizeZ, aimedCompleteness, aimedMultiplicity, sampleSusceptibility, minExposureTime, forcedSpaceGroup, minOscWidth, fineSlicedReferenceImages, aimedIOverSigmaAtHighestResolution, characterisationOscillationRange, do_data_collect, do_data_collect_orig, diffractionSignalDetection, doseLimit, misalignedCrystalDetected, axisStart, axisRange, runGphlWorkflow, mxcubeParameters, strategyType, characterisation_id, kappa_settings_id, position_id, simulated_characterisation_results, besParameters

Outputs:

return_value

edna_characterisation_mxv2

Identifier:

bes.actors.edna_characterisation_mxv2.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, mxv1StrategyResultFile, directory, run_number, expTypePrefix, prefix, suffix, motorPositions, flux, beamSizeX, beamSizeY, kappaStrategyOption, workflow_working_dir

Optional inputs:

characterisationTransmission, pyarch_html_dir, list_node_id, forcedSpaceGroup, resolution, sampleInfo, characterisationComment, diffractionSignalDetection, anomalousData, mxcubeParameters

Outputs:

return_value

edna_pseudo_helical_characterisation_mxv1

Identifier:

bes.actors.edna_pseudo_helical_characterisation_mxv1.run

Task type:

ppfmethod

Required inputs:

beamline, proposal, mxv1CharacterisationStrategyResultFile, directory, run_number, expTypePrefix, prefix, suffix, flux, beamSizeX, beamSizeY, workflow_type, workflow_working_dir, list_node_id, workflowParameters, bestPosition, characterisation_images, characterisation_raw_directory

Optional inputs:

sampleInfo, characterisationTransmission, resolution, pyarch_html_dir, strategyOption, anomalousData, crystalSizeX, crystalSizeY, crystalSizeZ, aimedCompleteness, aimedMultiplicity, sampleSusceptibility, minExposureTime, forcedSpaceGroup, minOscWidth, aimedIOverSigmaAtHighestResolution, do_data_collect, do_data_collect_orig, diffractionSignalDetection, misalignedCrystalDetected, remainingPositions, mxcubeParameters, characterisation_id, kappa_settings_id, position_id, simulated_characterisation_results, besParameters

Outputs:

return_value

executeDozor2XrayCentering

Identifier:

bes.actors.executeDozor2XrayCentering.run

Task type:

ppfmethod

Required inputs:

beamline, directory, grid_info, workflowParameters, workflow_working_dir

Optional inputs:

resultMeshPath, mxcubeParameters

Outputs:

return_value

executeGphlWorkflow

Identifier:

bes.actors.executeGphlWorkflow.run

Task type:

ppfmethod

Required inputs:

beamline, proposal, workflowParameters, besParameters, prefix, suffix, raw_directory, workflow_type, sampleInfo, workflow_node_id, spot_xds_path, resolution

Optional inputs:

gphl_strategy_variant, workflow_id, mxcubeParameters, characterisation_id, kappa_settings_id, position_id, sample_name, group_by

Outputs:

return_value

executeMeshCalculateBestPosition

Identifier:

bes.actors.executeMeshCalculateBestPosition.run

Task type:

ppfmethod

Required inputs:

beamline, directory, meshPositionFile, run_number, workflow_working_dir, grid_info, firstImagePath, workflowParameters

Optional inputs:

weakDiffractionWarning, meshUpperThreshold, diffractionSignalDetection, numberOfPositions, moreSamples, remainingPositions, dozorThreshold, mxcubeParameters, dozorAllFile, meshZigZag, dozormTargetApertureSize, multiPositionIndex, isHorizontalRotationAxis, reject_level, position_id, simulated_grid_positions, doTwoMeshes

Outputs:

return_value

executeMeshUploadToISPyBNew

Identifier:

bes.actors.executeMeshUploadToISPyBNew.run

Task type:

ppfmethod

Required inputs:

beamline, directory, meshPositionFile, run_number, expTypePrefix, workflow_working_dir, prefix, suffix, workflow_id, firstImagePath, workflowParameters

Optional inputs:

mxcubeParameters

Outputs:

return_value

executeTestGphlWorkflow

Identifier:

bes.actors.executeTestGphlWorkflow.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, prefix, suffix, directory, raw_directory, motorPositions, workflow_type, sampleInfo, workflow_node_id

Optional inputs:

resolution, mxcubeParameters

Outputs:

return_value

executeTimeResolvedMesh

Identifier:

bes.actors.executeTimeResolvedMesh.run

Task type:

ppfmethod

Required inputs:

beamline, prefix, workflowParameters

Optional inputs:

sampleInfo, directory, process_directory, run_number, mxcubeParameters

Outputs:

return_value

execute_mesh_and_collect_start_mesh

Identifier:

bes.actors.execute_mesh_and_collect_start_mesh.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, workflow_index, workflow_type, grid_info, meshQueueListFile, motorPositions, directory, meshPositionFile, workflow_working_dir

Optional inputs:

group_node_id, sample_node_id, resolution, force_not_shutterless, mxcubeParameters, highResolution, lowResolution, characterisation_id, kappa_settings_id, position_id, besParameters

Outputs:

return_value

execute_mesh_create_thumbnails

Identifier:

bes.actors.execute_mesh_create_thumbnails.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, meshPositionFile, workflow_id, grid_info, workflow_working_dir, workflow_title, workflow_type, bestPosition, allPositionFile, run_number, expTypePrefix, prefix, suffix, firstImagePath, dict_html_pyarch

Optional inputs:

pyarch_html_dir, list_node_id, mxcubeParameters

Outputs:

return_value

execute_mesh_find_all_positions_upload_ispyb

Identifier:

bes.actors.execute_mesh_find_all_positions_upload_ispyb.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, meshPositionFile, run_number, expTypePrefix, workflow_working_dir, prefix, suffix, workflow_id, grid_info, workflow_title, workflow_type, data_threshold, data_collection_max_positions, radius

Optional inputs:

shape, list_node_id, firstImagePath, pyarch_html_dir, diffractionSignalDetection, resultMeshPath, mxcubeParameters, meshZigZag, dozorAllFile, isHorizontalRotationAxis, reject_level

Outputs:

return_value

execute_mesh_processData

Identifier:

bes.actors.execute_mesh_processData.run

Task type:

ppfmethod

Required inputs:

beamline, directory, run_number, meshPositions, workflow_working_dir, grid_info

Optional inputs:

mxcubeParameters

Outputs:

return_value

execute_mesh_redo_find_all_positions

Identifier:

bes.actors.execute_mesh_redo_find_all_positions.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, meshPositionFile, run_number, expTypePrefix, workflow_working_dir, prefix, suffix, workflow_id, grid_info, workflow_title, workflow_type, firstImagePath, data_threshold, data_collection_max_positions, data_collection_max_positions_orig, timeToReachHendersonLimit, data_collection_no_images, radius

Optional inputs:

list_node_id, diffractionSignalDetection, pyarch_html_dir, resultMeshPath, mxcubeParameters, dozormListPositions, isHorizontalRotationAxis, dozormCrystalMapPath, dozormImageNumberMapPath

Outputs:

return_value

execute_mesh_startDataCollection

Identifier:

bes.actors.execute_mesh_startDataCollection.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

execute_mesh_waitTillDataCollectionFinish

Identifier:

bes.actors.execute_mesh_waitTillDataCollectionFinish.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, meshPositions, run_number, expTypePrefix, workflow_working_dir, prefix, suffix, workflow_id, grid_info, workflow_title, workflow_type, firstImagePath

Optional inputs:

pyarch_html_dir, list_node_id, mxcubeParameters

Outputs:

return_value

execute_serial_data_dollection

Identifier:

bes.actors.execute_serial_data_dollection.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, workflow_index, workflow_type, grid_info, meshQueueList, phiz, directory, meshPositions, workflow_working_dir

Optional inputs:

group_node_id, sample_node_id, resolution, mxcubeParameters

Outputs:

return_value

extISPyBStatusError

Identifier:

bes.actors.extISPyBStatusError.run

Task type:

ppfmethod

Required inputs:

workflowParameters

Optional inputs:

mxcubeParameters

Outputs:

return_value

extractBeamlineFromDirectory

Identifier:

bes.actors.extractBeamlineFromDirectory.run

Task type:

ppfmethod

Required inputs:

directory, run_number

Optional inputs:

beamline

Outputs:

return_value

extractBestMeshPosition

Identifier:

bes.actors.extractBestMeshPosition.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters

Optional inputs:

bestPosition, mxcubeParameters

Outputs:

return_value

getHelicalGridData

Identifier:

bes.actors.getHelicalGridData.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters

Optional inputs:

shape, mxcubeParameters

Outputs:

return_value

get_MS_data_collection_strategy

Identifier:

bes.actors.get_MS_data_collection_strategy.run

Task type:

ppfmethod

Required inputs:

beamline, directory, beamParameters, run_number, mxv1StrategyResultFile, workflowParameters, characterisationTransmission

Optional inputs:

mxcubeParameters

Outputs:

return_value

gridResultsToMXCuBE

Identifier:

bes.actors.gridResultsToMXCuBE.run

Task type:

ppfmethod

Required inputs:

beamline, directory, proposal, meshPositionFile, run_number, expTypePrefix, workflow_working_dir, prefix, suffix, workflow_id, grid_info, workflow_title, workflow_type, firstImagePath, bestPosition, workflowParameters

Optional inputs:

list_node_id, pyarch_html_dir, snapShotFilePath, titleMeshHtmlPage, meshHtmlDirectoryName, diffractionSignalDetection, shape, remainingPositions, resultMeshPath, workflowStepType, dozormListPositions, mxcubeParameters, dozormCrystalMapPath, dozormColourMapPath, dozormImageNumberMapPath, doDistlSignalStrength, besParameters

Outputs:

return_value

helicalCharacterisationUserInput

Identifier:

bes.actors.helicalCharacterisationUserInput.run

Task type:

ppfmethod

Required inputs:

beamline, directory, characterisationOscillationRange, characterisationExposureTime, transmission, characterisationTransmission

Optional inputs:

automatic_mode, resolution, collection_software, mxcubeParameters

Outputs:

return_value

helical_characterisation_best_parameter

Identifier:

bes.actors.helical_characterisation_best_parameter.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, mxv1StrategyResultFile, directory, run_number, expTypePrefix, prefix, suffix, workflow_working_dir, helicalDistance

Optional inputs:

dataCollectionType, susceptibility, mxcubeParameters

Outputs:

return_value

helical_characterisation_centre_position

Identifier:

bes.actors.helical_characterisation_centre_position.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, sampx1, sampy1, phiy1, phiz1, sampx2, sampy2, phiy2, phiz2

Optional inputs:

mxcubeParameters

Outputs:

return_value

helical_characterisation_data_collection

Identifier:

bes.actors.helical_characterisation_data_collection.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, mxv1StrategyResultFile, sampx1, sampy1, phiy1, phiz1, sampx2, sampy2, phiy2, phiz2, noPositions

Optional inputs:

dataCollectionType, mxcubeParameters

Outputs:

return_value

initDimple

Identifier:

bes.actors.initDimple.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

initExtISPyB

Identifier:

bes.actors.initExtISPyB.run

Task type:

ppfmethod

Required inputs:

projectId, runId, extispyb, token

Optional inputs:

workflowType, version

Outputs:

return_value

initReprocess

Identifier:

bes.actors.initReprocess.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

init_workflow

Identifier:

bes.actors.init_workflow.run

Task type:

ppfmethod

Required inputs:

beamline, directory, prefix

Optional inputs:

workflow_title, workflow_type, workflow_id, workflowParameters, sample_lims_id, sample_node_id, REFID, REQUESTID, mxcubeParameters, besParameters, sample_name

Outputs:

return_value

insituGetBarcodeFromPath

Identifier:

bes.actors.insituGetBarcodeFromPath.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters

Optional inputs:

mxcubeParameters

Outputs:

return_value

interleavedMadDataCollections

Identifier:

bes.actors.interleavedMadDataCollections.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, raw_directory, process_directory, prefix, expTypePrefix, run_number, osc_range, noDegreesPerWedge, numberOfImages, motorPositions, collectExposureTime, transmission, energy1, energy2, energy3, energy4, workflow_type, workflow_index

Optional inputs:

sample_node_id, isInverseBeam, mxcubeParameters

Outputs:

return_value

interleavedMadDefaultParameters

Identifier:

bes.actors.interleavedMadDefaultParameters.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters

Optional inputs:

energy, mxcubeParameters

Outputs:

return_value

interleavedMadUserInput

Identifier:

bes.actors.interleavedMadUserInput.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

osc_range, numberOfImages, noDegreesPerWedge, energy1, energy2, energy3, energy4, collection_software, mxcubeParameters

Outputs:

return_value

ispyb_calculate_image_quality_indicators

Identifier:

bes.actors.ispyb_calculate_image_quality_indicators.run

Task type:

ppfmethod

Required inputs:

beamline, mxv1StrategyResult, directory, run_number, expTypePrefix, prefix, suffix, workflow_working_dir

Optional inputs:

Outputs:

return_value

ispyb_retrieve_flux_beamsize

Identifier:

bes.actors.ispyb_retrieve_flux_beamsize.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, mxv1StrategyResultFile, directory, run_number, expTypePrefix, prefix, suffix, workflow_working_dir

Optional inputs:

mxcubeParameters

Outputs:

return_value

ispyb_set_status_failure

Identifier:

bes.actors.ispyb_set_status_failure.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

beamline, directory, workflowParameters, message_text, workflow_title, workflow_type, errorMessage, done_error_report, mxcubeParameters

Outputs:

return_value

ispyb_set_status_success

Identifier:

bes.actors.ispyb_set_status_success.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, workflow_title, workflow_type, workflow_working_dir, workflow_id

Optional inputs:

message_text, mxcubeParameters, end_workflow_in_mxcube

Outputs:

return_value

ispyb_set_status_success_with_errors

Identifier:

bes.actors.ispyb_set_status_success_with_errors.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, workflow_title, workflow_type, workflow_working_dir, workflow_id

Optional inputs:

message_text, end_workflow_in_mxcube, mxcubeParameters

Outputs:

return_value

kappaReorientationNewKappaStrategyUserInput

Identifier:

bes.actors.kappaReorientationNewKappaStrategyUserInput.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

automatic_mode, collection_software, mxcubeParameters

Outputs:

return_value

kappaReorientationUserInput

Identifier:

bes.actors.kappaReorientationUserInput.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, characterisationOscillationRange, characterisationExposureTime, transmission

Optional inputs:

automatic_mode, resolution, collection_software, mxcubeParameters

Outputs:

return_value

kappaStrategyIncomaptibleMessage

Identifier:

bes.actors.kappaStrategyIncomaptibleMessage.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, spaceGroup

Optional inputs:

automatic_mode, collection_software, mxcubeParameters

Outputs:

return_value

kappa_set_new_angles

Identifier:

bes.actors.kappa_set_new_angles.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, newKappa, newKappa_phi, newPhi

Optional inputs:

mxcubeParameters

Outputs:

return_value

loadMxCuBEQueue

Identifier:

bes.actors.loadMxCuBEQueue.run

Task type:

ppfmethod

Required inputs:

beamline, proposal, workflowParameters, directory, run_number, raw_directory, process_directory, prefix, expTypePrefix, mxv1StrategyResultFile, motorPositions

Optional inputs:

sampleInfo, firstImagePath, resolution, mxv1ResultCharacterisationFile, forcedSpaceGroup, do_data_collect, createNewDataCollectionGroup, suffix, highResolution, lowResolution, mxcubeParameters, collection_software, workflow_index, characterisation_id, kappa_settings_id, position_id, process_partial_data_sets, list_partial_data_sets, moreSamples, doPseudoHelical, doOpenKappa, besParameters

Outputs:

return_value

logger_report_abort

Identifier:

bes.actors.logger_report_abort.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

beamline, message_text

Outputs:

return_value

logger_report_error

Identifier:

bes.actors.logger_report_error.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

workflowParameters, message_text, beamline, WorkflowException, mxcubeParameters

Outputs:

return_value

lowDoseCharacterisationOKInput

Identifier:

bes.actors.lowDoseCharacterisationOKInput.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

collection_software, mxcubeParameters

Outputs:

return_value

lowDoseDCInput

Identifier:

bes.actors.lowDoseDCInput.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, osc_range, characterisationExposureTime, transmission

Optional inputs:

automatic_mode, resolution, collection_software, mxcubeParameters

Outputs:

return_value

lowDoseDCRedoInput

Identifier:

bes.actors.lowDoseDCRedoInput.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, characterisationInputFile

Optional inputs:

collection_software, mxcubeParameters

Outputs:

return_value

lowDoseMoveMotors

Identifier:

bes.actors.lowDoseMoveMotors.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters, deltaKappa, deltaPhi, noDCPositions

Optional inputs:

mxcubeParameters

Outputs:

return_value

massif1PrepareEEDNA

Identifier:

bes.actors.massif1PrepareEEDNA.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

do_data_collect

Outputs:

return_value

massif1PrepareEEDNA_SAD

Identifier:

bes.actors.massif1PrepareEEDNA_SAD.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

massif1PrepareMXScore

Identifier:

bes.actors.massif1PrepareMXScore.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

massif2_prepare_180_degree_collect

Identifier:

bes.actors.massif2_prepare_180_degree_collect.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, motorPositions, flux

Optional inputs:

mxcubeParameters

Outputs:

return_value

massif2_prepare_360_degree_collect

Identifier:

bes.actors.massif2_prepare_360_degree_collect.run

Task type:

ppfmethod

Required inputs:

beamline, phi, flux

Optional inputs:

mxcubeParameters

Outputs:

return_value

massif2_retrieve_flux

Identifier:

bes.actors.massif2_retrieve_flux.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, run_number, expTypePrefix, prefix, suffix, workflow_working_dir

Optional inputs:

transmission, firstImagePath, mxcubeParameters

Outputs:

return_value

meshAndBurnDialog

Identifier:

bes.actors.meshAndBurnDialog.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters, transmission, gridSnapShots

Optional inputs:

collection_software, mxcubeParameters, resolution, data_collection_osc_range, data_collection_exposure_time, data_collection_no_images

Outputs:

return_value

mesh_and_collect_characterisation

Identifier:

bes.actors.mesh_and_collect_characterisation.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, allPositionFile, transmission

Optional inputs:

aimedIOverSigmaAtHighestResolution, flux, beamSizeAtSampleX, beamSizeAtSampleY, resolution, crystalSizeX, crystalSizeY, crystalSizeZ, dozorVisibleResolution, data_collection_no_images, mxcubeParameters

Outputs:

return_value

mesh_and_collect_choose_mesh_results

Identifier:

bes.actors.mesh_and_collect_choose_mesh_results.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters

Optional inputs:

raw_directory, collection_software, mxcubeParameters

Outputs:

return_value

mesh_and_collect_load_mxcube_queue

Identifier:

bes.actors.mesh_and_collect_load_mxcube_queue.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, raw_directory, process_directory, prefix, expTypePrefix, run_number, allPositionFile, motorPositions, workflow_type, workflow_index, data_collection_exposure_time, transmission, data_collection_no_images, data_collection_osc_range, data_collection_max_positions

Optional inputs:

data_collection_start_phi, sampleInfo, resolution, inverseBeam, data_collection_iterations, grenades_fastproc, grenades_parallelproc, EDNA_proc, XIA2_DIALS, autoPROC, XDSAPP, mxcubeParameters, adaptiveAperture, listSnapShotFileName, characterisation_id, kappa_settings_id, position_id, besParameters

Outputs:

return_value

mesh_and_collect_user_input

Identifier:

bes.actors.mesh_and_collect_user_input.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, data_collection_exposure_time, data_collection_osc_range, data_collection_no_images, data_collection_max_positions, transmission, radius

Optional inputs:

aimedIOverSigmaAtHighestResolution, redo_find_positions, data_threshold, resolution, timeToReachHendersonLimit, flux, diffractionSignalDetection, collection_software, mxcubeParameters, automatic_mode

Outputs:

return_value

mesh_no_images_error

Identifier:

bes.actors.mesh_no_images_error.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters

Optional inputs:

message_text, firstImagePath, mxcubeParameters

Outputs:

return_value

mesh_no_position_error

Identifier:

bes.actors.mesh_no_position_error.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, firstImagePath, collection_software

Optional inputs:

mxcubeParameters, automatic_mode, dozorm2ExecutionError

Outputs:

return_value

meshbest3d_input

Identifier:

bes.actors.meshbest3d_input.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters, osc_range, gridExposureTime, transmission, plateMode, gridSnapShots

Optional inputs:

collection_software, mxcubeParameters, indexMesh2d

Outputs:

return_value

meshbest3d_moveToAngle1

Identifier:

bes.actors.meshbest3d_moveToAngle1.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, run_number, currentPhi, angleRelative1

Optional inputs:

mxcubeParameters

Outputs:

return_value

meshbest3d_moveToAngle2

Identifier:

bes.actors.meshbest3d_moveToAngle2.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, run_number, currentPhi, angleRelative2

Optional inputs:

mxcubeParameters

Outputs:

return_value

meshbest3d_moveToStartPosition

Identifier:

bes.actors.meshbest3d_moveToStartPosition.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, motorInitialPositions

Optional inputs:

mxcubeParameters

Outputs:

return_value

meshbest3d_prepareNextMesh2d

Identifier:

bes.actors.meshbest3d_prepareNextMesh2d.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, indexMesh2d, run_number

Optional inputs:

newPhi, noMesh2d, mxcubeParameters, meshResultsJsonPath

Outputs:

return_value

moveOmega

Identifier:

bes.actors.moveOmega.run

Task type:

ppfmethod

Required inputs:

beamline, raw_directory, workflowParameters, directory, process_directory, expTypePrefix, prefix, suffix, grid_info, gridOscillationRange, gridExposureTime, transmission, run_number, deltaOmega, motorInitialPositions

Optional inputs:

dozorAllFile, useFastMesh, meshZigZag, multi_wedge, mxcubeParameters, workflow_index

Outputs:

return_value

move_to_new_sample_position

Identifier:

bes.actors.move_to_new_sample_position.run

Task type:

ppfmethod

Required inputs:

beamline, directory, newMotorPositions, workflowParameters

Optional inputs:

mxcubeParameters

Outputs:

return_value

move_to_start_sample_position

Identifier:

bes.actors.move_to_start_sample_position.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, motorInitialPositions

Optional inputs:

mxcubeParameters

Outputs:

return_value

mxPressContactUser

Identifier:

bes.actors.mxPressContactUser.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, raw_directory

Optional inputs:

sessionId, mxcubeParameters

Outputs:

return_value

mxpressCheckSymmetry

Identifier:

bes.actors.mxpressCheckSymmetry.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

firstImagePath, cellSpaceGroup, forcedSpaceGroup, workflowParameters, resolution, mxcubeParameters, sampleInfo, openKappaForLowSymmetry, process_partial_data_sets

Outputs:

return_value

mxpressDiffPlanChoice

Identifier:

bes.actors.mxpressDiffPlanChoice.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters

Optional inputs:

sampleInfo, dataCollectionGroupComment, numberOfPositions, do_data_collect, doCharacterisation, anomalousData, do2DMeshOnly, doOnlyEDNAResolution, diffractionSignalDetection, findLargestMesh, aimedCompleteness, aimedMultiplicity, aimedResolution, observedResolution, minOscWidth, sampleSusceptibility, moreSamples, targetApertureName, doAutoMesh, aimedIOverSigmaAtHighestResolution, doPseudoHelical, mxcubeParameters, dozorThreshold, strategyOption, axisRange, doFbest, openKappaForLowSymmetry, runGphlWorkflow, doTwoMeshes, deltaOmega, synchronizeBestPosition

Outputs:

return_value

mxpressKappaSetAperture

Identifier:

bes.actors.mxpressKappaSetAperture.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

workflowParameters, mxcubeParameters, newApertureSize, smallGridApertureSize

Outputs:

return_value

mxpressMoveKappaToZero

Identifier:

bes.actors.mxpressMoveKappaToZero.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

workflowParameters, mxcubeParameters

Outputs:

return_value

mxpressMoveToNextPosition

Identifier:

bes.actors.mxpressMoveToNextPosition.run

Task type:

ppfmethod

Required inputs:

beamline, directory, remainingPositions, workflowParameters, motorPositions

Optional inputs:

multiPositionIndex, mxcubeParameters, position_id

Outputs:

return_value

mxpressOpenKappa

Identifier:

bes.actors.mxpressOpenKappa.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

workflowParameters, mxcubeParameters, kappa_settings_id, newApertureSize

Outputs:

return_value

mxpress_setup_dialog

Identifier:

bes.actors.mxpress_setup_dialog.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters

Optional inputs:

collection_software, mxcubeParameters

Outputs:

return_value

mxpressr_180_setup_dialog

Identifier:

bes.actors.mxpressr_180_setup_dialog.run

Task type:

ppfmethod

Required inputs:

beamline, targetFlux, aimedResolution, preferredApertureName, workflowParameters, directory, numberOfPositions, mxpressoOscRange, mxpressoNoImages, gridTransmission, gridSize, gridSteps, diffractionSignalDetection, forcedSpaceGroup

Optional inputs:

collection_software, mxcubeParameters

Outputs:

return_value

mxpressr_dehydration_setup_dialog

Identifier:

bes.actors.mxpressr_dehydration_setup_dialog.run

Task type:

ppfmethod

Required inputs:

beamline, directory, collection_software, startRH, endRH, step, delay, aimedResolution, transmission, no_reference_images, angle_between_reference_images, snapShots, workflowParameters

Optional inputs:

mxcubeParameters

Outputs:

return_value

mxpressr_setup_dialog

Identifier:

bes.actors.mxpressr_setup_dialog.run

Task type:

ppfmethod

Required inputs:

beamline, aimedResolution, preferredApertureName, workflowParameters, directory, numberOfPositions, gridTransmission, aimedMultiplicity, aimedCompleteness, diffractionSignalDetection, forcedSpaceGroup

Optional inputs:

collection_software, mxcubeParameters

Outputs:

return_value

ppfPort

Identifier:

bes.actors.ppfPort.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

prepareCalibrateKappa

Identifier:

bes.actors.prepareCalibrateKappa.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

directory, beamline

Outputs:

return_value

prepareCentrePin

Identifier:

bes.actors.prepareCentrePin.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

directory, beamline

Outputs:

return_value

prepareCollectWithResolution

Identifier:

bes.actors.prepareCollectWithResolution.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, motorPositions, flux, mxv1ResultCharacterisationFile

Optional inputs:

highResolution, lowResolution, flux100, mxpressoNoImages, mxpressoOscRange, anomalousData, axisRange, firstImagePath, mxcubeParameters

Outputs:

return_value

prepareFirstTestInversedLineScan

Identifier:

bes.actors.prepareFirstTestInversedLineScan.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters, run_number, process_directory, prefix, suffix, osc_range, gridExposureTime

Optional inputs:

gridTransmission, mxcubeParameters

Outputs:

return_value

prepareFirstVerticalXrayCentring

Identifier:

bes.actors.prepareFirstVerticalXrayCentring.run

Task type:

ppfmethod

Required inputs:

beamline, raw_directory, workflowParameters, run_number, process_directory, prefix, suffix, gridOscillationRange, sampx1, sampy1, phiy1, phiz1, gridExposureTime

Optional inputs:

beamSizeAtSampleX, beamSizeAtSampleY, gridTransmission, perform_extra_1D_scan, do2DMeshOnly, centerRotationAxis, mxcubeParameters, workflow_index

Outputs:

return_value

prepareHelicalCharacterisation

Identifier:

bes.actors.prepareHelicalCharacterisation.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters

Optional inputs:

mxcubeParameters

Outputs:

return_value

prepareMeshAndBurnDataCollections

Identifier:

bes.actors.prepareMeshAndBurnDataCollections.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, shape, collection_software, motorPositions, run_number, prefix, suffix

Optional inputs:

meshZigZag, meshHorizontalSeparation, meshVerticalSeparation, mxcubeParameters

Outputs:

return_value

prepareMeshCheckExperimentSettings

Identifier:

bes.actors.prepareMeshCheckExperimentSettings.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters, gridOscillationRange, gridExposureTime, transmission, plateMode, gridSnapShots, lineScanLength, lineScanOverSampling, lowResolution, highResolution

Optional inputs:

doLineScans, lineScanStep, beamParameters, collection_software, mxcubeParameters, do2MeshScans, allowZeroDegreeMeshScan, doCharacterisation, characterisationOscillationRange, characterisationExposureTime, characterisationTransmission, automatic_mode, doDistlSignalStrength

Outputs:

return_value

prepareRDExpress

Identifier:

bes.actors.prepareRDExpress.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

prepareRefKappaCollection

Identifier:

bes.actors.prepareRefKappaCollection.run

Task type:

ppfmethod

Required inputs:

run_number

Optional inputs:

Outputs:

return_value

prepareSecondTestInversedLineScan

Identifier:

bes.actors.prepareSecondTestInversedLineScan.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters, run_number, process_directory, prefix, suffix, osc_range, gridExposureTime, motorInitialPositions

Optional inputs:

gridTransmission, mxcubeParameters

Outputs:

return_value

prepareSecondVerticalXrayCentring

Identifier:

bes.actors.prepareSecondVerticalXrayCentring.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters, run_number, process_directory, prefix, suffix, gridOscillationRange, sampx2, sampy2, phiy2, phiz2, gridExposureTime

Optional inputs:

beamSizeAtSampleX, beamSizeAtSampleY, gridTransmission, mxcubeParameters

Outputs:

return_value

prepareShortVerticalXrayCentring

Identifier:

bes.actors.prepareShortVerticalXrayCentring.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

doTwoMeshes

Outputs:

return_value

prepareSmallXrayCentring

Identifier:

bes.actors.prepareSmallXrayCentring.run

Task type:

ppfmethod

Required inputs:

beamline, directory

Optional inputs:

workflowParameters, resolution, mxcubeParameters, beamSizeAtSampleX, beamSizeAtSampleY, do1DXrayCentring, isHorizontalRotationAxis, do2MeshScans, lineScanStep, lineScanLength

Outputs:

return_value

prepareTestAutoMesh

Identifier:

bes.actors.prepareTestAutoMesh.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

directory, beamline

Outputs:

return_value

prepareTestGphlWorkflow

Identifier:

bes.actors.prepareTestGphlWorkflow.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

directory, beamline

Outputs:

return_value

prepareTestSetGridData

Identifier:

bes.actors.prepareTestSetGridData.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

directory, beamline

Outputs:

return_value

prepareTestShortVerticalLineScan

Identifier:

bes.actors.prepareTestShortVerticalLineScan.run

Task type:

ppfmethod

Required inputs:

beamline

Optional inputs:

Outputs:

return_value

prepareTroubleShooting

Identifier:

bes.actors.prepareTroubleShooting.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

directory, beamline

Outputs:

return_value

prepare_collect_without_strategy

Identifier:

bes.actors.prepare_collect_without_strategy.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, motorPositions, flux, resolution, highResolution

Optional inputs:

mxpressoNoImages, mxpressoOscRange, collectTransmission, collectExposureTime, axisRange, minOscWidth, anomalousData, checkForFlux, targetFlux, firstImagePath, sampleInfo, dataCollectionPosition, mxcubeParameters, doFbest, wavelength, doCharacterisation, crystalSizeX, crystalSizeY, crystalSizeZ, beamSizeAtSampleX, beamSizeAtSampleY, sampleSusceptibility, dozorVisibleResolutionVertical, dozorVisibleResolutionHorizontal, dozor2m_resolution

Outputs:

return_value

prepare_mesh_autoGridPositions

Identifier:

bes.actors.prepare_mesh_autoGridPositions.run

Task type:

ppfmethod

Required inputs:

beamline, raw_directory, process_directory, motorPositions, run_number, expTypePrefix, gridOscillationRange, transmission, highResolution, prefix, suffix, workflow_working_dir, workflowParameters, gridExposureTime

Optional inputs:

sampleInfo, meshZigZag, grid_info, gridTransmission, allowZeroDegreeMeshScan, aimedResolution, observedResolution, workflow_index, mxcubeParameters

Outputs:

return_value

prepare_mesh_getGridPositions

Identifier:

bes.actors.prepare_mesh_getGridPositions.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, raw_directory, process_directory, workflow_type, gridOscillationRange, motorPositions, beamParameters, run_number, expTypePrefix, prefix, suffix, gridExposureTime, transmission

Optional inputs:

useFastMesh, meshZigZag, multi_wedge, collection_software, mxcubeParameters, shape, allowZeroDegreeMeshScan, workflow_index

Outputs:

return_value

prepare_reference_image_collect

Identifier:

bes.actors.prepare_reference_image_collect.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, raw_directory, characterisationExposureTime, beamParameters, characterisationOscillationRange, no_reference_images, prefix, expTypePrefix, suffix, run_number, highResolution, motorPositions

Optional inputs:

sampleInfo, characterisationTransmission, angle_between_reference_images, resolution, mxcubeParameters, newDataCollection, wavelength, dozorVisibleResolutionVertical, dozorVisibleResolutionHorizontal, fineSlicedReferenceImages, lowResolution, aimedResolution, workflow_index

Outputs:

return_value

prepare_serial_data_collection_positions

Identifier:

bes.actors.prepare_serial_data_collection_positions.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, process_directory, workflow_type, osc_range, phi, kappa, kappa_phi, sampx, sampy, phix, phiy, phiz, run_number, expTypePrefix, prefix, suffix, gridExposureTime, transmission

Optional inputs:

grid_info, meshZigZag, mxcubeParameters, shape

Outputs:

return_value

processBurnDataCollection

Identifier:

bes.actors.processBurnDataCollection.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, run_number, expTypePrefix, prefix, suffix, mxv1ResultCharacterisationFile, workflow_working_dir

Optional inputs:

mxcubeParameters

Outputs:

return_value

radiationDamageCollectAndProcess

Identifier:

bes.actors.radiationDamageCollectAndProcess.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

radiationDamageDataCollectionUserInput

Identifier:

bes.actors.radiationDamageDataCollectionUserInput.run

Task type:

ppfmethod

Required inputs:

beamline, directory, data_collection_no_images, data_collection_exposure_time, data_collection_osc_range, transmission, data_collection_iterations

Optional inputs:

resolution, automatic_mode, collection_software, mxcubeParameters

Outputs:

return_value

radiationDamageTestImage

Identifier:

bes.actors.radiationDamageTestImage.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

radiationDamageTestImageUserInput

Identifier:

bes.actors.radiationDamageTestImageUserInput.run

Task type:

ppfmethod

Required inputs:

beamline, directory, data_collection_no_images, data_collection_exposure_time, data_collection_osc_range, transmission, data_collection_iterations

Optional inputs:

resolution, automatic_mode, collection_software, mxcubeParameters

Outputs:

return_value

rdExpressDC

Identifier:

bes.actors.rdExpressDC.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, raw_directory, process_directory, prefix, suffix, expTypePrefix, run_number, motorPositions, noCycles, osc_range, noImagesPerCycle, tLimit, transmission, sampleInfo

Optional inputs:

resolution, mxcubeParameters

Outputs:

return_value

rdExpressInput

Identifier:

bes.actors.rdExpressInput.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

automatic_mode, resolution, collection_software, mxcubeParameters

Outputs:

return_value

read_motor_positions

Identifier:

bes.actors.read_motor_positions.run

Task type:

ppfmethod

Required inputs:

beamline, directory, workflowParameters

Optional inputs:

transmission, resolution, mxcubeParameters

Outputs:

return_value

requestStatusERROR

Identifier:

bes.actors.requestStatusERROR.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

besParameters

Outputs:

return_value

requestStatusFINISHED

Identifier:

bes.actors.requestStatusFINISHED.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

resetShortLineScanParameter

Identifier:

bes.actors.resetShortLineScanParameter.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

runDIMPLE

Identifier:

bes.actors.runDIMPLE.run

Task type:

ppfmethod

Required inputs:

pdbFile, workflowParameters

Optional inputs:

mtzFile, proposal, autoprocintegrationURL, autoProcAttachmentURL, downloadAutoProcProgramAttachementURL

Outputs:

return_value

runDozorm2

Identifier:

bes.actors.runDozorm2.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, grid_info, firstImagePath, meshZigZag, isHorizontalRotationAxis, phi1, phi2, mxcubeParameters, dozorAllFile1, dozorAllFile, motorInitialPositions

Optional inputs:

numberOfPositions, reject_level

Outputs:

return_value

runReprocess

Identifier:

bes.actors.runReprocess.run

Task type:

ppfmethod

Required inputs:

mxcubeParameters, workflowParameters, dataCollectionId

Optional inputs:

start, end, cutoff

Outputs:

return_value

saveSamplePosition

Identifier:

bes.actors.saveSamplePosition.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters

Optional inputs:

mxcubeParameters

Outputs:

return_value

selectAperture

Identifier:

bes.actors.selectAperture.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters

Optional inputs:

doCharacterisation, characterisationExposureTime, firstImagePath, targetApertureName, peakSizeX, peakSizeY, peakSizeZ, ispybApertureComment, ispybExposureTimeComment, mxcubeParameters, doFbest, dozormTargetApertureSize, multiPositionIndex, adaptiveAperture

Outputs:

return_value

setAperture

Identifier:

bes.actors.setAperture.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters

Optional inputs:

preferredApertureName, targetApertureName, mxcubeParameters

Outputs:

return_value

set_damPar_strategyOption

Identifier:

bes.actors.set_damPar_strategyOption.run

Task type:

ppfmethod

Required inputs:

beamline, radiation_damage_beta, radiation_damage_gamma

Optional inputs:

Outputs:

return_value

set_expTypePrefix_to_burn

Identifier:

bes.actors.set_expTypePrefix_to_burn.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

submitSLURMJob

Identifier:

bes.actors.submitSLURMJob.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

beamline, dataCollectionId, ednaDpLaunchPath, launchPath, procType, numberOfImages, proposal, nodes, core, queue, host, mem, time

Outputs:

return_value

takeSnapShots

Identifier:

bes.actors.takeSnapShots.run

Task type:

ppfmethod

Required inputs:

beamline, directory, run_number, prefix

Optional inputs:

expTypePrefix, dataCollectionId, mxcubeParameters

Outputs:

return_value

testActorTimeOut

Identifier:

bes.actors.testActorTimeOut.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

testBest3DInput

Identifier:

bes.actors.testBest3DInput.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, characterisationOscillationRange, characterisationExposureTime, transmission

Optional inputs:

automatic_mode, resolution, collection_software, mxcubeParameters

Outputs:

return_value

testDataEmitter

Identifier:

bes.actors.testDataEmitter.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

testDataReceiver

Identifier:

bes.actors.testDataReceiver.run

Task type:

ppfmethod

Required inputs:

none, booleanTrue, booleanFalse, integer1, float1, string1, dictionary1

Optional inputs:

Outputs:

return_value

testMeshBest

Identifier:

bes.actors.testMeshBest.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

Outputs:

return_value

testSetGridData

Identifier:

bes.actors.testSetGridData.run

Task type:

ppfmethod

Required inputs:

directory, beamline, motorPositions, gridOscillationRange, run_number, prefix, suffix, workflowParameters

Optional inputs:

shape, mxcubeParameters

Outputs:

return_value

troubleShootingAllTestsOk

Identifier:

bes.actors.troubleShootingAllTestsOk.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters

Optional inputs:

mxcubeParameters

Outputs:

return_value

troubleShootingDialog

Identifier:

bes.actors.troubleShootingDialog.run

Task type:

ppfmethod

Required inputs:

beamline, prefix, workflowParameters

Optional inputs:

directory, collection_software, mxcubeParameters

Outputs:

return_value

two_mesh_and_collect_user_input

Identifier:

bes.actors.two_mesh_and_collect_user_input.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, data_collection_max_positions, transmission, motorPositions

Optional inputs:

resolution, collection_software, mxcubeParameters, automatic_mode, adaptiveAperture

Outputs:

return_value

two_mesh_no_position_found

Identifier:

bes.actors.two_mesh_no_position_found.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, collection_software

Optional inputs:

automatic_mode, mxcubeParameters

Outputs:

return_value

uploadFilesToExtISPyB

Identifier:

bes.actors.uploadFilesToExtISPyB.run

Task type:

ppfmethod

Required inputs:

workflowParameters, extispyb, startDate, projectId, runId, extISPyBStatus, token

Optional inputs:

fileList

Outputs:

return_value

uploadToCrims

Identifier:

bes.actors.uploadToCrims.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, prefix

Optional inputs:

dataCollectionId, dataCollectionGroupId, mxcubeParameters

Outputs:

return_value

visual_kappa_calculate_angles

Identifier:

bes.actors.visual_kappa_calculate_angles.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, phi, sampx1, sampy1, phiy1, sampx2, sampy2, phiy2

Optional inputs:

mxcubeParameters

Outputs:

return_value

visual_kappa_save_first_pos

Identifier:

bes.actors.visual_kappa_save_first_pos.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

mxcubeParameters

Outputs:

return_value

visual_kappa_save_second_pos

Identifier:

bes.actors.visual_kappa_save_second_pos.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

mxcubeParameters

Outputs:

return_value

visual_kappa_set_angles_zero

Identifier:

bes.actors.visual_kappa_set_angles_zero.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory

Optional inputs:

mxcubeParameters

Outputs:

return_value

visual_kappa_set_new_angles

Identifier:

bes.actors.visual_kappa_set_new_angles.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, newKappa, newKappa_phi, newPhi

Optional inputs:

newSampx, newSampy, newPhiy, mxcubeParameters

Outputs:

return_value

waitForFirstAndLastImage

Identifier:

bes.actors.waitForFirstAndLastImage.run

Task type:

ppfmethod

Required inputs:

beamline, dataCollectionId

Optional inputs:

doWaitForImages

Outputs:

return_value

waitSLURMRunning

Identifier:

bes.actors.waitSLURMRunning.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

workingDirectory, slurmJobId

Outputs:

return_value

waitSLURMTerminated

Identifier:

bes.actors.waitSLURMTerminated.run

Task type:

ppfmethod

Required inputs:

Optional inputs:

workingDirectory, slurmJobId

Outputs:

return_value

xrayCentringCheckChangeAperture

Identifier:

bes.actors.xrayCentringCheckChangeAperture.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, collection_software

Optional inputs:

dozormTargetApertureSize, doCharacterisation, doChangeAperture, automatic_mode, mxcubeParameters

Outputs:

return_value

xrayCentringMoveToNewSamplePosition

Identifier:

bes.actors.xrayCentringMoveToNewSamplePosition.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, motorPositions, newMotorPositions

Optional inputs:

mxcubeParameters

Outputs:

return_value

xrayCentring_checkMove90Degrees

Identifier:

bes.actors.xrayCentring_checkMove90Degrees.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, phi, newPhi

Optional inputs:

mxcubeParameters

Outputs:

return_value

xrayCentring_move90Degrees

Identifier:

bes.actors.xrayCentring_move90Degrees.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, directory, motorPositions, run_number

Optional inputs:

mxcubeParameters

Outputs:

return_value

xrayCentring_prepare1Dscan

Identifier:

bes.actors.xrayCentring_prepare1Dscan.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, raw_directory, process_directory, run_number, expTypePrefix, prefix, suffix, motorPositions, gridExposureTime, gridOscillationRange, transmission, lineScanLength, lineScanOverSampling, isHorizontalRotationAxis

Optional inputs:

workflow_index, beamSizeAtSampleX, beamSizeAtSampleY, shortLineScan, gridTransmission, allowZeroDegreeMeshScan, mxcubeParameters, lineScanStep, bestPosition

Outputs:

return_value

xrayCentring_prepareMove90Degrees

Identifier:

bes.actors.xrayCentring_prepareMove90Degrees.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, phi, run_number

Optional inputs:

mxcubeParameters

Outputs:

return_value

xrayCentring_prepareShort1Dscan

Identifier:

bes.actors.xrayCentring_prepareShort1Dscan.run

Task type:

ppfmethod

Required inputs:

beamline, workflowParameters, raw_directory, process_directory, run_number, expTypePrefix, prefix, suffix, motorPositions, gridExposureTime, gridOscillationRange, transmission, grid_info

Optional inputs:

beamSizeAtSampleX, beamSizeAtSampleY, gridTransmission, workflow_index, mxcubeParameters

Outputs:

return_value