CHANGES.rst 10.7 KB
Newer Older
Leo Pound Singer's avatar
Leo Pound Singer committed
1
2
3
4
#########
Changelog
#########

Leo Pound Singer's avatar
Leo Pound Singer committed
5
6
7
0.1.1 (unreleased)
==================

8
9
- Pin lalsuite at <=6.52 and lscsoft-glue at <=1.60.0 due to breaking changes
  in API and behavior for LIGO-LW XML reading.
Leo Pound Singer's avatar
Leo Pound Singer committed
10

11
12
0.1.0 (2019-02-01)
==================
Leo Pound Singer's avatar
Leo Pound Singer committed
13

14
- Migrate from glue.segments to ligo.segments.
Leo Pound Singer's avatar
Leo Pound Singer committed
15

16
17
18
19
- Add ``--min-inclination`` and ``max-inclination`` options to
  ``bayestar-localize-coincs`` and ``bayestar-localize-lvalert`` to control the
  limits of the isotropic prior over the inclination angle.

20
21
22
- Un-pin ligo-segments and require version >= 1.2.0 due to packaging
  bugfixes.

23
0.0.19 (2018-12-13)
Leo Pound Singer's avatar
Leo Pound Singer committed
24
25
===================

26
27
- Fix a bug that prevented the output of ligo-skymap-flatten from being
  gzip-compressed if the output filename ended in .gz.
Leo Pound Singer's avatar
Leo Pound Singer committed
28

Leo Pound Singer's avatar
Leo Pound Singer committed
29
30
31
32
- Require astropy >= 3.1 because some code that we previously had to
  monkeypatch went upstream. See
  https://github.com/astropy/astropy-healpix/pull/106.

33
34
35
36
- In the KDE clustering and ``ligo-skymap-from-samples``, disable OpenMP
  parallelism if Python mulitprocessing parallelism is enabled. This will
  prevent the program from spawning an excessive number of threads.

37
38
39
- ``ligo-skymap-plot`` no longer requires a DATE-OBS entry in the FITS header
  when plotting in astronomical coordinates.

40
0.0.18 (2018-11-19)
Leo Pound Singer's avatar
Leo Pound Singer committed
41
42
===================

Leo Pound Singer's avatar
Leo Pound Singer committed
43
44
- Fix a typo that caused ligo.skymap to always compile the bundled copy of
  chealpix instead of searching for a system version using pkgconfig.
Leo Pound Singer's avatar
Leo Pound Singer committed
45

46
47
- Un-pin Numpy version now that Numpy 1.15.4 is out.

48
49
50
- The ``bayestar-localize-lvalert`` and ``ligo-skymap-from-samples`` tools can
  now natively output multi-resolution HEALPix files, although they still
  natively output flat, fixed-resolution HEALPix files.
51

Leo Pound Singer's avatar
Leo Pound Singer committed
52
53
54
- Add the ``ligo-skymap-flatten`` tool to convert multi-resolution HEALPix
  files to flat, fixed-resolution, implicitly indexed HEALPix files.

55
56
57
58
- Bring back ``bayestar_samples_ppplot`` from LALInference as
  ``ligo-skymap-plot-pp-samples``, a tool for making P-P plots to compare a sky
  map with posterior samples.

59
60
61
- Add ``--cosmology`` feature to ``ligo-skymap-stats`` to calculate comoving
  volumes.

62
0.0.17 (2018-10-24)
Leo Pound Singer's avatar
Leo Pound Singer committed
63
64
===================

65
66
- In ``bayestar-mcmc``, correct a mistake in setting fixed parameters that
  undergo sampling transformations.
Leo Pound Singer's avatar
Leo Pound Singer committed
67

68
69
70
71
72
- By default, ``bayestar-realize-coincs`` will rewrite ``simulation_id`` values
  so that their integer values match the corresponding events'
  ``coinc_event_id`` values. The option ``--preserve-ids`` switches back to the
  old behavior of preserving the original ``simulation_id`` values.

73
74
75
- Track rename of ``ligo.gracedb.rest.GraceDb.service_url`` to
  ``ligo.gracedb.rest.GraceDb._service_url`` in ligo-gracedb >= 2.0.1.

Leo Pound Singer's avatar
Leo Pound Singer committed
76
77
78
79
80
81
- Update common files and submodules from the Astropy package template.

