Skip to content

Commit 5511f5a

Browse files
committed
add some plugin details
1 parent 43a6dde commit 5511f5a

2 files changed

Lines changed: 35 additions & 33 deletions

File tree

docs/api/plugins.md

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ TOM Toolkit Plugins
22
-------------------
33

44
We aim to keep the TOM as lightweight and flexible as possible, and we
5-
recognise that every team has their own science goals and often need
5+
recognize that every team has their own science goals and often need
66
different functions. These often come with added dependencies.
77

88
Rather than require users to support all dependencies from all possible
99
functions, we support a range of optional plugin modules for the Toolkit.
1010
These range from adding the ability to interface with additional
11-
observatories, to providing additional plotting or data analytics functionality.
11+
observatories and catalogs, to providing additional plotting or data analytics functionality.
1212

1313
### [tom_hermes](https://github.com/TOMToolkit/tom_hermes)
1414

@@ -23,13 +23,13 @@ enables users to query this service and harvest alert information.
2323

2424
### [tom_antares](https://github.com/TOMToolkit/tom_antares)
2525

26-
The [tom-antares](https://github.com/TOMToolkit/tom_antares) plugin adds support
27-
for querying the [ANTARES](https://antares.noirlab.edu/) broker for targets of interest.
26+
This plugin adds support for querying the [ANTARES](https://antares.noirlab.edu/) broker for targets of interest.
2827

2928
### [tom_app_template](https://github.com/TOMToolkit/tom_app_template)
3029

31-
This repository is designed to provide an example template for TOM users
32-
wishing to develop their own TOM app.
30+
This repository is designed to provide a starting template for TOM users
31+
wishing to develop their own TOM app. This app contains all of the basic workflows,
32+
directory structure, testing infrastructure, and instructions you will need to get started.
3333

3434
### [tom_jpl](https://github.com/TOMToolkit/tom_jpl)
3535

@@ -49,8 +49,8 @@ Coverage maps.
4949

5050
### [tom_registration](https://github.com/TOMToolkit/tom_registration)
5151

52-
The [tom_registration](https://github.com/TOMToolkit/tom_registration) plugin introduces support for two TOM registration
53-
flows--an open registration, and a registration that requires administrator approval.
52+
This plugin introduces support for two TOM registration
53+
workflows--an open registration, and a registration that requires administrator approval.
5454

5555
### [tom_tns](https://github.com/TOMToolkit/tom_tns)
5656

@@ -65,20 +65,22 @@ alerts streams.
6565

6666
### [tom_demoapp](https://github.com/TOMToolkit/tom_demoapp)
6767

68-
This TOM application is designed to demonstrate how users can develop
69-
their own TOM applications and integrate them with their TOM systems.
68+
This TOM application is not designed to be installed by users, but instead act
69+
as a development and demonstration app for users wishing to integrate their
70+
own TOM applications with the base TOM toolkit. The code itself serves as example,
71+
while the [wiki](https://github.com/TOMToolkit/tom_demoapp/wiki) gives a menu of existing integration points.
7072

71-
### [tom_nonlocalisedevents](https://github.com/TOMToolkit/tom_nonlocalizedevents)
73+
### [tom_nonlocalizedevents](https://github.com/TOMToolkit/tom_nonlocalizedevents)
7274

73-
Various events in astrophysics are hard to localise, for example gravitational wave
74-
or neutrino detections. This app allows the TOM to recognise that a
75+
Various events in astrophysics are hard to localize, for example gravitational wave
76+
or neutrino detections. This app allows the TOM to recognize that a
7577
given event may be associated with a number of candidates, and provides
7678
custom views designed to support this workflow.
7779

7880
### [tom_swift](https://github.com/TOMToolkit/tom_swift)
7981

80-
The Neil Gehrels Swift Observatory is a space telescope offering UV/Visible and
81-
X-ray instrumentation and rapid response capabilities. This plugin
82+
The [Neil Gehrels Swift Observatory](https://swift.gsfc.nasa.gov/) is a space telescope offering
83+
UV/Visible and X-ray instrumentation and rapid response capabilities. This plugin
8284
enables TOM users to submit requests for Target of Opportunity observations
8385
with this spacecraft.
8486

@@ -100,22 +102,11 @@ This module provides the ability to submit observations to the
100102
state, with little error handling and minimal instrument options, but can successfully submit well-formed observation
101103
requests.
102104

103-
### [dockertom](https://github.com/TOMToolkit/dockertom)
104-
105-
This repository demonstrates how to package a TOM system in a docker container,
106-
which is often required for deployment.
107-
108105
### [tom-toolkit_component_lib](https://github.com/TOMToolkit/tom-toolkit-component-lib)
109106

110107
Demonstration of how Javascript front-end components can be integrated with
111108
a TOM.
112109

113-
### [tom_scimma](https://github.com/TOMToolkit/tom_scimma)
114-
115-
This app enables a TOM to subscribe to the Hopskotch alert stream developed
116-
by the Scalable Cyberinfrastructure to support Multi‑Messenger Astrophysics
117-
([SCiMMA](https://scimma.org/)) project.
118-
119110
### [tom_dash](https://github.com/TOMToolkit/tom_dash)
120111

121112
This module demonstrates how [Plotly-Dash](https://dash.plotly.com/) components can be added to a
@@ -128,12 +119,17 @@ TOM module to enable observations to be submitted to the
128119

129120
### [tom_nonsidereal_airmass](https://github.com/TOMToolkit/tom_nonsidereal_airmass)
130121

131-
The [tom_nonsidereal_airmass](https://github.com/TOMToolkit/tom_nonsidereal_airmass) plugin provides a templatetag
122+
This plugin provides a templatetag
132123
that supports plotting for non-sidereal objects. The plugin is fully supported by the TOM Toolkit team; however,
133124
non-sidereal visibility calculations require the PyEphem library, which is minimally supported while its successor
134125
is in development. The library used for the TOM Toolkit sidereal visibility, astroplan, does not yet support
135126
non-sidereal visibility calculations.
136127

128+
### [tom_publications](https://github.com/TOMToolkit/tom_publications)
129+
130+
This application prototyped tools to enable users to output latex-formatted
131+
data from their TOM system.
132+
137133
### [herokutom](https://github.com/TOMToolkit/herokutom)
138134

139135
This repository demonstrates how a TOM system can be deployed to a public
@@ -147,11 +143,17 @@ base Toolkit.
147143

148144
### [tom_alerts_dash](https://github.com/TOMToolkit/tom_alerts_dash)
149145

150-
The [tom_alerts_dash](https://github.com/TOMToolkit/tom_alerts_dash) plugin adds responsive ReactJS views to the
151-
`tom_alerts` module for supported brokers. This module has been superceded
146+
This plugin adds responsive ReactJS views to the
147+
`tom_alerts` module for supported brokers. The `tom_alerts` module has been superseded
152148
by tom_dataservices in v3.0.0.
153149

154-
### [tom_publications](https://github.com/TOMToolkit/tom_publications)
150+
### [dockertom](https://github.com/TOMToolkit/dockertom)
155151

156-
This application prototyped tools to enable users to output latex-formatted
157-
data from their TOM system.
152+
This repository demonstrates how to package a TOM system in a docker container,
153+
which is often required for deployment.
154+
155+
### [tom_scimma](https://github.com/TOMToolkit/tom_scimma)
156+
157+
This app enables a TOM to subscribe to the Hopskotch alert stream developed
158+
by the Scalable Cyberinfrastructure to support Multi‑Messenger Astrophysics
159+
([SCiMMA](https://scimma.org/)) project.

tom_dataservices/dataservices.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ def to_reduced_datums(self, target, data_results=None, **kwargs):
271271
of query_reduced_data() to create_reduced_datums_from_query()
272272
:param target: Target object to associate with the ReducedDatum
273273
:param data_results: Query results from the DataService storing observation data. This should be a dictionary
274-
with each key being a data_type (i.e. Photometry, Spectroscopy, etc.)
274+
with each key being a data_type (i.e. Photometry, Spectroscopy, etc.)
275275
"""
276276
if not data_results:
277277
raise MissingDataException('No Reduced Data dictionary found.')

0 commit comments

Comments
 (0)