Table of contents

Contents:

• Backend of MXCuBE
• Developer documentation
  • Abstract Classes
  • API
    • mxcubecore
      • mxcubecore.BaseHardwareObjects
      • mxcubecore.Command
        • mxcubecore.Command.Epics
        • mxcubecore.Command.Exporter
        • mxcubecore.Command.Mockup
        • mxcubecore.Command.Sardana
        • mxcubecore.Command.Tango
        • mxcubecore.Command.exporter
          • mxcubecore.Command.exporter.ExporterClient
          • mxcubecore.Command.exporter.ExporterStates
          • mxcubecore.Command.exporter.StandardClient
      • mxcubecore.CommandContainer
      • mxcubecore.HardwareObjectFileParser
      • mxcubecore.HardwareObjects
        • mxcubecore.HardwareObjects.Attenuators
        • mxcubecore.HardwareObjects.BeamInfo
        • mxcubecore.HardwareObjects.Beamline
        • mxcubecore.HardwareObjects.BeamlineActions
        • mxcubecore.HardwareObjects.BeamlineTools
        • mxcubecore.HardwareObjects.BlissActuator
        • mxcubecore.HardwareObjects.BlissEnergy
        • mxcubecore.HardwareObjects.BlissHutchTrigger
        • mxcubecore.HardwareObjects.BlissRontecMCA
        • mxcubecore.HardwareObjects.BlissShutter
        • mxcubecore.HardwareObjects.CatsMaint
        • mxcubecore.HardwareObjects.CentringMath
        • mxcubecore.HardwareObjects.DozorOnlineProcessing
        • mxcubecore.HardwareObjects.EDNACharacterisation
        • mxcubecore.HardwareObjects.EMBL
          • mxcubecore.HardwareObjects.EMBL.EMBLAperture
          • mxcubecore.HardwareObjects.EMBL.EMBLBSD
          • mxcubecore.HardwareObjects.EMBL.EMBLBeam
          • mxcubecore.HardwareObjects.EMBL.EMBLBeamline
          • mxcubecore.HardwareObjects.EMBL.EMBLCRL
          • mxcubecore.HardwareObjects.EMBL.EMBLCollect
          • mxcubecore.HardwareObjects.EMBL.EMBLDetector
          • mxcubecore.HardwareObjects.EMBL.EMBLDoorInterlock
          • mxcubecore.HardwareObjects.EMBL.EMBLEnergy
          • mxcubecore.HardwareObjects.EMBL.EMBLEnergyScan
          • mxcubecore.HardwareObjects.EMBL.EMBLExporterClient
          • mxcubecore.HardwareObjects.EMBL.EMBLImageTracking
          • mxcubecore.HardwareObjects.EMBL.EMBLMachineInfo
          • mxcubecore.HardwareObjects.EMBL.EMBLMiniDiff
          • mxcubecore.HardwareObjects.EMBL.EMBLOfflineProcessing
          • mxcubecore.HardwareObjects.EMBL.EMBLOnlineProcessing
          • mxcubecore.HardwareObjects.EMBL.EMBLPPUControl
          • mxcubecore.HardwareObjects.EMBL.EMBLPiezoMotor
          • mxcubecore.HardwareObjects.EMBL.EMBLQueueEntry
          • mxcubecore.HardwareObjects.EMBL.EMBLResolution
          • mxcubecore.HardwareObjects.EMBL.EMBLSafetyShutter
          • mxcubecore.HardwareObjects.EMBL.EMBLSession
          • mxcubecore.HardwareObjects.EMBL.EMBLSlitBox
          • mxcubecore.HardwareObjects.EMBL.EMBLTableMotor
          • mxcubecore.HardwareObjects.EMBL.EMBLTransfocator
          • mxcubecore.HardwareObjects.EMBL.EMBLTransmission
          • mxcubecore.HardwareObjects.EMBL.EMBLXRFSpectrum
          • mxcubecore.HardwareObjects.EMBL.MDFastShutter
          • mxcubecore.HardwareObjects.EMBL.TINEMotor
        • mxcubecore.HardwareObjects.EMBLFlexHCD
        • mxcubecore.HardwareObjects.EMBLFlexHarvester
        • mxcubecore.HardwareObjects.ESRF
          • mxcubecore.HardwareObjects.ESRF.BlissHutchTrigger
          • mxcubecore.HardwareObjects.ESRF.ESRFBeam
          • mxcubecore.HardwareObjects.ESRF.ESRFBeamDefiner
          • mxcubecore.HardwareObjects.ESRF.ESRFBeamInfo
          • mxcubecore.HardwareObjects.ESRF.ESRFBeamlineActions
          • mxcubecore.HardwareObjects.ESRF.ESRFEnergyScan
          • mxcubecore.HardwareObjects.ESRF.ESRFMetadataManagerClient
          • mxcubecore.HardwareObjects.ESRF.ESRFMultiCollect
          • mxcubecore.HardwareObjects.ESRF.ESRFPhotonFlux
          • mxcubecore.HardwareObjects.ESRF.ESRFSession
          • mxcubecore.HardwareObjects.ESRF.ESRFSmallXrayCentring
          • mxcubecore.HardwareObjects.ESRF.ID231BeamInfo
          • mxcubecore.HardwareObjects.ESRF.ID231EnergyScan
          • mxcubecore.HardwareObjects.ESRF.ID232BeamDefiner
          • mxcubecore.HardwareObjects.ESRF.ID232BeamInfo
          • mxcubecore.HardwareObjects.ESRF.ID232HutchTrigger
          • mxcubecore.HardwareObjects.ESRF.ID29EnergyScan
          • mxcubecore.HardwareObjects.ESRF.ID29HutchTrigger
          • mxcubecore.HardwareObjects.ESRF.ID30A1BeamCmds
          • mxcubecore.HardwareObjects.ESRF.ID30A3BeamDefiner
          • mxcubecore.HardwareObjects.ESRF.ID30A3MD2M
          • mxcubecore.HardwareObjects.ESRF.ID30A3PhotonFlux
          • mxcubecore.HardwareObjects.ESRF.ID30BEnergyScan
          • mxcubecore.HardwareObjects.ESRF.ID30BPhotonFlux
          • mxcubecore.HardwareObjects.ESRF.ID30BeamCmds
          • mxcubecore.HardwareObjects.ESRF.ID30BeamInfo
          • mxcubecore.HardwareObjects.ESRF.ID30HutchTrigger
          • mxcubecore.HardwareObjects.ESRF.MD2MultiCollect
          • mxcubecore.HardwareObjects.ESRF.OxfordCryostream
          • mxcubecore.HardwareObjects.ESRF.TangoKeithleyPhotonFlux
          • mxcubecore.HardwareObjects.ESRF.Transmission
          • mxcubecore.HardwareObjects.ESRF.calc_flux
          • mxcubecore.HardwareObjects.ESRF.queue_entry
        • mxcubecore.HardwareObjects.EdnaWorkflow
        • mxcubecore.HardwareObjects.Energy
        • mxcubecore.HardwareObjects.ExporterMotor
        • mxcubecore.HardwareObjects.ExporterNState
        • mxcubecore.HardwareObjects.FlexHCD
        • mxcubecore.HardwareObjects.FlexHCDMaintenance
        • mxcubecore.HardwareObjects.GenericDiffractometer
        • mxcubecore.HardwareObjects.Gphl
          • mxcubecore.HardwareObjects.Gphl.CollectEmulator
          • mxcubecore.HardwareObjects.Gphl.GphlMessages
          • mxcubecore.HardwareObjects.Gphl.GphlQueueEntry
          • mxcubecore.HardwareObjects.Gphl.GphlWorkflow
          • mxcubecore.HardwareObjects.Gphl.GphlWorkflowConnection
          • mxcubecore.HardwareObjects.Gphl.Transcal2MiniKappa
        • mxcubecore.HardwareObjects.GrobDiff
        • mxcubecore.HardwareObjects.GrobSampleChanger
        • mxcubecore.HardwareObjects.Harvester
        • mxcubecore.HardwareObjects.HarvesterMaintenance
        • mxcubecore.HardwareObjects.ISARAMaint
        • mxcubecore.HardwareObjects.LdapAuthenticator
        • mxcubecore.HardwareObjects.LimaEigerDetector
        • mxcubecore.HardwareObjects.LimaJungfrauDetector
        • mxcubecore.HardwareObjects.LimaPilatusDetector
        • mxcubecore.HardwareObjects.MAXIV
          • mxcubecore.HardwareObjects.MAXIV.MAXIVAutoProcessing
          • mxcubecore.HardwareObjects.MAXIV.MachInfo
        • mxcubecore.HardwareObjects.MD2Motor
        • mxcubecore.HardwareObjects.MachCurrent
        • mxcubecore.HardwareObjects.Mar225
        • mxcubecore.HardwareObjects.Marvin
        • mxcubecore.HardwareObjects.MicrodiffActuator
        • mxcubecore.HardwareObjects.MicrodiffAperture
        • mxcubecore.HardwareObjects.MicrodiffBeamstop
        • mxcubecore.HardwareObjects.MicrodiffInOut
        • mxcubecore.HardwareObjects.MicrodiffKappaMotor
        • mxcubecore.HardwareObjects.MicrodiffLight
        • mxcubecore.HardwareObjects.MicrodiffLightBeamstop
        • mxcubecore.HardwareObjects.MicrodiffMotor
        • mxcubecore.HardwareObjects.MicrodiffSamplePseudo
        • mxcubecore.HardwareObjects.MicrodiffZoom
        • mxcubecore.HardwareObjects.MiniDiff
        • mxcubecore.HardwareObjects.MiniKappaCorrection
        • mxcubecore.HardwareObjects.MinidiffAperture
        • mxcubecore.HardwareObjects.MotorsNPosition
        • mxcubecore.HardwareObjects.MultiplePositions
        • mxcubecore.HardwareObjects.NState
        • mxcubecore.HardwareObjects.Native
        • mxcubecore.HardwareObjects.ObjectsController
        • mxcubecore.HardwareObjects.PlateManipulator
        • mxcubecore.HardwareObjects.PlateManipulatorMaintenance
        • mxcubecore.HardwareObjects.Q315dist
        • mxcubecore.HardwareObjects.QtInstanceServer
        • mxcubecore.HardwareObjects.QtLimaVideo
        • mxcubecore.HardwareObjects.QtTangoLimaVideo
        • mxcubecore.HardwareObjects.QueueManager
        • mxcubecore.HardwareObjects.QueueModel
        • mxcubecore.HardwareObjects.Resolution
        • mxcubecore.HardwareObjects.RobodiffController
        • mxcubecore.HardwareObjects.RobodiffFShut
        • mxcubecore.HardwareObjects.RobodiffMotor
        • mxcubecore.HardwareObjects.RobodiffMotorWPositions
        • mxcubecore.HardwareObjects.SOLEIL
          • mxcubecore.HardwareObjects.SOLEIL.SOLEILCatsMaint
          • mxcubecore.HardwareObjects.SOLEIL.SOLEILFlux
          • mxcubecore.HardwareObjects.SOLEIL.SOLEILGuillotine
          • mxcubecore.HardwareObjects.SOLEIL.SOLEILPss
          • mxcubecore.HardwareObjects.SOLEIL.SOLEILRuche
          • mxcubecore.HardwareObjects.SOLEIL.SOLEILSafetyShutter
          • mxcubecore.HardwareObjects.SOLEIL.SOLEILSession
        • mxcubecore.HardwareObjects.SampleStage
        • mxcubecore.HardwareObjects.SampleView
        • mxcubecore.HardwareObjects.SardanaMotor
        • mxcubecore.HardwareObjects.SecureXMLRpcRequestHandler
        • mxcubecore.HardwareObjects.Session
        • mxcubecore.HardwareObjects.SimpleHTML
        • mxcubecore.HardwareObjects.StateMachine
        • mxcubecore.HardwareObjects.TangoLimaMpegVideo
        • mxcubecore.HardwareObjects.TangoLimaVideo
        • mxcubecore.HardwareObjects.TangoLimaVideoDevice
        • mxcubecore.HardwareObjects.TangoMachineInfo
        • mxcubecore.HardwareObjects.TangoMotor
        • mxcubecore.HardwareObjects.TangoShutter
        • mxcubecore.HardwareObjects.UnitTest
        • mxcubecore.HardwareObjects.XMLRPCServer
        • mxcubecore.HardwareObjects.XRFSpectrum
        • mxcubecore.HardwareObjects.XSDataAutoprocv1_0
        • mxcubecore.HardwareObjects.XSDataCommon
        • mxcubecore.HardwareObjects.XSDataControlDozorv1_1
        • mxcubecore.HardwareObjects.XSDataMXCuBEv1_3
        • mxcubecore.HardwareObjects.XSDataMXCuBEv1_4
        • mxcubecore.HardwareObjects.XSDataMXv1
        • mxcubecore.HardwareObjects.abstract
          • mxcubecore.HardwareObjects.abstract.AbstractActuator
          • mxcubecore.HardwareObjects.abstract.AbstractAperture
          • mxcubecore.HardwareObjects.abstract.AbstractAuthenticator
          • mxcubecore.HardwareObjects.abstract.AbstractBeam
          • mxcubecore.HardwareObjects.abstract.AbstractCharacterisation
          • mxcubecore.HardwareObjects.abstract.AbstractCollect
          • mxcubecore.HardwareObjects.abstract.AbstractDetector
          • mxcubecore.HardwareObjects.abstract.AbstractEnergy
          • mxcubecore.HardwareObjects.abstract.AbstractEnergyScan
          • mxcubecore.HardwareObjects.abstract.AbstractFlux
          • mxcubecore.HardwareObjects.abstract.AbstractMCA
          • mxcubecore.HardwareObjects.abstract.AbstractMachineInfo
          • mxcubecore.HardwareObjects.abstract.AbstractMotor
          • mxcubecore.HardwareObjects.abstract.AbstractMultiCollect
          • mxcubecore.HardwareObjects.abstract.AbstractNState
          • mxcubecore.HardwareObjects.abstract.AbstractOnlineProcessing
          • mxcubecore.HardwareObjects.abstract.AbstractProcedure
          • mxcubecore.HardwareObjects.abstract.AbstractResolution
          • mxcubecore.HardwareObjects.abstract.AbstractSampleChanger
          • mxcubecore.HardwareObjects.abstract.AbstractSampleView
          • mxcubecore.HardwareObjects.abstract.AbstractShutter
          • mxcubecore.HardwareObjects.abstract.AbstractSlits
          • mxcubecore.HardwareObjects.abstract.AbstractTransmission
          • mxcubecore.HardwareObjects.abstract.AbstractVideoDevice
          • mxcubecore.HardwareObjects.abstract.AbstractXRFSpectrum
          • mxcubecore.HardwareObjects.abstract.AbstractXrayCentring
          • mxcubecore.HardwareObjects.abstract.ISPyBValueFactory
          • mxcubecore.HardwareObjects.abstract.sample_changer
            • mxcubecore.HardwareObjects.abstract.sample_changer.Component
            • mxcubecore.HardwareObjects.abstract.sample_changer.Container
            • mxcubecore.HardwareObjects.abstract.sample_changer.Crims
            • mxcubecore.HardwareObjects.abstract.sample_changer.Sample
        • mxcubecore.HardwareObjects.autoprocessing
        • mxcubecore.HardwareObjects.edna_test_data
        • mxcubecore.HardwareObjects.mockup
          • mxcubecore.HardwareObjects.mockup.ActuatorMockup
          • mxcubecore.HardwareObjects.mockup.ApertureMockup
          • mxcubecore.HardwareObjects.mockup.BIOMAXEigerMockup
          • mxcubecore.HardwareObjects.mockup.BeamDefinerMockup
          • mxcubecore.HardwareObjects.mockup.BeamMockup
          • mxcubecore.HardwareObjects.mockup.BeamlineActionsMockup
          • mxcubecore.HardwareObjects.mockup.BeamlineTestMockup
          • mxcubecore.HardwareObjects.mockup.BeamstopMockup
          • mxcubecore.HardwareObjects.mockup.CatsMaintMockup
          • mxcubecore.HardwareObjects.mockup.CollectMockup
          • mxcubecore.HardwareObjects.mockup.DetectorMockup
          • mxcubecore.HardwareObjects.mockup.DiffractometerMockup
          • mxcubecore.HardwareObjects.mockup.DoorInterlockMockup
          • mxcubecore.HardwareObjects.mockup.EDNACharacterisationMockup
          • mxcubecore.HardwareObjects.mockup.EnergyMockup
          • mxcubecore.HardwareObjects.mockup.EnergyScanMockup
          • mxcubecore.HardwareObjects.mockup.ExporterNStateMockup
          • mxcubecore.HardwareObjects.mockup.FluxMockup
          • mxcubecore.HardwareObjects.mockup.HarvesterMockup
          • mxcubecore.HardwareObjects.mockup.ISPyBRestClientMockup
          • mxcubecore.HardwareObjects.mockup.LimaDetectorMockup
          • mxcubecore.HardwareObjects.mockup.MDCameraMockup
          • mxcubecore.HardwareObjects.mockup.MachineInfoMockup
          • mxcubecore.HardwareObjects.mockup.MicrodiffApertureMockup
          • mxcubecore.HardwareObjects.mockup.MicrodiffInOutMockup
          • mxcubecore.HardwareObjects.mockup.MicrodiffZoomMockup
          • mxcubecore.HardwareObjects.mockup.MotorMockup
          • mxcubecore.HardwareObjects.mockup.MotorMockupBis
          • mxcubecore.HardwareObjects.mockup.MultiCollectMockup
          • mxcubecore.HardwareObjects.mockup.OfflineProcessingMockup
          • mxcubecore.HardwareObjects.mockup.OnlineProcessingMockup
          • mxcubecore.HardwareObjects.mockup.PlateManipulatorMockup
          • mxcubecore.HardwareObjects.mockup.PlottingMockup
          • mxcubecore.HardwareObjects.mockup.ProcedureMockup
          • mxcubecore.HardwareObjects.mockup.ResolutionMockup
          • mxcubecore.HardwareObjects.mockup.SOLEILCharacterisationMockup
          • mxcubecore.HardwareObjects.mockup.SampleChangerMockup
          • mxcubecore.HardwareObjects.mockup.ShapeHistoryMockup
          • mxcubecore.HardwareObjects.mockup.ShutterMockup
          • mxcubecore.HardwareObjects.mockup.SlitsMockup
          • mxcubecore.HardwareObjects.mockup.TransmissionMockup
          • mxcubecore.HardwareObjects.mockup.XRFMockup
          • mxcubecore.HardwareObjects.mockup.XRFSpectrumMockup
          • mxcubecore.HardwareObjects.mockup.XrayCentringMockup
        • mxcubecore.HardwareObjects.sample_centring
      • mxcubecore.HardwareRepository
      • mxcubecore.Poller
      • mxcubecore.TaskUtils
      • mxcubecore.dispatcher
      • mxcubecore.model
        • mxcubecore.model.common
        • mxcubecore.model.configmodel
        • mxcubecore.model.crystal_symmetry
        • mxcubecore.model.procedure_model
        • mxcubecore.model.queue_model_enumerables
        • mxcubecore.model.queue_model_objects
      • mxcubecore.queue_entry
        • mxcubecore.queue_entry.advanced_connector
        • mxcubecore.queue_entry.base_queue_entry
        • mxcubecore.queue_entry.characterisation
        • mxcubecore.queue_entry.data_collection
        • mxcubecore.queue_entry.energy_scan
        • mxcubecore.queue_entry.generic_workflow
        • mxcubecore.queue_entry.import_helper
        • mxcubecore.queue_entry.optical_centring
        • mxcubecore.queue_entry.sample_centring
        • mxcubecore.queue_entry.test_collection
        • mxcubecore.queue_entry.xray_centering
        • mxcubecore.queue_entry.xray_centering2
        • mxcubecore.queue_entry.xrf_spectrum
      • mxcubecore.saferef
      • mxcubecore.utils
        • mxcubecore.utils.conversion
        • mxcubecore.utils.dataobject
        • mxcubecore.utils.qt_import
        • mxcubecore.utils.units
  • Configuration files
  • How to contribute?
  • Working with documentation
  • JSON-schema generated user interface
  • LIMS integration
  • Queue system