APF Python library ================== .. module:: APF .. moduleauthor:: Kyle Lanclos The APF Python module is intended to provide high-level access to basic functionality of the APF dome and telescope. In many cases, functions are wrappers to other software; in others, the core functionality is implemented directly. The APF module is not complete. Functions have been added strictly on an as-needed basis, as needs emerged elsewhere in the APF software ecosystem. APF systems are grouped into submodules within the APF module. None of the systems break out as individual classes; users of the APF module are expected to use the APF module directly, almost as if it were a global class instance. Programming infrastructure -------------------------- The APF module also implements common infrastructure used by many Python tools associated with the APF. .. autofunction:: log .. autofunction:: service .. autofunction:: write Telescope control ----------------- Many of the functions defined here are thin wrappers to the ``slew`` script. .. autofunction:: APF.Telescope.disable .. autofunction:: APF.Telescope.home .. autofunction:: APF.Telescope.park .. autofunction:: APF.Telescope.slew Dome shutter control -------------------- Many of the functions defined here are thin wrappers to the ``shutters`` script. .. autofunction:: APF.Shutters.close .. autofunction:: APF.Shutters.closed .. autofunction:: APF.Shutters.crack .. autofunction:: APF.Shutters.move .. autofunction:: APF.Shutters.open .. autofunction:: APF.Shutters.opened Dome vent control ----------------- .. autofunction:: APF.Vents.close .. autofunction:: APF.Vents.closed .. autofunction:: APF.Vents.open .. autofunction:: APF.Vents.opened Exceptions ---------- .. autoclass:: EmergencyStop .. autoclass:: PermissionError .. autoclass:: PhysicalEmergencyStop .. autoclass:: SoftwareEmergencyStop