CHANGES.md 5.78 KB
Newer Older
Brandon Piotrzkowski's avatar
Brandon Piotrzkowski committed
1 2 3 4
#Changelog

## 1.1.3 (unreleased)

5 6
-   Fix bug where a preliminary circular lists the sky map as being an
    updated localization.
Leo Pound Singer's avatar
Leo Pound Singer committed
7

Brandon Piotrzkowski's avatar
Brandon Piotrzkowski committed
8 9 10 11 12 13
-   Change wording to explicity state that coincidence is significant, not
    that the GW increases in significance. Include joint sky map in both
    EM COINC circulars.

-   Fix sentence in description of sky map so it doesn't appear cut-off.

14 15 16
-   Change EM_Bright section to simply state the probability of HasNS
    and HasRemnant instate of relative amount of evidence.

Brandon Piotrzkowski's avatar
Brandon Piotrzkowski committed
17
## 1.1.2 (2019-09-25)
Brandon Piotrzkowski's avatar
Brandon Piotrzkowski committed
18

19 20 21
-   Remove check that sky map has `public` and `sky_loc` tags in order to
    fix bug preventing finding files with version numbers in their extension
    (e.g. LALinference.fits.gz,0)
Brandon Piotrzkowski's avatar
Brandon Piotrzkowski committed
22

Brandon Piotrzkowski's avatar
Brandon Piotrzkowski committed
23
## 1.1.1 (2019-09-11)
Brandon Piotrzkowski's avatar
Brandon Piotrzkowski committed
24

25 26 27
-   Change wording for PE p_astro to include the assumption that the
    candidate is astrophysical. Change update circular wording to include
    GCN circular by hand.
Brandon Piotrzkowski's avatar
Brandon Piotrzkowski committed
28

29 30
-   Change retraction wording to 'no longer considered a candidate of interest'.

Brandon Piotrzkowski's avatar
Brandon Piotrzkowski committed
31
## 1.1.dev1 (2019-08-21)
Leo Pound Singer's avatar
Leo Pound Singer committed
32

Brandon Piotrzkowski's avatar
Brandon Piotrzkowski committed
33 34 35
-   Add update type circular template. This template can be used for any
    combination of updated sky localization, source classification (p_astro),
    and EM-bright classification.
36

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

39
## 1.0.2 (2019-06-06)
Leo Pound Singer's avatar
Leo Pound Singer committed
40

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

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

45
## 1.0.1 (2019-05-30)
Peter Shawhan's avatar
Peter Shawhan committed
46

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

49
## 1.0.0 (2019-05-30)
Min-A Cho's avatar
Min-A Cho committed
50

Peter Shawhan's avatar
Peter Shawhan committed
51 52
-   Updated SPIIR reference to Chichi's thesis.

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

55 56
-   Added far threshold for pipelines to be included.

57 58 59
-   Change "skymap" to "sky map".

-   Have SPIIR display as uppercase in Circular text.
60

61
## 0.0.28 (2019-04-12)
Min-A Cho's avatar
Min-A Cho committed
62

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

65
## 0.0.27 (2019-04-10)
Min-A Cho's avatar
Min-A Cho committed
66

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

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

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

75 76
-   Added citations for medium latency GRB-GW search pipelines.

77
## 0.0.26 (2019-04-09)
Min-A Cho's avatar
Min-A Cho committed
78

Min-A Cho's avatar
Min-A Cho committed
79 80
-   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
81

82
## 0.0.25 (2019-04-08)
Min-A Cho's avatar
Min-A Cho committed
83

84 85
-   Updated reference for PyCBC Live.

86
-   Updated wording for the retraction circular.
Min-A Cho's avatar
Min-A Cho committed
87

Min-A Cho's avatar
Min-A Cho committed
88 89
-   Updated wording for the RAVEN circulars.

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

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

94
## 0.0.24 (2019-03-20)
Min-A Cho's avatar
Min-A Cho committed
95

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

98 99 100 101 102
-   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.

