Modules

This page provides an overview of the main modules in the AFL-automation framework.

• API Server
  • AFL.automation.APIServer
    • APIServer
      • APIServer.__init__()
      • APIServer.add_standard_routes()
      • APIServer.add_unqueued_routes()
      • APIServer.advertise_zeroconf()
      • APIServer.clear_history()
      • APIServer.clear_queue()
      • APIServer.create_queue()
      • APIServer.debug()
      • APIServer.deposit_obj()
      • APIServer.driver_status()
      • APIServer.enqueue()
      • APIServer.get_driver_object()
      • APIServer.get_info()
      • APIServer.get_queue()
      • APIServer.get_queue_iteration()
      • APIServer.get_queued_commands()
      • APIServer.get_quickbar()
      • APIServer.get_server_time()
      • APIServer.get_unqueued_commands()
      • APIServer.halt()
      • APIServer.index()
      • APIServer.index_new()
      • APIServer.init()
      • APIServer.init_logging()
      • APIServer.is_server_live()
      • APIServer.login()
      • APIServer.login_test()
      • APIServer.move_item()
      • APIServer.pause()
      • APIServer.query_driver()
      • APIServer.queue_state()
      • APIServer.remove_item()
      • APIServer.remove_items()
      • APIServer.render_unqueued()
      • APIServer.reorder_queue()
      • APIServer.reset_queue_daemon()
      • APIServer.retrieve_obj()
      • APIServer.run()
      • APIServer.run_threaded()
      • APIServer.send_1d_plot()
      • APIServer.send_array_as_jpg()
      • APIServer.set_driver_object()
      • APIServer.tiled_upload_data()
      • APIServer.webapp()
    • CAStatusPublisher
      • CAStatusPublisher.__init__()
      • CAStatusPublisher.run()
    • AFL.automation.APIServer.Client
      • Client
    • AFL.automation.APIServer.Driver
      • makeRegistrar()
      • Driver
    • AFL.automation.APIServer.DriverWebAppsMixin
      • DriverWebAppsMixin
    • AFL.automation.APIServer.DummyDriver
      • DummyDriver
    • AFL.automation.APIServer.DummyOT2Driver
      • DummyDriver
    • AFL.automation.APIServer.LoggerFilter
      • LoggerFilter
    • AFL.automation.APIServer.QueueDaemon
      • QueueDaemon
    • AFL.automation.APIServer.data
      • DataPacket
      • DataJSON
      • DataTiled
      • DataTrashcan
      • AFL.automation.APIServer.data.TiledClients
• Instrument
  • AFL.automation.instrument
    • AFL.automation.instrument.APSDNDCAT
      • APSDNDCAT
    • AFL.automation.instrument.APSUSAXS
      • APSUSAXS
    • AFL.automation.instrument.APSUSAXS_Phantom
      • APSUSAXS_Phantom
    • AFL.automation.instrument.BioSANS
      • BioSANS
    • AFL.automation.instrument.CDSAXSLabview
      • CDSAXSLabview
      • LabviewConnection
    • AFL.automation.instrument.CHESSID3B
      • CHESSID3B
    • AFL.automation.instrument.DummySAS
      • DummySAS
    • AFL.automation.instrument.FileCamera
      • FileCamera
    • AFL.automation.instrument.GPInterpolator
      • Interpolator
      • ClusteredGPs
    • AFL.automation.instrument.I22SAXS
      • I22SAXS
    • AFL.automation.instrument.ISISLARMOR
      • ISISLARMOR
    • AFL.automation.instrument.NICEConsole
      • NICEConsole
    • AFL.automation.instrument.NICEData
      • NICEData
    • AFL.automation.instrument.NICEDevice
      • NICEDevice
    • AFL.automation.instrument.NetworkCamera
      • NetworkCamera
    • AFL.automation.instrument.NicosScriptClient
      • NicosScriptClient
    • AFL.automation.instrument.OpticalTurbidity
      • OpticalTurbidity
    • AFL.automation.instrument.PySpecClient
      • PySpecClient
    • AFL.automation.instrument.SINQSANS
      • SINQSANS
      • SICSTelnetClient
    • AFL.automation.instrument.SINQSANS_NICOS
      • SINQSANS_NICOS
    • AFL.automation.instrument.ScatteringInstrument
      • ScatteringInstrument
    • AFL.automation.instrument.SeabreezeUVVis
      • SeabreezeUVVis
    • AFL.automation.instrument.SpecScreen_Driver
      • SpecScreen_Driver
    • AFL.automation.instrument.USBCamera
      • USBCamera
    • AFL.automation.instrument.VirtualInstrument
      • VirtualInstrument
    • AFL.automation.instrument.VirtualSANS_data
      • VirtualSANS_data
    • AFL.automation.instrument.VirtualSAS
      • VirtualSAS
    • AFL.automation.instrument.VirtualSAS_theory
      • VirtualSAS_theory
    • AFL.automation.instrument.VirtualSpec_data
      • VirtualSpec_data
    • AFL.automation.instrument.scatteringInterpolator
      • Scattering_generator
      • GenerateScattering
