CHANGES.md 4.68 KB
Newer Older
Leo Pound Singer's avatar
Leo Pound Singer committed
1 2
# Changelog

Leo Pound Singer's avatar
Leo Pound Singer committed
3 4
## 1.0.3 (unreleased)

5 6
-   Add update type circular template.

7
-   Uses search field to identify sub-threshold GRBs.
Leo Pound Singer's avatar
Leo Pound Singer committed
8

9
## 1.0.2 (2019-06-06)
Leo Pound Singer's avatar
Leo Pound Singer committed
10

Tri V Nguyen's avatar
Tri V Nguyen committed
11 12
-   Changed to use multiorder.fits sky map first when calculating uncertainty ellipses.

13
-   Removed far threshold criteria for pipelines to be included in circular.
Leo Pound Singer's avatar
Leo Pound Singer committed
14

15
## 1.0.1 (2019-05-30)
Peter Shawhan's avatar
Peter Shawhan committed
16

17
-   New release with no changes to fix incorrect version number on PyPI.
Peter Shawhan's avatar
Peter Shawhan committed
18

19
## 1.0.0 (2019-05-30)
Min-A Cho's avatar
Min-A Cho committed
20

Peter Shawhan's avatar
Peter Shawhan committed
21 22
-   Updated SPIIR reference to Chichi's thesis.

23
-   Changed the FAR statement to say it is estimated (rather than "determined").
Min-A Cho's avatar
Min-A Cho committed
24

25 26
-   Added far threshold for pipelines to be included.

27 28 29
-   Change "skymap" to "sky map".

-   Have SPIIR display as uppercase in Circular text.
30

31
## 0.0.28 (2019-04-12)
Min-A Cho's avatar
Min-A Cho committed
32

33
-   Updated macros to state FAR explicitly; no more capping at 1/century.
Min-A Cho's avatar
Min-A Cho committed
34

35
## 0.0.27 (2019-04-10)
Min-A Cho's avatar
Min-A Cho committed
36

Min-A Cho's avatar
Min-A Cho committed
37 38
-   Updated wording in initial circular to match what was sent for the first
    superevent alert sent in O3
39

Min-A Cho's avatar
Min-A Cho committed
40
-   Updated wording for the RAVEN circulars; particularly when there is a
41
    combined GW-GRB sky map.
Min-A Cho's avatar
Min-A Cho committed
42

43
-   Updated to call gstlal as GstLAL when referring to pipelines.
Min-A Cho's avatar
Min-A Cho committed
44

45 46
-   Added citations for medium latency GRB-GW search pipelines.

47
## 0.0.26 (2019-04-09)
Min-A Cho's avatar
Min-A Cho committed
48

Min-A Cho's avatar
Min-A Cho committed
49 50
-   Updated to call EM-Bright json file from the preferred event files list;
    probabilities are between 0 and 1
Min-A Cho's avatar
Min-A Cho committed
51

52
## 0.0.25 (2019-04-08)
Min-A Cho's avatar
Min-A Cho committed
53

54 55
-   Updated reference for PyCBC Live.

56
-   Updated wording for the retraction circular.
Min-A Cho's avatar
Min-A Cho committed
57

Min-A Cho's avatar
Min-A Cho committed
58 59
-   Updated wording for the RAVEN circulars.

Min-A Cho's avatar
Min-A Cho committed
60 61
-   Updated wording for the medium latency GRB circulars.

62
-   Added sky map citations for BAYESTAR and LALInference.
Min-A Cho's avatar
Min-A Cho committed
63

64
## 0.0.24 (2019-03-20)
Min-A Cho's avatar
Min-A Cho committed
65

Min-A Cho's avatar
Min-A Cho committed
66
-   Moved pipeline citations from the circular body to the end and enumerated.
Min-A Cho's avatar
Min-A Cho committed
67

68 69 70 71 72
-   Updated the p_astro.json test files to include the mass gap.

-   Synced (but hard-coded) thresholds for sending alerts for CBC and Burst
    superevents.

73
## 0.0.23 (2019-03-08)
Min-A Cho's avatar
Min-A Cho committed
74

75 76
-   Added ability to pull down excluded distance json files created by
    PyGRB and X-pipeline to put into exclusion medium latency GRB circulars.
Min-A Cho's avatar
Min-A Cho committed
77

Min-A Cho's avatar
Min-A Cho committed
78 79
-   Updated source_classification.json to em_bright.json.

80 81 82
## 0.0.22 (2019-03-07)

-   Updated RAVEN specific circulars to handle sub-threshold GRB triggers.
Min-A Cho's avatar
Min-A Cho committed
83

84 85 86
-   Created medium latency GRB circulars if X-pipeline or PyGRB find a
    coincident GW.

87
-   Added luminosity distance to the initial circular body when available.
Min-A Cho's avatar
Min-A Cho committed
88

Min-A Cho's avatar
Min-A Cho committed
89
## 0.0.21 (2019-02-27)
Min-A Cho's avatar
Min-A Cho committed
90

91
-   Un-fixed the "correct" sky map name... i.e., will parse VOEvents for
Min-A Cho's avatar
Min-A Cho committed
92
    skymap_fits param.
Min-A Cho's avatar
Min-A Cho committed
93

94
-   Updated the code to use the multi-resolution sky map if available.
95

96
## 0.0.20 (2019-02-27)
Min-A Cho's avatar
Min-A Cho committed
97