103
## 0.0.23 (2019-03-08)
Min-A Cho's avatar
Min-A Cho committed
104

105 106
-   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
107

Min-A Cho's avatar
Min-A Cho committed
108 109
-   Updated source_classification.json to em_bright.json.

110 111 112
## 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
113

114 115 116
-   Created medium latency GRB circulars if X-pipeline or PyGRB find a
    coincident GW.

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

Min-A Cho's avatar
Min-A Cho committed
119
## 0.0.21 (2019-02-27)
Min-A Cho's avatar
Min-A Cho committed
120

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

124
-   Updated the code to use the multi-resolution sky map if available.
125

126
## 0.0.20 (2019-02-27)
Min-A Cho's avatar
Min-A Cho committed
127

Min-A Cho's avatar
Min-A Cho committed
128
-   Changed LIB to oLIB.
Min-A Cho's avatar
Min-A Cho committed
129

130
## 0.0.19 (2019-02-27)
Min-A Cho's avatar
Min-A Cho committed
131

Min-A Cho's avatar
Min-A Cho committed
132
-   Added citations for other GW analysis pipelines that find the event other
Min-A Cho's avatar
Min-A Cho committed
133
    than the preferred event pipeline.
Min-A Cho's avatar
Min-A Cho committed
134

135
-   Fixed how the correct sky map name is deduced.
136

137
## 0.0.18 (2019-02-25)
Min-A Cho's avatar
Min-A Cho committed
138

139 140
-   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
141

142
## 0.0.17 (2019-02-25)
Min-A Cho's avatar
Min-A Cho committed
143

144
-   Fixed an unfortunate typo.
Min-A Cho's avatar
Min-A Cho committed
145

146
## 0.0.16 (2019-02-25)
Min-A Cho's avatar
Min-A Cho committed
147

148
-   Improved the EM_COINC and initial circulars.
Min-A Cho's avatar
Min-A Cho committed
149

150
## 0.0.15 (2019-02-22)
Min-A Cho's avatar
Min-A Cho committed
151

152 153
-   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
154

Min-A Cho's avatar
Min-A Cho committed
155
## 0.0.14 (2019-02-13)
Min-A Cho's avatar
Min-A Cho committed
156

157
-   Added template for retraction circulars.
Min-A Cho's avatar
Min-A Cho committed
158 159

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

161 162 163
-   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.
164

Min-A Cho's avatar
Min-A Cho committed
165 166 167 168
## 0.0.12 (2019-02-12)

-   Circulars include p_astro information when available.

169
## 0.0.11 (2018-08-02)
Leo Pound Singer's avatar
Leo Pound Singer committed
170

171 172
-   Circulars are generated with uncertainty ellipse text when they are a good
    approximation.
Leo Pound Singer's avatar
Leo Pound Singer committed
173

174
## 0.0.10 (2018-06-28)
Leo Pound Singer's avatar
Leo Pound Singer committed
175

Leo Pound Singer's avatar
Leo Pound Singer committed
176 177
-   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
178

179
## 0.0.9 (2018-06-28)
Leo Pound Singer's avatar
Leo Pound Singer committed
180

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

183
## 0.0.8 (2018-06-27)
Min-A Cho's avatar
Min-A Cho committed
184

Leo Pound Singer's avatar
Leo Pound Singer committed
185 186
-   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
187

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

Leo Pound Singer's avatar
Leo Pound Singer committed
190
-   Drop support for Python 2.
Leo Pound Singer's avatar
Leo Pound Singer committed
191

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

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

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

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

200
## 0.0.6 (2018-05-08)
Leo Pound Singer's avatar
Leo Pound Singer committed
201

Leo Pound Singer's avatar
Leo Pound Singer committed
202
-   Make it easier to call functions from Python scripts, like this:
Leo Pound Singer's avatar
Leo Pound Singer committed
203 204 205

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

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

Leo Pound Singer's avatar
Leo Pound Singer committed
209
## 0.0.5 (2018-05-03)
Leo Pound Singer's avatar
Leo Pound Singer committed
210

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