• Loading
  • AFL.automation.loading
    • AFL.automation.loading.CetoniMultiPosValve
      • CetoniMultiPosValve
    • AFL.automation.loading.CetoniSyringePump
      • CetoniSyringePump
    • AFL.automation.loading.ChemyxSyringePump
      • ChemyxSyringePump
      • getOpenPorts()
      • parsePortName()
      • ChemyxConnection
    • AFL.automation.loading.DAQC2Sensor
      • DACQC2Sensor
    • AFL.automation.loading.DigitalOutPressureController
      • DigitalOutPressureController
    • AFL.automation.loading.DoubleViciMultiposSelector
      • DoubleViciMultiposSelector
    • AFL.automation.loading.DummyPump
      • DummyPump
    • AFL.automation.loading.FlowSelector
      • FlowSelector
    • AFL.automation.loading.LabJackDigitalOut
      • LabJackDigitalOut
    • AFL.automation.loading.LabJackGPIO
      • LabJackGPIO
    • AFL.automation.loading.LabJackRelay
      • LabJackRelay
      • bitmask_to_dict()
    • AFL.automation.loading.LabJackSensor
      • LabJackSensor
    • AFL.automation.loading.LoadStopperDriver
      • LoadStopperDriver
    • AFL.automation.loading.MultiChannelRelay
      • MultiChannelRelay
    • AFL.automation.loading.NE1kSyringePump
      • NE1kSyringePump
    • AFL.automation.loading.OneSelectorBlowoutSampleCell
      • OneSelectorBlowoutSampleCell
    • AFL.automation.loading.PiGPIO
      • PiGPIO
    • AFL.automation.loading.PiPlatesRelay
      • PiPlatesRelay
    • AFL.automation.loading.PneumaticPressureSampleCell
      • PneumaticPressureSampleCell
    • AFL.automation.loading.PneumaticSampleCell
      • PneumaticSampleCell
    • AFL.automation.loading.PressureController
      • PressureController
    • AFL.automation.loading.PressureControllerAsPump
      • PressureControllerAsPump
    • AFL.automation.loading.PushPullSelectorSampleCell
      • PushPullSelectorSampleCell
    • AFL.automation.loading.RSoXSSolutionSampleCell
      • RSoXSSolutionSampleCell
    • AFL.automation.loading.SainSmartRelay
      • SainSmartRelay
      • usbrelay
    • AFL.automation.loading.SampleCell
      • SampleCell
    • AFL.automation.loading.Sensor
      • Sensor
      • DummySensor1
      • DummySensor2
    • AFL.automation.loading.SensorCallbackThread
      • SensorCallbackThread
      • StopLoadCBv1
      • StopLoadCBv2
      • SimpleThresholdCB
      • LoaderCommunication
    • AFL.automation.loading.SensorPollingThread
      • SensorPollingThread
    • AFL.automation.loading.SerialDevice
      • SerialDevice
    • AFL.automation.loading.SyringePump
      • SyringePump
    • AFL.automation.loading.Tubing
      • Tubing
    • AFL.automation.loading.TwoSelectorBlowoutSampleCell
      • TwoSelectorBlowoutSampleCell
    • AFL.automation.loading.UltimusVPressureController
      • UltimusVPressureController
    • AFL.automation.loading.ViciMultiposSelector
      • ViciMultiposSelector
    • AFL.automation.loading.VirtualPneumaticPressureLoader
      • NoOpPressureController
      • NoOpRelayBoard
      • NoOpDigitalIn
      • VirtualPneumaticPressureLoader