- Work around a change (possibly a regression?) in Numpy 1.15.3 that broke
  Astropy by requiring numpy <= 1.15.2. See
  <https://github.com/astropy/astropy/issues/7943>.

82
83
84
85
86
- Work around a bug introduced in ligo-segments 1.1.0 by requiring an earlier
  version of that package: its dependency on ligo-common, which does not
  correctly implement the namespace package ``ligo``, broke the continuous
  integration build.

87
88
89
90
- Depend on astropy-healpix >= 0.3 to pick up a bug fix related to HEALPix
  bilinear interpolation that affected ``ligo-skymap-plot``. See
  <https://github.com/astropy/astropy-healpix/pull/106>.

91
0.0.16 (2018-09-11)
Leo Pound Singer's avatar
Leo Pound Singer committed
92
93
===================

Leo Pound Singer's avatar
Leo Pound Singer committed
94
- Drop support for Python 3.5.
Leo Pound Singer's avatar
Leo Pound Singer committed
95

96
97
98
99
100
- The ``--condor-submit`` option of the ``bayestar-localize-coincs`` and
  ``bayestar-mcmc`` tools now passes the submit file directives to
  ``condor_submit`` via stdin rather than on the command line, so that the
  number of jobs is not limited by the operating system's maximum number of
  command line arguments.
101

102
103
104
- Print warnings from ``ligo.skymap.io.events.ligolw.open()`` only once per
  file to avoid excessive terminal output when reading large files.

105
106
107
108
- ``bayestar-realize-coincs`` now copies the process table from the injection
  file and fills in the SimInspiral table and associates coincidences with
  found injections. As a result, it is no longer necessary to run
  ``lalapps_inspinjfind`` on the output to find injections.
109

110
111
112
- ``bayestar-realize-coincs`` now prints a running count of the number of
  injections that have been found and saved.

113
0.0.15 (2018-09-04)
Leo Pound Singer's avatar
Leo Pound Singer committed
114
115
===================

116
- Parallelize ``bayestar-realize-coincs``.
Leo Pound Singer's avatar
Leo Pound Singer committed
117

118
119
120
- Add ``--min-distance`` and ``--max-distance`` options to
  ``bayestar-realize-coincs``.

121
122
- Add unit tests and binary wheels for Python 3.7.

123
0.0.14 (2018-08-28)
Leo Pound Singer's avatar
Leo Pound Singer committed
124
125
===================

126
127
- Increase lifetime of continuous integration artifacts. The unit tests take
  longer now because they are more complete.
Leo Pound Singer's avatar
Leo Pound Singer committed
128

129
0.0.13 (2018-08-27)
Leo Pound Singer's avatar
Leo Pound Singer committed
130
131
===================

Leo Pound Singer's avatar
Leo Pound Singer committed
132
133
134
- Add ``bayestar-mcmc`` tool for pure Markov Chain Monte Carlo parameter
  estimation, without sky map postprocessing but with options for holding
  parameters at fixed values.
Leo Pound Singer's avatar
Leo Pound Singer committed
135

136
137
138
- Fix a corner case in the initialization of the ``distance.marginal_ppf``
  solver that could cause NaN return values.

139
140
141
142
143
- Silence ``numpy.genfromtxt`` Unicode deprecation warning in
  ``ligo-skymap-plot-stats`` and update the minimum version of Numpy to 1.14.
  See the related `Numpy changelog entry
  <https://docs.scipy.org/doc/numpy/release.html#encoding-argument-for-text-io-functions>`_.

144
145
146
147
- Silence deprecation warning in ``ligo-skymap-plot-stats`` due to Matplotlib
  renaming the ``hist`` method's keyword argument from ``normed`` to
  ``density``.

148
149
150
- The ``bayestar-realize-coincs`` tool now copies over spins from the input
  ``sim_inspiral`` table to the output ``sngl_inspiral`` table.

151
152
153
154
155
- Switch the FFT implementation from LAL (which calls `FFTW
  <http://www.fftw.org>`_) to `scipy.fftpack
  <https://docs.scipy.org/doc/scipy/reference/tutorial/fftpack.html>`_, which
  is faster for small transform sizes (e.g. <= 1024).

