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

5
6
0.1.0 (2019-02-01)
==================
Leo P. Singer's avatar
Leo P. Singer committed
7

8
- Migrate from glue.segments to ligo.segments.
Leo P. Singer's avatar
Leo P. Singer committed
9

10
11
12
13
- 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.

14
15
16
- Un-pin ligo-segments and require version >= 1.2.0 due to packaging
  bugfixes.

17
0.0.19 (2018-12-13)
Leo P. Singer's avatar
Leo P. Singer committed
18
19
===================

20
21
- Fix a bug that prevented the output of ligo-skymap-flatten from being
  gzip-compressed if the output filename ended in .gz.
Leo P. Singer's avatar
Leo P. Singer committed
22

Leo P. Singer's avatar
Leo P. Singer committed
23
24
25
26
- Require astropy >= 3.1 because some code that we previously had to
  monkeypatch went upstream. See
  https://github.com/astropy/astropy-healpix/pull/106.

27
28
29
30
- 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.

31
32
33
- ``ligo-skymap-plot`` no longer requires a DATE-OBS entry in the FITS header
  when plotting in astronomical coordinates.

34
0.0.18 (2018-11-19)
Leo P. Singer's avatar
Leo P. Singer committed
35
36
===================

Leo P. Singer's avatar
Leo P. Singer committed
37
38
- 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 P. Singer's avatar
Leo P. Singer committed
39

40
41
- Un-pin Numpy version now that Numpy 1.15.4 is out.

42
43
44
- 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.
45

Leo P. Singer's avatar
Leo P. Singer committed
46
47
48
- Add the ``ligo-skymap-flatten`` tool to convert multi-resolution HEALPix
  files to flat, fixed-resolution, implicitly indexed HEALPix files.

49
50
51
52
- 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.

53
54
55
- Add ``--cosmology`` feature to ``ligo-skymap-stats`` to calculate comoving
  volumes.

56
0.0.17 (2018-10-24)
Leo P. Singer's avatar
Leo P. Singer committed
57
58
===================

59
60
- In ``bayestar-mcmc``, correct a mistake in setting fixed parameters that
  undergo sampling transformations.
Leo P. Singer's avatar
Leo P. Singer committed
61

62
63
64
65
66
- 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.

Leo P. Singer's avatar
Leo P. Singer committed
67
68
69
- Track rename of ``ligo.gracedb.rest.GraceDb.service_url`` to
  ``ligo.gracedb.rest.GraceDb._service_url`` in ligo-gracedb >= 2.0.1.

Leo P. Singer's avatar
Leo P. Singer committed
70
71
72
73
74
75
- 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>.

76
77
78
79
80
- 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.

81
82
83
84
- 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>.

85
0.0.16 (2018-09-11)
Leo P. Singer's avatar
Leo P. Singer committed
86
87
===================

Leo P. Singer's avatar
Leo P. Singer committed
88
- Drop support for Python 3.5.
Leo P. Singer's avatar
Leo P. Singer committed
89

90
91
92
93
94
- 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.
95

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

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

104
105
106
- ``bayestar-realize-coincs`` now prints a running count of the number of
  injections that have been found and saved.

107
0.0.15 (2018-09-04)
Leo P. Singer's avatar
Leo P. Singer committed
108
109
===================

110
- Parallelize ``bayestar-realize-coincs``.
Leo P. Singer's avatar
Leo P. Singer committed
111

112
113
114
- Add ``--min-distance`` and ``--max-distance`` options to
  ``bayestar-realize-coincs``.

115
116
- Add unit tests and binary wheels for Python 3.7.

117
0.0.14 (2018-08-28)
Leo P. Singer's avatar
Leo P. Singer committed
118
119
===================

120
121
- Increase lifetime of continuous integration artifacts. The unit tests take
  longer now because they are more complete.
Leo P. Singer's avatar
Leo P. Singer committed
122

123
0.0.13 (2018-08-27)
Leo P. Singer's avatar
Leo P. Singer committed
124
125
===================

Leo P. Singer's avatar
Leo P. Singer committed
126
127
128
- 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 P. Singer's avatar
Leo P. Singer committed
129

130
131
132
- Fix a corner case in the initialization of the ``distance.marginal_ppf``
  solver that could cause NaN return values.