• Mixcalc
  • AFL.automation.mixcalc
    • BalanceDiagnosis
      • BalanceDiagnosis.__init__()
      • BalanceDiagnosis.summary()
      • BalanceDiagnosis.to_dict()
      • BalanceDiagnosis.success
      • BalanceDiagnosis.details
      • BalanceDiagnosis.component_errors
    • FailureCode
      • FailureCode.MISSING_STOCK_COMPONENT
      • FailureCode.STOCK_CONCENTRATION_TOO_LOW
      • FailureCode.TARGET_OUTSIDE_REACHABLE_COMPOSITIONS
      • FailureCode.BELOW_MINIMUM_PIPETTE_VOLUME
      • FailureCode.UNWANTED_STOCK_COMPONENT
      • FailureCode.TOLERANCE_EXCEEDED
    • FailureDetail
      • FailureDetail.__init__()
      • FailureDetail.to_dict()
      • FailureDetail.code
      • FailureDetail.description
      • FailureDetail.affected_components
      • FailureDetail.affected_stocks
      • FailureDetail.data
    • Component
      • Component.__hash__()
      • Component.__init__()
      • Component.__iter__()
      • Component.copy()
      • Component.density
      • Component.emit()
      • Component.formula
      • Component.has_density
      • Component.has_formula
      • Component.has_mass
      • Component.has_sld
      • Component.has_volume
      • Component.is_solute
      • Component.is_solvent
      • Component.mass
      • Component.moles
      • Component.set_mass()
      • Component.set_volume()
      • Component.sld
      • Component.volume
    • Context
      • Context.__init__()
      • Context.add_self_to_context()
      • Context.contexts
      • Context.get_context()
      • Context.get_contexts()
    • NoContextException
    • MassBalance
      • MassBalance.__init__()
      • MassBalance.stock_components
      • MassBalance.target_components
    • MassBalanceBase
      • MassBalanceBase.__init__()
      • MassBalanceBase.balance()
      • MassBalanceBase.balance_report()
      • MassBalanceBase.components
      • MassBalanceBase.failure_summary()
      • MassBalanceBase.make_target_names()
      • MassBalanceBase.mass_fraction_matrix()
      • MassBalanceBase.stock_components
      • MassBalanceBase.target_components
    • MassBalanceDriver
      • MassBalanceDriver.__init__()
      • MassBalanceDriver.add_component()
      • MassBalanceDriver.add_stock()
      • MassBalanceDriver.add_target()
      • MassBalanceDriver.add_targets()
      • MassBalanceDriver.balance()
      • MassBalanceDriver.compute_stock_properties()
      • MassBalanceDriver.defaults
      • MassBalanceDriver.get_balance_progress()
      • MassBalanceDriver.get_balance_settings()
      • MassBalanceDriver.get_sample_composition()
      • MassBalanceDriver.get_storage_sources()
      • MassBalanceDriver.list_balanced_targets()
      • MassBalanceDriver.list_components()
      • MassBalanceDriver.list_stock_history()
      • MassBalanceDriver.list_stocks()
      • MassBalanceDriver.list_targets()
      • MassBalanceDriver.load_stock_history()
      • MassBalanceDriver.load_sweep_config()
      • MassBalanceDriver.process_stocks()
      • MassBalanceDriver.process_targets()
      • MassBalanceDriver.remove_component()
      • MassBalanceDriver.reset_stocks()
      • MassBalanceDriver.reset_targets()
      • MassBalanceDriver.save_sweep_config()
      • MassBalanceDriver.stock_components
      • MassBalanceDriver.target_components
      • MassBalanceDriver.update_component()
      • MassBalanceDriver.upload_stocks()
      • MassBalanceDriver.upload_targets()
    • MassBalanceWebAppMixin
      • MassBalanceWebAppMixin.get_orchestrator_context()
      • MassBalanceWebAppMixin.get_prepare_context()
      • MassBalanceWebAppMixin.mixdoctor()
      • MassBalanceWebAppMixin.submit_orchestrator_grid()
      • MassBalanceWebAppMixin.submit_prepare_grid()
    • MixDB
      • MixDB.__init__()
      • MixDB.add_component()
      • MixDB.add_component_interactive()
      • MixDB.get_component()
      • MixDB.get_db()
      • MixDB.get_source()
      • MixDB.list_components()
      • MixDB.remove_component()
      • MixDB.set_db()
      • MixDB.update_component()
      • MixDB.write()
    • PipetteAction
      • PipetteAction.__init__()
      • PipetteAction.emit_protocol()
      • PipetteAction.get_kwargs()
    • Solution
      • Solution.__eq__()
      • Solution.__hash__()
      • Solution.__init__()
      • Solution.add_component()
      • Solution.all_components_have_mass()
      • Solution.concentration
      • Solution.contains()
      • Solution.copy()
      • Solution.mass
      • Solution.mass_fraction
      • Solution.measure_out()
      • Solution.molality
      • Solution.molarity
      • Solution.rename_component()
      • Solution.set_mass()
      • Solution.set_properties_from_dict()
      • Solution.set_volume()
      • Solution.size
      • Solution.solutes
      • Solution.solvent_density
      • Solution.solvent_mass
      • Solution.solvent_sld
      • Solution.solvent_volume
      • Solution.solvents
      • Solution.to_dict()
      • Solution.volume
      • Solution.volume_fraction
    • TargetSolution
