Welcome to the aop package’s documentation!

aop is a Python package that implements the aop standard v1.0 for amateur astronomical observation logs.

Note

This project is under active development.

Are you an amateur astronomer or astrophotographer who has some ambitions to document their observations in a clean, meaningful way? Maybe you are currently working on a small, home-made research project or maybe you are just struggling to remember the order of all the calibration frames you took last night. Either way, the aop standard is for you! It provides a clear and straightforward standard for the logging of amateur observations of the night sky. aop is the Python package that implements this standard. It only provides the means to do so, however, as it is meant to be implemented by a front-end application. Theoretically, you could use any app that is capable of implementing this package. We recommend the use of Amélie Hohe’s Gala to improve your observation logging quality. Focus on the hobby you enjoy, and aop and Gala will do the logging for you.

On this page, you can learn everything about how to use aop. Look in the menu for an installation guide, code examples, a tutorial walking you through every function, and an extensive API reference that has you covered in any technical questions that might arise. Also be sure to check out the search function and the index function if you’re searching for something specific!

aop has its documentation hosted on ReadTheDocs.

• Installation
  • Linux or MacOS
  • Windows
  • other operating systems
• Examples
• Tutorials
  • Getting started
  • Our first Session
• Index
• API Reference
  • aop
    • Submodules
      • aop.aop
        • Module Contents
          • Classes
          • Functions
            • current_jd()
            • generate_observation_id()
            • create_entry_id()
            • Session
              • Session.started
              • Session.obsID
              • Session.filepath
              • Session.state
              • Session.interrupted
              • Session.conditionDescription
              • Session.temp
              • Session.pressure
              • Session.humidity
              • Session.__repr__()
              • Session.start()
              • Session.__write_to_aop()
              • Session.__write_to_aol()
              • Session.interrupt()
              • Session.resume()
              • Session.abort()
              • Session.end()
              • Session.comment()
              • Session.issue()
              • Session.point_to_name()
              • Session.point_to_coords()
              • Session.take_frame()
              • Session.condition_report()
              • Session.report_variable_star_observation()
            • parse_session()
      • aop.tools
        • Module Contents
          • AolFileAlreadyExistsError
          • AolNotFoundError
          • AopFileAlreadyExistsError
          • InvalidTimeStringError
          • SessionIDDoesntExistOnFilepathError
          • SessionStateError
            • SessionStateError.__str__()
          • NotInterruptableError
          • NotResumableError
          • NotAbortableError
          • NotEndableError
          • AlreadyInterruptedError
          • NotInterruptedError
          • SessionNotStartedError
            • SessionNotStartedError.__repr__()