Skip to content

Latest commit

 

History

History
118 lines (81 loc) · 4.32 KB

README.md

File metadata and controls

118 lines (81 loc) · 4.32 KB

TAP ADQL sandbox

About

A sandbox application for executing ADQL queries via TAP interface of various data sources, such as astronomical databases. Essentially, it's just a GUI for PyVO.

TAP ADQL sandbox application window

More details in this article.

Demonstration

application-demonstration-macos.mp4

Installing

From PyPI

$ pip install tap-adql-sandbox

From sources

$ cd /path/to/repository/
$ pip install ./

or:

$ cd /path/to/repository/
$ python -m build
$ pip install ./dist/tap_adql_sandbox-VERSION-py3-none-any.whl

Running

$ tap-adql-sandbox --help

Platforms

Tested on:

  • Mac OS:
    • 11.6.4, Intel
    • 12.2.1, Apple silicon
  • Windows:
    • 10
    • 11
  • GNU/Linux:
    • Ubuntu 20.04

Known problems

Application tries to connect to remote hosts on startup and sometimes crashes

Sometimes when you are just launching the application, so you didn't even have a chance to execute any queries, you might notice that it tries to reach various remote hosts on the internet, such as obspm.fr, ietf.org or probably others.

This is because of the Astropy package, which is an indirect dependency through PyVO, which is a direct dependency of this project. Specifically, it's the hosts listed in this file. Looks harmless enough, apparently just updating some astronomical data.

Denying access to these hosts might lead to the application crash, because Astropy doesn't handle such situation properly:

AttributeError: module 'IPython.utils.io' has no attribute 'stdout'

If you get the application crashing even when access to those is allowed, try to update the Astropy (and probably also PyVO) package:

$ pip install astropy -U

I had this problem with Astropy v4.2, and it was gone after updating to Astropy v5.1. Or perhaps the problem isn't really gone, but the new package version just came with updated data, so for now there is no need for updating.

Queries might fail with UnicodeDecodeError

If query results from a TAP service contain non-ASCII symbols, then PyVO will raise an exception. The application won't crash, but you won't get query results either.

3rd-party

Dependencies

  • Python 3.6 or later
    • or at least it should work with 3.6, but the oldest tested version was actually 3.7, and that was quite some time ago, so you better stick with a more recent version
  • Dear PyGui - application window and UI controls
  • PyVO - handling TAP ADQL requests
  • Astroquery - looking up IDs in Simbad
  • pandas - processing results and saving to pickle
  • tabulate - printing results to stdout (with --debug)
  • transitive (dependencies of dependencies):
    • NumPy comes through Astroquery(?) and has certain incompatibilities with various versions of Astroquery and pandas, but they all should work fine together if you (re)install the latest versions of all of those

Resources