pyobs Logo
  • Quickstart
    • Install pyobs
    • Run simple config
  • Installing pyobs
    • Setting up ejabberd
    • Install pyobs
    • Using the pyobsd tool
  • Developing pyobs
    • Install uv
    • Install poetry
    • Setting up development for pyobs-core
      • Using uv
      • Using poetry
  • Overview
    • Modules
    • Location of observatory
    • Communication between modules
    • Virtual File System
    • Events
  • Command Line Interface
    • Module launcher pyobs
      • Parameters
      • Username and password
    • pyobsd daemon
      • Commands
      • CLI Parameters
  • Robotic mode (pyobs.robotic)
    • Scheduling (pyobs.robotic.scheduler)
      • Task and Observation
        • Task
        • Project
        • TaskData
        • Observation
        • ObservationState
      • Targets
        • Target
        • SiderealTarget
      • Constraints
        • Constraint
        • AirmassConstraint
        • SolarElevationConstraint
        • MoonIlluminationConstraint
        • MoonSeparationConstraint
        • TimeConstraint
      • Merits
        • Merit
        • ConstantMerit
        • AfterTimeMerit
        • BeforeTimeMerit
        • TimeWindowMerit
        • TransitMerit
        • IntervalMerit
        • PerNightMerit
        • FollowMerit
        • RandomMerit
      • Scheduler
        • TaskScheduler
        • OnDemandScheduler
        • AstroplanScheduler
      • Task and Observation archives
        • TaskArchive
        • ObservationArchive
        • Archive implementations
      • Image archives
        • Archive
        • PyobsArchive
        • LocalArchive
      • Scheduling internals
        • DataProvider
        • ObservationArchiveEvolution
    • Scripts (pyobs.robotic.scripts)
      • Writing a script
      • Runtime context
      • TaskData
      • Script base class
        • Script
      • Built-in scripts
        • Observing
        • Control flow
        • TargetPicker
      • Sky flat utilities
        • FlatFielder
        • SkyFlatsBasePointing
        • SkyFlatsStaticPointing
        • SkyflatPriorities
        • ConstSkyflatPriorities
        • ArchiveSkyflatPriorities
    • Serialization (pyobs.utils.serialization)
      • Why pydantic models?
      • BaseModel
      • PolymorphicBaseModel
      • PrivateAttrMixin
      • API reference
        • BaseModel
        • PolymorphicBaseModel
        • PrivateAttrMixin
    • Architecture
    • Module layer vs. robotic layer
    • Tasks and scheduling
    • Scheduler re-triggering
    • Scripts
    • Archive implementations
    • Further reading
  • Scheduling (pyobs.robotic.scheduler)
    • Task and Observation
      • Task
        • Task.can_run()
        • Task.can_start_late
        • Task.get_fits_headers()
        • Task.is_finished()
        • Task.model_config
        • Task.model_post_init()
        • Task.resolve_target()
        • Task.run()
        • Task.set_resolved_target()
        • Task.target
      • Project
        • Project.model_config
        • Project.model_post_init()
      • TaskData
      • Observation
        • Observation.fetch_task()
        • Observation.model_config
        • Observation.model_dump()
        • Observation.model_post_init()
      • ObservationState
    • Targets
      • Target
        • Target.model_config
        • Target.model_post_init()
        • Target.resolve()
      • SiderealTarget
        • SiderealTarget.model_config
        • SiderealTarget.model_post_init()
    • Constraints
      • Constraint
        • Constraint.model_config
        • Constraint.model_post_init()
      • AirmassConstraint
        • AirmassConstraint.model_config
        • AirmassConstraint.model_post_init()
      • SolarElevationConstraint
        • SolarElevationConstraint.model_config
        • SolarElevationConstraint.model_post_init()
      • MoonIlluminationConstraint
        • MoonIlluminationConstraint.model_config
        • MoonIlluminationConstraint.model_post_init()
      • MoonSeparationConstraint
        • MoonSeparationConstraint.model_config
        • MoonSeparationConstraint.model_post_init()
      • TimeConstraint
        • TimeConstraint.model_config
        • TimeConstraint.model_post_init()
    • Merits
      • Merit
        • Merit.model_config
        • Merit.model_post_init()
      • ConstantMerit
        • ConstantMerit.model_config
        • ConstantMerit.model_post_init()
      • AfterTimeMerit
        • AfterTimeMerit.model_config
        • AfterTimeMerit.model_post_init()
      • BeforeTimeMerit
        • BeforeTimeMerit.model_config
        • BeforeTimeMerit.model_post_init()
      • TimeWindowMerit
        • TimeWindowMerit.model_config
        • TimeWindowMerit.model_post_init()
      • TransitMerit
        • TransitMerit.model_config
        • TransitMerit.model_post_init()
      • IntervalMerit
        • IntervalMerit.model_config
        • IntervalMerit.model_post_init()
      • PerNightMerit
        • PerNightMerit.model_config
        • PerNightMerit.model_post_init()
      • FollowMerit
        • FollowMerit.model_config
        • FollowMerit.model_post_init()
      • RandomMerit
        • RandomMerit.model_config
        • RandomMerit.model_post_init()
    • Scheduler
      • TaskScheduler
      • OnDemandScheduler
        • OnDemandScheduler.evaluate_constraints()
        • OnDemandScheduler.evaluate_merits()
      • AstroplanScheduler
    • Task and Observation archives
      • TaskArchive
        • TaskArchive.get_projects()
        • TaskArchive.get_schedulable_tasks()
        • TaskArchive.get_task()
        • TaskArchive.last_changed()
      • ObservationArchive
        • ObservationArchive.add_observations()
        • ObservationArchive.clear_schedule()
        • ObservationArchive.get_current_observation()
        • ObservationArchive.get_next_observation()
        • ObservationArchive.get_observations()
        • ObservationArchive.get_schedule()
        • ObservationArchive.update_observation()
      • Archive implementations
        • BackendTaskArchive
        • BackendObservationArchive
        • LcoTaskArchive
        • LcoObservationArchive
        • LcoTaskRunner
    • Image archives
      • Archive
        • Archive.model_config
        • Archive.model_post_init()
      • PyobsArchive
        • PyobsArchive.model_config
        • PyobsArchive.model_post_init()
      • LocalArchive
        • LocalArchive.model_config
        • LocalArchive.model_post_init()
    • Scheduling internals
      • DataProvider
        • DataProvider.last_sunrise()
        • DataProvider.last_sunset()
        • DataProvider.night()
      • ObservationArchiveEvolution
        • ObservationArchiveEvolution.observations_for_night()
  • Scripts (pyobs.robotic.scripts)
    • Writing a script
    • Runtime context
    • TaskData
    • Script base class
      • Script
        • Script.can_run()
        • Script.estimate_duration()
        • Script.get_fits_headers()
        • Script.model_config
        • Script.model_post_init()
        • Script.run()
    • Built-in scripts
      • Observing
        • AutoFocus
        • DarkBias
        • SkyFlats
      • Control flow
        • SequentialRunner
        • ParallelRunner
        • ConditionalRunner
        • CasesRunner
        • SelectorScript
        • CallModule
        • LogRunner
      • TargetPicker
    • Sky flat utilities
      • FlatFielder
        • FlatFielder.State
        • FlatFielder.Twilight
        • FlatFielder.abort()
        • FlatFielder.has_filters
        • FlatFielder.reset()
      • SkyFlatsBasePointing
        • SkyFlatsBasePointing.model_config
        • SkyFlatsBasePointing.model_post_init()
        • SkyFlatsBasePointing.reset()
      • SkyFlatsStaticPointing
        • SkyFlatsStaticPointing.model_config
        • SkyFlatsStaticPointing.model_post_init()
        • SkyFlatsStaticPointing.reset()
      • SkyflatPriorities
        • SkyflatPriorities.model_config
        • SkyflatPriorities.model_post_init()
      • ConstSkyflatPriorities
        • ConstSkyflatPriorities.model_config
        • ConstSkyflatPriorities.model_post_init()
      • ArchiveSkyflatPriorities
        • ArchiveSkyflatPriorities.model_config
        • ArchiveSkyflatPriorities.model_post_init()
  • Serialization (pyobs.utils.serialization)
    • Why pydantic models?
    • BaseModel
    • PolymorphicBaseModel
    • PrivateAttrMixin
    • API reference
      • BaseModel
        • BaseModel.model_config
        • BaseModel.model_post_init()
      • PolymorphicBaseModel
        • PolymorphicBaseModel.model_config
        • PolymorphicBaseModel.model_post_init()
        • PolymorphicBaseModel.retrieve_class_on_deserialization()
      • PrivateAttrMixin
        • PrivateAttrMixin.pyobs_model_validate()
  • Setting up a minimal robotic observation system
    • Overview
    • Step 1 — Write a task YAML file
    • Step 2 — Write a Script
    • Step 3 — Configure the Scheduler module
    • Step 4 — Configure the Mastermind module
    • Step 5 — Run the system
    • Where to go next
  • Setting up a pyobs system with simulated telescope and camera
    • Setting up the venv
    • Simulated telescope
    • Simulated camera
    • Graphical user interface
    • Virtual file system
    • Connecting telescope and camera
  • Minimal working setup for pyobs inside a Jupyter notebook
    • Introduction
    • Setup
      • Preparations
      • Credentials
      • Comm
        • Open Comms
        • Closing Comms
      • Virtual File System (VFS)
    • Usage
      • Telescope
      • Camera
  • Configuration of the IAG 50cm
    • iag50srv
      • acquisition
      • autofocus
      • dome
      • filecache
      • flatfield
      • focuser
      • imagewatcher
      • imagewriter
      • pointing
      • robotic
      • scheduler
      • sfag
      • startup
      • telegram
      • telescope
      • weather
    • iag50cam
      • sbig6303e
      • asi071mc
  • Configuration of the IAG VVT
    • acquisition
    • fibercamera
    • filecache
    • filewatcher
    • fts
    • gregorycamera
    • guiding
    • robotic
    • solartelescope
    • suncamera
    • weather
  • API
    • Objects (pyobs.object)
      • The class: key and YAML instantiation
      • Lifecycle: __init__, open(), and close()
      • Runtime context: comm, vfs, observer, location, timezone
      • Background tasks
      • Child objects
      • API reference
        • Object
        • get_object()
        • get_safe_object()
        • create_object()
        • get_class_from_string()
    • Modules (pyobs.modules)
      • Writing a minimal module
      • Interfaces
      • Communicating between modules
      • The @timeout decorator
      • API reference
        • Module
        • MultiModule
    • Mixins (pyobs.mixins)
      • CameraSettingsMixin
        • CameraSettingsMixin
      • FitsHeaderMixin
        • FitsHeaderMixin
      • FitsNamespaceMixin
        • FitsNamespaceMixin
      • FollowMixin
        • FollowMixin
      • ImageFitsHeaderMixin
        • ImageFitsHeaderMixin
      • MotionStatusMixin
        • MotionStatusMixin
      • SpectrumFitsHeaderMixin
        • SpectrumFitsHeaderMixin
      • WaitForMotionMixin
        • WaitForMotionMixin
      • WeatherAwareMixin
        • WeatherAwareMixin
    • Communication between modules (pyobs.comm)
      • Configuration
      • Proxies and remote method calls
      • Events
      • Implementations
      • API reference
        • Comm
        • Proxy
        • XmppComm
        • DbusComm
    • Virtual File System (pyobs.vfs)
      • Configuration
      • Reading and writing files
      • File access classes
      • API reference
        • VirtualFileSystem
        • VFSFile
        • LocalFile
        • HttpFile
        • SSHFile
        • SFTPFile
        • SMBFile
        • MemoryFile
        • TempFile
        • ArchiveFile
    • Interfaces (pyobs.interfaces)
      • Interface
      • IAbortable
        • IAbortable
      • IAcquisition
        • IAcquisition
      • IAutoFocus
        • IAutoFocus
      • IAutoGuiding
        • IAutoGuiding
      • IAutonomous
        • IAutonomous
      • IBinning
        • IBinning
      • ICalibrate
        • ICalibrate
      • ICamera
        • ICamera
      • IConfig
        • IConfig
      • ICooling
        • ICooling
      • IData
        • IData
      • IDome
        • IDome
      • IExposure
        • IExposure
      • IExposureTime
        • IExposureTime
      • IFilters
        • IFilters
      • IFitsHeaderAfter
        • IFitsHeaderAfter
      • IFitsHeaderBefore
        • IFitsHeaderBefore
      • IFlatField
        • IFlatField
      • IFocusModel
        • IFocusModel
      • IFocuser
        • IFocuser
      • IGain
        • IGain
      • IImageFormat
        • IImageFormat
      • IImageType
        • IImageType
      • ILatLon
        • ILatLon
      • IMode
        • IMode
      • IModule
        • IModule
      • IMotion
        • IMotion
      • IMultiFiber
        • IMultiFiber
      • IOffsetsAltAz
        • IOffsetsAltAz
      • IOffsetsRaDec
        • IOffsetsRaDec
      • IPointingAltAz
        • IPointingAltAz
      • IPointingHGS
        • IPointingHGS
      • IPointingHelioprojective
        • IPointingHelioprojective
      • IPointingRaDec
        • IPointingRaDec
      • IPointingSeries
        • IPointingSeries
      • IReady
        • IReady
      • IRoof
        • IRoof
      • IRotation
        • IRotation
      • IRunnable
        • IRunnable
      • IRunning
        • IRunning
      • IScriptRunner
        • IScriptRunner
      • ISpectrograph
        • ISpectrograph
      • IStartStop
        • IStartStop
      • ISyncTarget
        • ISyncTarget
      • ITelescope
        • ITelescope
      • ITemperatures
        • ITemperatures
      • IVideo
        • IVideo
      • IWeather
        • IWeather
      • IWindow
        • IWindow
    • Events (pyobs.events)
      • BadWeatherEvent
        • BadWeatherEvent
      • Event
        • Event
      • ExposureStatusChangedEvent
        • ExposureStatusChangedEvent
      • FilterChangedEvent
        • FilterChangedEvent
      • FocusFoundEvent
        • FocusFoundEvent
      • GoodWeatherEvent
        • GoodWeatherEvent
      • LogEvent
        • LogEvent
      • ModeChangedEvent
        • ModeChangedEvent
      • ModuleClosedEvent
        • ModuleClosedEvent
      • ModuleOpenedEvent
        • ModuleOpenedEvent
      • MotionStatusChangedEvent
        • MotionStatusChangedEvent
      • MoveAltAzEvent
        • MoveAltAzEvent
      • MoveEvent
        • MoveEvent
      • MoveRaDecEvent
        • MoveRaDecEvent
      • NewImageEvent
        • NewImageEvent
      • NewSpectrumEvent
        • NewSpectrumEvent
      • OffsetsAltAzEvent
        • OffsetsAltAzEvent
      • OffsetsEvent
        • OffsetsEvent
      • OffsetsRaDecEvent
        • OffsetsRaDecEvent
      • RoofClosingEvent
        • RoofClosingEvent
      • RoofOpenedEvent
        • RoofOpenedEvent
      • TaskFailedEvent
        • TaskFailedEvent
      • TaskFinishedEvent
        • TaskFinishedEvent
      • TaskStartedEvent
        • TaskStartedEvent
      • TestEvent
        • TestEvent
    • Images (pyobs.images)
      • The Image class
      • Creating images
      • Serialisation
      • Meta information
      • Image processors
      • API reference
        • Image
        • ImageProcessor
        • Meta classes
    • Robotic mode (pyobs.robotic)
      • Scheduling (pyobs.robotic.scheduler)
        • Task and Observation
        • Targets
        • Constraints
        • Merits
        • Scheduler
        • Task and Observation archives
        • Image archives
        • Scheduling internals
      • Scripts (pyobs.robotic.scripts)
        • Writing a script
        • Runtime context
        • TaskData
        • Script base class
        • Built-in scripts
        • Sky flat utilities
      • Serialization (pyobs.utils.serialization)
        • Why pydantic models?
        • BaseModel
        • PolymorphicBaseModel
        • PrivateAttrMixin
        • API reference
      • Architecture
      • Module layer vs. robotic layer
      • Tasks and scheduling
      • Scheduler re-triggering
      • Scripts
      • Archive implementations
      • Further reading
    • Image processors
      • Overview
      • Core Interface
      • The Image Model
      • Asynchrony and Execution
      • Configuration and Instantiation
      • Conventions and Best Practices
        • Coordinate Conventions
        • WCS Assumptions
        • Header Keys as Contracts
      • Performance
      • Writing Your Own Processor
      • Example Pipelines
        • Calibration → Astrometry → Detection → Filtering → Offsets
        • Drawing and Filename Formatting
      • FAQs
      • Annotation (pyobs.images.processors.annotation)
        • Circle
        • Crosshair
        • Text
      • Astrometry (pyobs.images.processors.astrometry)
        • Astrometry
        • AstrometryDotNet
      • Calibration (pyobs.images.processors.calibration)
        • Calibration
      • Source Detection (pyobs.images.processors.detection)
        • DaophotSourceDetection
        • SepSourceDetection
        • SimpleDisk
        • SourceDetection
      • Exposure Time estimators (pyobs.images.processors.exptime)
        • ExpTimeEstimator
        • StarExpTimeEstimator
      • Image (pyobs.images.processors.image)
        • AddFitsHeaders
        • Download
        • Flip
        • Grayscale
        • HttpServer
        • Normalize
        • Save
        • SaveImage
        • Smooth
        • SoftBin
      • Misc (pyobs.images.processors.misc)
        • AddMask
        • CatalogCircularMask
        • CircularMask
        • CreateFilename
        • ImageSourceFilter
        • RemoveBackground
      • Modules (pyobs.images.processors.modules)
        • GetFitsHeaders
      • Offsets (pyobs.images.processors.offsets)
        • AstrometryOffsets
        • BrightestStarGuiding
        • BrightestStarOffsets
        • DummyOffsets
        • DummySkyOffsets
        • FitsHeaderOffsets
        • Offsets
        • PixelOffset
        • ProjectedOffsets
        • SpilledLightGuiding
      • Photometry (pyobs.images.processors.photometry)
        • PhotUtilsPhotometry
        • Photometry
        • SepPhotometry
      • WCS (pyobs.images.processors.wcs)
        • SolarHelioprojective
    • Utilities (pyobs.utils)
      • Image archives (pyobs.utils.archive)
        • Archive
        • LocalArchive
        • PyobsArchive
      • Configuration utilities (pyobs.utils.config)
        • pre_process_yaml()
      • Coordinate utilities (pyobs.utils.coordinates)
      • Enumerations (pyobs.utils.enums)
        • ExposureStatus
        • ImageFormat
        • ImageType
        • ModuleState
        • MotionStatus
        • WeatherSensors
      • Exceptions (pyobs.utils.exceptions)
        • AbortedError
        • ExceptionHandler
        • GeneralError
        • GrabImageError
        • ImageError
        • InitError
        • InvocationError
        • LoggedException
        • ModuleError
        • MotionError
        • MoveError
        • ParkError
        • PyObsError
        • RemoteError
        • RemoteTimeoutError
        • SevereError
        • _Meta
      • FITS utilities (pyobs.utils.fits)
        • Image sections: fitssec
        • Filename formatting: FilenameFormatter
        • API reference
      • Focus series (pyobs.utils.focusseries)
        • FocusSeries
        • PhotometryFocusSeries
        • ProjectionFocusSeries
      • HTTP utilities (pyobs.utils.http)
        • http_request_with_retries()
      • Pointing offsets (pyobs.utils.offsets)
        • ApplyOffsets
        • ApplyRaDecOffsets
        • ApplyAltAzOffsets
      • Future
        • Future
      • Image pipeline (pyobs.utils.pipeline)
      • Publishers (pyobs.utils.publisher)
        • Publisher
        • CsvPublisher
        • LogPublisher
        • MultiPublisher
      • Simulations (pyobs.utils.simulation)
        • SimCamera
        • SimTelescope
        • SimWorld
      • Sky flats (pyobs.utils.skyflats)
        • FlatFielder
        • Scheduler
        • Sky flat pointings (pyobs.utils.skyflats.pointing)
        • Sky flat priorities (pyobs.utils.skyflats.priorities)
      • Time (pyobs.utils.time)
        • Simulated time
        • API reference
  • Core modules (pyobs.modules)
    • Cameras (pyobs.modules.camera)
      • BaseCamera
        • BaseCamera
      • BaseSpectrograph
        • BaseSpectrograph
      • BaseVideo
        • BaseVideo
      • DummyCamera
        • DummyCamera
      • DummySpectrograph
        • DummySpectrograph
      • PipelineCamera
        • PipelineCamera
    • Flatfielding (pyobs.modules.flatfield)
      • FlatField
        • FlatField
      • FlatFieldPointing
        • FlatFieldPointing
      • FlatFieldScheduler
        • FlatFieldScheduler
    • Focus (pyobs.modules.focus)
      • AutoFocusSeries
        • AutoFocusSeries
      • FocusModel
        • FocusModel
    • Image operations (pyobs.modules.image)
      • ImageWatcher
        • ImageWatcher
      • ImageWriter
        • ImageWriter
      • Pipeline
        • Pipeline
      • Seeing
        • Seeing
    • Auto-guiding (pyobs.modules.pointing)
      • Acquisition
        • Acquisition
      • BaseGuiding
        • BaseGuiding
    • Robotic mode (pyobs.modules.robotic)
      • Mastermind
        • Mastermind
      • PointingSeries
        • PointingSeries
      • Scheduler
        • Scheduler
      • ScriptRunner
        • ScriptRunner
    • Roofs (pyobs.modules.roof)
      • BaseDome
        • BaseDome
      • BaseRoof
        • BaseRoof
      • DummyRoof
        • DummyRoof
    • Telescopes (pyobs.modules.telescope)
      • BaseTelescope
        • BaseTelescope
      • DummyTelescope
        • DummyTelescope
    • Test modules (pyobs.modules.test)
      • StandAlone
        • StandAlone
    • Utility modules (pyobs.modules.utils)
      • AutonomousWarning
      • FluentLogger
      • Kiosk
      • Matrix
      • Telegram
      • Trigger
    • Weather (pyobs.modules.weather)
      • Weather
        • Weather
  • Additional modules
    • SBIG cameras (pyobs_sbig)
    • FLI cameras (pyobs_fli)
    • ASI ZWO cameras (pyobs_asi)
    • Aravis network cameras (pyobs_aravis)
    • ASCOM ALPACA wrapper (pyobs_alpaca)
    • GUI (pyobs_gui)
  • pyobs-weather
  • pyobs-archive
  • Changelog
    • v1.12.0 (2023-12-28)
    • v1.11.0 (2023-12-25)
    • v1.10.0 (2023-12-24)
    • v1.9.0 (2023-12-23)
    • v1.3.0 (2023-02-04)
    • v1.2.0 (2022-10-06)
    • v1.1.0 (2022-09-20)
    • v1.0.0 (2022-09-13)
    • v0.22.0 (2022-08-25)
    • v0.21.0 (2022-08-25)
    • v0.20.0 (2022-06-22)
    • v0.19.0 (2022-05-17)
    • v0.18.0 (2022-03-13)
    • v0.17.0 (2022-02-14)
    • v0.16.0 (2022-01-14)
    • v0.15.0 (2021-12-29)
    • v0.14.2
    • v0.14.1
    • v0.14 (2021-11-03)
    • v0.13 (2021-04-30)
    • v0.12 (2021-01-01)
    • v0.11 (2020-10-18)
    • v0.10 (2020-05-05)
    • v0.9 (2020-03-06)
    • v0.8 (2019-11-17)
  • Team
  • License
  • 3rd party packages
pyobs
  • Search

© Copyright 2021, Tim-Oliver Husser.

Built with Sphinx using a theme provided by Read the Docs.