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

3
## 1.0.1 (2019-05-30)
Peter Shawhan's avatar
Peter Shawhan committed
4

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

7
## 1.0.0 (2019-05-30)
Min-A Cho's avatar
Min-A Cho committed
8

Peter Shawhan's avatar
Peter Shawhan committed
9 10
-   Updated SPIIR reference to Chichi's thesis.

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

13 14
-   Added far threshold for pipelines to be included.

15 16 17
-   Change "skymap" to "sky map".

-   Have SPIIR display as uppercase in Circular text.
18

19
## 0.0.28 (2019-04-12)
Min-A Cho's avatar
Min-A Cho committed
20

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

23
## 0.0.27 (2019-04-10)
Min-A Cho's avatar
Min-A Cho committed
24

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

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

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

33 34
-   Added citations for medium latency GRB-GW search pipelines.

35
## 0.0.26 (2019-04-09)
Min-A Cho's avatar
Min-A Cho committed
36

Min-A Cho's avatar
Min-A Cho committed
37 38
-   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
39

40
## 0.0.25 (2019-04-08)
Min-A Cho's avatar
Min-A Cho committed
41

42 43
-   Updated reference for PyCBC Live.

44
-   Updated wording for the retraction circular.
Min-A Cho's avatar
Min-A Cho committed
45

Min-A Cho's avatar
Min-A Cho committed
46 47
-   Updated wording for the RAVEN circulars.

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

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

52
## 0.0.24 (2019-03-20)
Min-A Cho's avatar
Min-A Cho committed
53

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

56 57 58 59 60
-   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.

61
## 0.0.23 (2019-03-08)
Min-A Cho's avatar
Min-A Cho committed
62

63 64
-   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
65

Min-A Cho's avatar
Min-A Cho committed
66 67
-   Updated source_classification.json to em_bright.json.

68 69 70
## 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
71

72 73 74
-   Created medium latency GRB circulars if X-pipeline or PyGRB find a
    coincident GW.

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

Min-A Cho's avatar
Min-A Cho committed
77
## 0.0.21 (2019-02-27)
Min-A Cho's avatar
Min-A Cho committed
78

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

82
-   Updated the code to use the multi-resolution sky map if available.
83

84
## 0.0.20 (2019-02-27)
Min-A Cho's avatar
Min-A Cho committed
85

Min-A Cho's avatar
Min-A Cho committed
86
-   Changed LIB to oLIB.
Min-A Cho's avatar
Min-A Cho committed
87

88
## 0.0.19 (2019-02-27)
Min-A Cho's avatar
Min-A Cho committed
89

Min-A Cho's avatar
Min-A Cho committed
90
-   Added citations for other GW analysis pipelines that find the event other
Min-A Cho's avatar
Min-A Cho committed
91
    than the preferred event pipeline.
Min-A Cho's avatar
Min-A Cho committed
92

93
-   Fixed how the correct sky map name is deduced.
94

95
## 0.0.18 (2019-02-25)
Min-A Cho's avatar
Min-A Cho committed
96

97 98
-   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
99

100
## 0.0.17 (2019-02-25)
Min-A Cho's avatar
Min-A Cho committed
101

102
-   Fixed an unfortunate typo.
Min-A Cho's avatar
Min-A Cho committed
103

104
## 0.0.16 (2019-02-25)
Min-A Cho's avatar
Min-A Cho committed
105

106
-   Improved the EM_COINC and initial circulars.
Min-A Cho's avatar
Min-A Cho committed
107

108
## 0.0.15 (2019-02-22)
Min-A Cho's avatar
Min-A Cho committed
109

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

Min-A Cho's avatar
Min-A Cho committed
113
## 0.0.14 (2019-02-13)
Min-A Cho's avatar
Min-A Cho committed
114

115
-   Added template for retraction circulars.
Min-A Cho's avatar
Min-A Cho committed
116 117

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

119 120 121
-   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.
122

Min-A Cho's avatar
Min-A Cho committed
123 124 125 126
## 0.0.12 (2019-02-12)

-   Circulars include p_astro information when available.

127
## 0.0.11 (2018-08-02)
Leo Pound Singer's avatar
Leo Pound Singer committed
128

129 130
-   Circulars are generated with uncertainty ellipse text when they are a good
    approximation.
Leo Pound Singer's avatar
Leo Pound Singer committed
131

132
## 0.0.10 (2018-06-28)
Leo Pound Singer's avatar
Leo Pound Singer committed
133

Leo Pound Singer's avatar
Leo Pound Singer committed
134 135
-   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
136

137
## 0.0.9 (2018-06-28)
Leo Pound Singer's avatar
Leo Pound Singer committed
138

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

141
## 0.0.8 (2018-06-27)
Min-A Cho's avatar
Min-A Cho committed
142

Leo Pound Singer's avatar
Leo Pound Singer committed
143 144
-   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
145

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

Leo Pound Singer's avatar
Leo Pound Singer committed
148
-   Drop support for Python 2.
Leo Pound Singer's avatar
Leo Pound Singer committed
149

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

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

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

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

158
## 0.0.6 (2018-05-08)
Leo Pound Singer's avatar
Leo Pound Singer committed
159

Leo Pound Singer's avatar
Leo Pound Singer committed
160
-   Make it easier to call functions from Python scripts, like this:
Leo Pound Singer's avatar
Leo Pound Singer committed
161 162 163

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

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

Leo Pound Singer's avatar
Leo Pound Singer committed
167
## 0.0.5 (2018-05-03)
Leo Pound Singer's avatar
Leo Pound Singer committed
168

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