156
157
158
159
- Add ``--seed`` option to ``bayestar-localize-coincs``,
  ``bayestar-localize-lvalert``, ``bayestar-mcmc``, and
  ``bayestar-realize-coincs``.

160
161
162
163
164
165
166
167
- Some reasonable sub-sample trigger interpolation schemes can return peak
  times that are almost a full sample away from the maximum sample if the SNR
  time series has a pronounced skew in one direction in the vicinity of the
  maximum. Such an example occurs for the ``catmull-rom`` interpolation method
  for the new unit tests in ``ligo.skymap.bayestar.tests.test_interpolation``.
  Because of this, relax the tolerance of BAYESTAR's sanity check on
  single-detector trigger times and SNR series timestamps to a full sample.

168
169
- Rewrite ``ligo-skymap-plot-stats`` to reduce code duplication.

170
171
172
- Add ``--measurement-error gaussian-noise`` option to
  ``bayestar-realize-coincs`` to simulate a matched filter in Gaussian noise.

173
174
- Remove deprecated module ``ligo.skymap.postprocess.detector_frame``.

175
0.0.12 (2018-07-18)
Leo Pound Singer's avatar
Leo Pound Singer committed
176
177
===================

178
179
180
- ``bayestar_localize_lvalert`` will now write the correct GraceDb URL
  to FITS file headers in the case that it is run with a non-default GraceDb
  server.
Leo Pound Singer's avatar
Leo Pound Singer committed
181

Leo Pound Singer's avatar
Leo Pound Singer committed
182
183
- BAYESTAR's SNR series time stamp assertions now include a bit more detail.

184
185
- Add phase convention for gstlal-spiir, which needs to be confirmed upstream.

186
187
188
- Fix datatype of simulated SNR time series produced by
  ``bayestar-realize-coincs``.

189
0.0.11 (2018-06-11)
Leo Pound Singer's avatar
Leo Pound Singer committed
190
191
===================

192
193
- Prebuilt binary wheels for macOS are now relocatable. See
  `delocate#38 <https://github.com/matthew-brett/delocate/pull/38>`_.
Leo Pound Singer's avatar
Leo Pound Singer committed
194

195
0.0.10 (2018-06-07)
Leo Pound Singer's avatar
Leo Pound Singer committed
196
197
===================

Leo Pound Singer's avatar
Leo Pound Singer committed
198
- Make lalsuite and lscsoft-glue required dependencies.
Leo Pound Singer's avatar
Leo Pound Singer committed
199

Leo Pound Singer's avatar
Leo Pound Singer committed
200
201
202
- The Python code is now required to pass linting by
  `Flake8 <http://flake8.pycqa.org/en/latest/>`_.

203
0.0.9 (2018-06-06)
Leo Pound Singer's avatar
Leo Pound Singer committed
204
205
==================

206
207
208
- On reading, rename columns from Fermi GBM HEALPix files to match the
  LIGO/Virgo convention. In particular, rename any column named `PROBABILITY`
  to `PROB`.
Leo Pound Singer's avatar
Leo Pound Singer committed
209

Leo Pound Singer's avatar
Leo Pound Singer committed
210
211
212
213
214
215
216
217
- Reduce the memory footprint of ``ligo-skymap-plot-airmass`` by transposing
  two nested loops.

- Make some cosmetic improvements to ``ligo-skymap-plot-airmass``:

  * Add altitude and local time axes.
  * Center plot on local solar midnight.
  * Adjust blending and z-order of twilight shading.
Leo Pound Singer's avatar
Leo Pound Singer committed
218

Leo Pound Singer's avatar
Leo Pound Singer committed
219
220
- ``ligo-skymap-plot-airmass`` will now write an airmass table to stdout.

Leo Pound Singer's avatar
Leo Pound Singer committed
221
222
223
224
- Rewrite the MCMC mode of BAYESTAR using ``ligo.skymap.ez_emcee``, a new
  reusable, fire-and-forget, parallel-tempering, MCMC sampler that features
  automated convergence testing and progress monitoring.

225
226
- Update common files from Astropy package template.

227
0.0.8 (2018-05-10)
Leo Pound Singer's avatar
Leo Pound Singer committed
228
229
==================

230
231
- Add ``ligo-skymap-combine``, a tool to combine sky localizations from
  different observations into a joint skymap.
Leo Pound Singer's avatar
Leo Pound Singer committed
232