• Prepare
  • AFL.automation.prepare
    • AFL.automation.prepare.BioSANSPrepare
      • BioSANSPrepare
    • AFL.automation.prepare.OT2DeckWebAppMixin
      • OT2DeckWebAppMixin
    • AFL.automation.prepare.OT2HTTPDriver
      • OT2HTTPDriver
    • AFL.automation.prepare.OT2Prepare
      • OT2Prepare
    • AFL.automation.prepare.OT2_Driver
      • OT2_Driver
      • argmax()
      • argmin()
    • AFL.automation.prepare.PipetteAction
      • PipetteAction
    • AFL.automation.prepare.PrepareDriver
      • PrepareDriver
    • AFL.automation.prepare.VirtualOT2HTTPDriver
      • VirtualOT2HTTPDriver
    • AFL.automation.prepare.utilities
      • make_locs()
      • make_wellplate_locs()
• Shared
  • AFL.automation.shared
    • AFL.automation.shared.DataLabelerWidget
      • DataLabelerWidget
      • DataLabelerModel
      • DataLabelerView
    • AFL.automation.shared.DatasetWidget
      • DatasetWidget
      • DatasetWidget_Model
      • DatasetWidget_View
    • AFL.automation.shared.DiffractionLabeler
      • DiffractionLabeler
      • DiffractionLabelerModel
      • DiffractionLabelerView
    • AFL.automation.shared.MutableQueue
      • MutableQueue
    • AFL.automation.shared.PersistentConfig
      • PersistentConfig
    • AFL.automation.shared.ServerDiscovery
      • RunThread
      • ServerDiscovery
    • AFL.automation.shared.exceptions
      • EmptyException
      • MixingException
      • SerialCommsException
      • NoDeviceFoundException
      • NotFoundError
    • AFL.automation.shared.mock_eic_client
      • MockEICClient
    • AFL.automation.shared.serialization
      • serialize()
      • is_serialized()
      • deserialize()
    • AFL.automation.shared.units
      • has_units()
      • is_volume()
      • is_molarity()
      • is_molality()
      • is_mass()
      • is_density()
      • is_concentration()
      • is_dimensionless()
      • get_unit_type()
      • to_quantity()
      • enforce_units()
    • AFL.automation.shared.utilities
      • listify()
      • makeRegistar()
      • mpl_plot_to_bytes()
      • xarray_to_bytes()
    • AFL.automation.shared.warnings
      • warning_on_one_line()
      • MixWarning
    • AFL.automation.shared.widgetui
      • client_construct_ui()