Superevents

Adding superevents to GraceDB, including the necessary models, utility functions, and API resources. This has also resulted in changes to the overall configuration and some parts of the events model.

Many models in the events app, like Labels, Tags, EventLogs, etc. were needed in a similar form for superevents. We were able to completely reuse the existing Label and Tag models for superevents. In other cases, we had to abstract the main functionality of the class into an abstract base class and then implement separate models for events and superevents, due to foreign key requirements. This should leave the current functionality of the events models unchanged.

Some portions of the events API have been modified because of one of the following reasons:

• It didn't make sense and was unnecessarily difficult to duplicate for superevents
• It was inefficient or bad

These changes are documented here: https://bugs.ligo.org/redmine/issues/6133

gracedb/events/mixins.py

+# mixins for class-based views
+
+from django.conf import settings
+
+from .permission_utils import is_external
+
+class DisplayFarMixin(object):
+
+    def get_display_far(self, obj=None):
+        # obj should be an Event object
+        if obj is None:
+            obj = self.object
+        user = self.request.user
+
+        # Determine FAR to display
+        display_far = obj.far
+        far_is_upper_limit = False
+        if (display_far and is_external(user) and 
+            display_far < settings.VOEVENT_FAR_FLOOR):
+
+            display_far = settings.VOEVENT_FAR_FLOOR
+            far_is_upper_limit = True
+
+        # Determine "human-readable" FAR to display
+        display_far_hr = display_far
+        if display_far:
+            # FAR in units of yr^-1
+            far_yr = display_far * (86400*365.25)
+            if (far_yr < 1):
+                display_far_hr = "1 per {0:0.5g} years".format(1.0/far_yr)
+            else:
+                display_far_hr = "{0:0.5g} per year".format(far_yr)
+
+        return display_far, display_far_hr, far_is_upper_limit