Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Data Services (Broker, Catalog, etc.) #832

Open
11 tasks
jchate6 opened this issue Jan 31, 2024 · 2 comments
Open
11 tasks

Refactor Data Services (Broker, Catalog, etc.) #832

jchate6 opened this issue Jan 31, 2024 · 2 comments
Labels
Epic Overview topic for high level discussion

Comments

@jchate6
Copy link
Contributor

jchate6 commented Jan 31, 2024

The TOM Toolkit offers many different ways to import data from external sources.
For this issue, we want to re-evaluate how we handle any kind of data import that could be considered an external catalog search.
Currently these are broken into several different categories, each of which serve different but overlapping purposes and use drastically different vocabulary.

Current Data Services

  • Alert Brokers
    • Use "Broker" apps (some built in, some external)
    • Creates Queries that are saved to be run at a later date
    • intended to be run on updating Catalogs
    • ingests NEW targets into the TOM.
    • Can bring along data if available
    • Cannot update existing targets
  • Catalogs
    • use "Harvesters" to ingest data
    • intended to get single target matching a name query.
    • Does not handle target data
    • Targets not updated (updated orbital elements, improved distances, etc.)
  • Forced Photometry
    • intended to pull data from from a catalog's forced photometry service.
    • results in a csv of data to be imported as a Data Product for a single target.
  • AlertStreams
    • uses tom-alertstreams
    • uses "Topic Handlers" to ingest data
    • intended to listen to a kafka stream and import data into TOM
    • Topic Handlers are flexible, and can import targets, individual Reduced Datums, or do anything else with an incoming alert.

The next effort is to add Data Searches that import data directly from a catalog for a given target or targets.
At a fundamental level, these new data searches, "brokers", and "catalogs" all query an external catalog and ingest the resulting data into the TOM.

This issue is to explore the possibility of consolidating these different data services into a unified schema with related vocabulary and less redundant code.

Includes:

@github-project-automation github-project-automation bot moved this to Triage in TOM Toolkit Jan 31, 2024
@jchate6 jchate6 added the Epic Overview topic for high level discussion label Jan 31, 2024
@jchate6 jchate6 moved this from Triage to Staged in TOM Toolkit Feb 7, 2024
@jchate6 jchate6 moved this from Staged to In progress in TOM Toolkit Feb 8, 2024
@jchate6
Copy link
Contributor Author

jchate6 commented Feb 21, 2024

Write up for Refactor

@jchate6
Copy link
Contributor Author

jchate6 commented Apr 19, 2024

See Issue #894

@jchate6 jchate6 added this to the TOMToolkit version 3.0 milestone Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic Overview topic for high level discussion
Projects
Status: In progress
Development

No branches or pull requests

1 participant