Leo P. Singer's avatar
Leo P. Singer committed
133
134
135
136
137
- 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>`_.

138
139
140
141
- Silence deprecation warning in ``ligo-skymap-plot-stats`` due to Matplotlib
  renaming the ``hist`` method's keyword argument from ``normed`` to
  ``density``.

142
143
144
- The ``bayestar-realize-coincs`` tool now copies over spins from the input
  ``sim_inspiral`` table to the output ``sngl_inspiral`` table.

145
146
147
148
149
- 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).

150
151
152
153
- Add ``--seed`` option to ``bayestar-localize-coincs``,
  ``bayestar-localize-lvalert``, ``bayestar-mcmc``, and
  ``bayestar-realize-coincs``.

154
155
156
157
158
159
160
161
- 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.

162
163
- Rewrite ``ligo-skymap-plot-stats`` to reduce code duplication.

164
165
166
- Add ``--measurement-error gaussian-noise`` option to
  ``bayestar-realize-coincs`` to simulate a matched filter in Gaussian noise.

167
168
- Remove deprecated module ``ligo.skymap.postprocess.detector_frame``.

169
0.0.12 (2018-07-18)
Leo P. Singer's avatar
Leo P. Singer committed
170
171
===================

172
173
174
- ``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 P. Singer's avatar
Leo P. Singer committed
175

Leo P. Singer's avatar
Leo P. Singer committed
176
177
- BAYESTAR's SNR series time stamp assertions now include a bit more detail.

178
179
- Add phase convention for gstlal-spiir, which needs to be confirmed upstream.

180
181
182
- Fix datatype of simulated SNR time series produced by
  ``bayestar-realize-coincs``.

183
0.0.11 (2018-06-11)
Leo P. Singer's avatar
Leo P. Singer committed
184
185
===================

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

189
0.0.10 (2018-06-07)
Leo P. Singer's avatar
Leo P. Singer committed
190
191
===================

Leo P. Singer's avatar
Leo P. Singer committed
192
- Make lalsuite and lscsoft-glue required dependencies.
Leo P. Singer's avatar
Leo P. Singer committed
193

Leo P. Singer's avatar
Leo P. Singer committed
194
195
196
- The Python code is now required to pass linting by
  `Flake8 <http://flake8.pycqa.org/en/latest/>`_.

197
0.0.9 (2018-06-06)
Leo P. Singer's avatar
Leo P. Singer committed
198
199
==================

200
201
202
- 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 P. Singer's avatar
Leo P. Singer committed
203

Leo P. Singer's avatar
Leo P. Singer committed
204
205
206
207
208
209
210
211
- 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 P. Singer's avatar
Leo P. Singer committed
212

Leo P. Singer's avatar
Leo P. Singer committed
213
214
- ``ligo-skymap-plot-airmass`` will now write an airmass table to stdout.

Leo P. Singer's avatar
Leo P. Singer committed
215
216
217
218
- 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.

219
220
- Update common files from Astropy package template.

221
0.0.8 (2018-05-10)
Leo P. Singer's avatar
Leo P. Singer committed
222
223
==================

224
225
- Add ``ligo-skymap-combine``, a tool to combine sky localizations from
  different observations into a joint skymap.
Leo P. Singer's avatar
Leo P. Singer committed
226

227
0.0.7 (2018-04-27)
Leo P. Singer's avatar
Leo P. Singer committed
228
229
==================

Leo P. Singer's avatar
Leo P. Singer committed
230
231
232
233
234
235
236
- 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 P. Singer's avatar
Leo P. Singer committed
237

238
239
240
- Overhaul documentation so that all essential functionality is presented on
  the front page.

241
242
- Move ``ligo.skymap.command`` to top-level ``ligo.skymap.tool`` module.

243
244
245
246
- 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 P. Singer's avatar
Leo P. Singer committed
247
0.0.6 (2018-04-13)
Leo P. Singer's avatar
Leo P. Singer committed
248
249
==================

250
- Declare the top-level ``ligo`` module as a namespace package.
Leo P. Singer's avatar
Leo P. Singer committed
251

Leo P. Singer's avatar
Leo P. Singer committed
252
253
254
- Update common files from Astropy package template.

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

Leo P. Singer's avatar
Leo P. Singer committed
256
0.0.5 (2018-04-12)
Leo P. Singer's avatar
Leo P. Singer committed
257
258
==================

Leo P. Singer's avatar
Leo P. Singer committed
259
260
261
- 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 P. Singer's avatar
Leo P. Singer committed
262

263
264
265
- Start process of switching to tqdm for progress bars so that long-running
  operations show time estimates.

266
267
268
269
- 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 P. Singer's avatar
Leo P. Singer committed
270
0.0.4 (2018-03-22)
Leo P. Singer's avatar
Leo P. Singer committed
271
272
==================

Leo P. Singer's avatar
Leo P. Singer committed
273
274
275
276
277
278
279
280
- 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 P. Singer's avatar
Leo P. Singer committed
281

Leo P. Singer's avatar
Leo P. Singer committed
282
283
284
- 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 P. Singer's avatar
Leo P. Singer committed
285
0.0.3 (2018-03-21)
Leo P. Singer's avatar
Leo P. Singer committed
286
287
==================

Leo P. Singer's avatar
Leo P. Singer committed
288
- Bring back simulation tools from LALSuite.
Leo P. Singer's avatar
Leo P. Singer committed
289

Leo P. Singer's avatar
Leo P. Singer committed
290
- Add ``ligo-skymap-plot-airmass``, a tool for probabilistic airmass charts.
Leo P. Singer's avatar
Leo P. Singer committed
291

Leo P. Singer's avatar
Leo P. Singer committed
292
0.0.2 (2018-03-12)
Leo P. Singer's avatar
Leo P. Singer committed
293
294
==================

Leo P. Singer's avatar
Leo P. Singer committed
295
- Adjust CI configuration for uploading to PyPI.
Leo P. Singer's avatar
Leo P. Singer committed
296

Leo P. Singer's avatar
Leo P. Singer committed
297
0.0.1 (2018-03-12)
Leo P. Singer's avatar
Leo P. Singer committed
298
299
300
==================

- Initial release.