233
0.0.7 (2018-04-27)
Leo Pound Singer's avatar
Leo Pound Singer committed
234
235
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
236
237
238
239
240
241
242
- Move ``ligo.skymap.eigenframe.EigenFrame`` to
  ``ligo.skymap.coordinates.EigenFrame``.

- Add a new Astropy coordinate frame ``ligo.skymap.coordinates.DetectorFrame``
  to visualize triangulation rings with pairs of detectors.

- Deprecate all functions in ``ligo.skymap.postprocess.detector_frame``.
Leo Pound Singer's avatar
Leo Pound Singer committed
243

244
245
246
- Overhaul documentation so that all essential functionality is presented on
  the front page.

247
248
- Move ``ligo.skymap.command`` to top-level ``ligo.skymap.tool`` module.

249
250
251
252
- Require version 0.3.2 of the ``reproject`` package because of a regression
  that was caused by improper handling of nans in the ``astropy-healpix``
  package. See <https://github.com/astropy/astropy-healpix/pull/77>.

Leo Pound Singer's avatar
Leo Pound Singer committed
253
0.0.6 (2018-04-13)
Leo Pound Singer's avatar
Leo Pound Singer committed
254
255
==================

256
- Declare the top-level ``ligo`` module as a namespace package.
Leo Pound Singer's avatar
Leo Pound Singer committed
257

Leo Pound Singer's avatar
Leo Pound Singer committed
258
259
260
- Update common files from Astropy package template.

- Enable Python version check in ``setup.py`` and top-level namespace package.
Leo Pound Singer's avatar
Leo Pound Singer committed
261

Leo Pound Singer's avatar
Leo Pound Singer committed
262
0.0.5 (2018-04-12)
Leo Pound Singer's avatar
Leo Pound Singer committed
263
264
==================

265
266
267
- When running ``ligo-skymap-stats`` without injections, instead of writing
  ``nan`` values for irrelevant columns, don't write the columns in the first
  place.
Leo Pound Singer's avatar
Leo Pound Singer committed
268

269
270
271
- Start process of switching to tqdm for progress bars so that long-running
  operations show time estimates.

272
273
274
275
- In ``ligo-skymap-stats``, disable OpenMP parallelism if running with ``-j``
  to avoid creating a huge number of threads on machines with very many
  cores.

Leo Pound Singer's avatar
Leo Pound Singer committed
276
0.0.4 (2018-03-22)
Leo Pound Singer's avatar
Leo Pound Singer committed
277
278
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
279
280
281
282
283
284
285
286
- Fix ``--condor-submit`` option for ``bayestar-localize-coincs``.

- Add ``--duty-cycle`` option to ``bayestar-realize-coincs``.

- Rename ``ligo-skymap-aggregate-found-injections`` to ``ligo-skymap-stats``
  and ``ligo-skymap-plot-found-injections`` to ``ligo-skymap-plot-stats``. The
  new ``ligo-skymap-stats`` program can generate summary statistics for
  skymaps, with or without injection-finding.
Leo Pound Singer's avatar
Leo Pound Singer committed
287

288
289
290
- This is the first version that has been tested and shown to reproduce the
  results in the "First Two Years" paper, which is the review benchmark.

Leo Pound Singer's avatar
Leo Pound Singer committed
291
0.0.3 (2018-03-21)
Leo Pound Singer's avatar
Leo Pound Singer committed
292
293
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
294
- Bring back simulation tools from LALSuite.
Leo Pound Singer's avatar
Leo Pound Singer committed
295

Leo Pound Singer's avatar
Leo Pound Singer committed
296
- Add ``ligo-skymap-plot-airmass``, a tool for probabilistic airmass charts.
Leo Pound Singer's avatar
Leo Pound Singer committed
297

Leo Pound Singer's avatar
Leo Pound Singer committed
298
0.0.2 (2018-03-12)
Leo Pound Singer's avatar
Leo Pound Singer committed
299
300
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
301
- Adjust CI configuration for uploading to PyPI.
Leo Pound Singer's avatar
Leo Pound Singer committed
302

Leo Pound Singer's avatar
Leo Pound Singer committed
303
0.0.1 (2018-03-12)
Leo Pound Singer's avatar
Leo Pound Singer committed
304
305
306
==================

- Initial release.