Min-A Cho's avatar
Min-A Cho committed
98
-   Changed LIB to oLIB.
Min-A Cho's avatar
Min-A Cho committed
99

100
## 0.0.19 (2019-02-27)
Min-A Cho's avatar
Min-A Cho committed
101

Min-A Cho's avatar
Min-A Cho committed
102
-   Added citations for other GW analysis pipelines that find the event other
Min-A Cho's avatar
Min-A Cho committed
103
    than the preferred event pipeline.
Min-A Cho's avatar
Min-A Cho committed
104

105
-   Fixed how the correct sky map name is deduced.
106

107
## 0.0.18 (2019-02-25)
Min-A Cho's avatar
Min-A Cho committed
108

109 110
-   Re-worded part of the EM_COINC circulars that gives the time difference
    between the neutrino/GRB trigger and GW candidate event.
Min-A Cho's avatar
Min-A Cho committed
111

112
## 0.0.17 (2019-02-25)
Min-A Cho's avatar
Min-A Cho committed
113

114
-   Fixed an unfortunate typo.
Min-A Cho's avatar
Min-A Cho committed
115

116
## 0.0.16 (2019-02-25)
Min-A Cho's avatar
Min-A Cho committed
117

118
-   Improved the EM_COINC and initial circulars.
Min-A Cho's avatar
Min-A Cho committed
119

120
## 0.0.15 (2019-02-22)
Min-A Cho's avatar
Min-A Cho committed
121

122 123
-   Added template for EM_COINC circulars, i.e., circulars produced when
    RAVEN finds a coincidence between GW and external triggers.
Min-A Cho's avatar
Min-A Cho committed
124

Min-A Cho's avatar
Min-A Cho committed
125
## 0.0.14 (2019-02-13)
Min-A Cho's avatar
Min-A Cho committed
126

127
-   Added template for retraction circulars.
Min-A Cho's avatar
Min-A Cho committed
128 129

## 0.0.13.dev0 (2019-02-13)
130

131 132 133
-   Update the XPath expression for obtaining the sky map URL to conform to the
    new schema for O3. This should fix the missing sky map paragraphs in
    circulars that are uploaded to GraceDb.
134

Min-A Cho's avatar
Min-A Cho committed
135 136 137 138
## 0.0.12 (2019-02-12)

-   Circulars include p_astro information when available.

139
## 0.0.11 (2018-08-02)
Leo Pound Singer's avatar
Leo Pound Singer committed
140

141 142
-   Circulars are generated with uncertainty ellipse text when they are a good
    approximation.
Leo Pound Singer's avatar
Leo Pound Singer committed
143

144
## 0.0.10 (2018-06-28)
Leo Pound Singer's avatar
Leo Pound Singer committed
145

Leo Pound Singer's avatar
Leo Pound Singer committed
146 147
-   Changed how VOEvent text is pulled down; now using `client.files()` method
    versus relying on `client.voevents()` json response.
Leo Pound Singer's avatar
Leo Pound Singer committed
148

149
## 0.0.9 (2018-06-28)
Leo Pound Singer's avatar
Leo Pound Singer committed
150

Min-A Cho's avatar
Min-A Cho committed
151
-   Circulars are generated strictly for superevents.
Leo Pound Singer's avatar
Leo Pound Singer committed
152

153
## 0.0.8 (2018-06-27)
Min-A Cho's avatar
Min-A Cho committed
154

Leo Pound Singer's avatar
Leo Pound Singer committed
155 156
-   GraceDb links in circulars now reflect the URL of the GraceDb server from
    which the event originated.
Min-A Cho's avatar
Min-A Cho committed
157

Min-A Cho's avatar
Min-A Cho committed
158
## 0.0.7 (2018-05-24)
Leo Pound Singer's avatar
Leo Pound Singer committed
159

Leo Pound Singer's avatar
Leo Pound Singer committed
160
-   Drop support for Python 2.
Leo Pound Singer's avatar
Leo Pound Singer committed
161

Leo Pound Singer's avatar
Leo Pound Singer committed
162
-   Do not print the circular if calling `compose()` from a Python script.
163

164
-   Remove duplicate sky maps and keep only the lowest latency ones.
Min-A Cho's avatar
Min-A Cho committed
165

166
-   Do not include sky maps produced outside the LVC.
Min-A Cho's avatar
Min-A Cho committed
167

Leo Pound Singer's avatar
Leo Pound Singer committed
168
-   Optional GraceDb client keyword argument when calling compose().
169

170
## 0.0.6 (2018-05-08)
Leo Pound Singer's avatar
Leo Pound Singer committed
171

Leo Pound Singer's avatar
Leo Pound Singer committed
172
-   Make it easier to call functions from Python scripts, like this:
Leo Pound Singer's avatar
Leo Pound Singer committed
173 174 175

        >>> from ligo import followup_advocate
        >>> text = followup_advocate.compose('G299232')
Leo Pound Singer's avatar
Leo Pound Singer committed
176

Leo Pound Singer's avatar
Leo Pound Singer committed
177
-   Add `--service` command line option to set the GraceDB service URL.
178

Leo Pound Singer's avatar
Leo Pound Singer committed
179
## 0.0.5 (2018-05-03)
Leo Pound Singer's avatar
Leo Pound Singer committed
180

Leo Pound Singer's avatar
Leo Pound Singer committed
181
-   First version released on PyPI.