CHANGES.rst 9.45 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.0.18 (unreleased)
===================

Leo Pound Singer's avatar
Leo Pound Singer committed
8
9
- 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
10

11
12
- Un-pin Numpy version now that Numpy 1.15.4 is out.

13
14
15
- 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.
16

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

20
21
22
23
- 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.

24
0.0.17 (2018-10-24)
Leo Pound Singer's avatar
Leo Pound Singer committed
25
26
===================

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

30
31
32
33
34
- 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.

35
36
37
- 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
38
39
40
41
42
43
- 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>.

44
45
46
47
48
- 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.

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

53
0.0.16 (2018-09-11)
Leo Pound Singer's avatar
Leo Pound Singer committed
54
55
===================

Leo Pound Singer's avatar
Leo Pound Singer committed
56
- Drop support for Python 3.5.
Leo Pound Singer's avatar
Leo Pound Singer committed
57

58
59
60
61
62
- 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.
63

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

67
68
69
70
- ``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.
71

72
73
74
- ``bayestar-realize-coincs`` now prints a running count of the number of
  injections that have been found and saved.

75
0.0.15 (2018-09-04)
Leo Pound Singer's avatar
Leo Pound Singer committed
76
77
===================

78
- Parallelize ``bayestar-realize-coincs``.
Leo Pound Singer's avatar
Leo Pound Singer committed
79

80
81
82
- Add ``--min-distance`` and ``--max-distance`` options to
  ``bayestar-realize-coincs``.

83
84
- Add unit tests and binary wheels for Python 3.7.

85
0.0.14 (2018-08-28)
Leo Pound Singer's avatar
Leo Pound Singer committed
86
87
===================

88
89
- 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
90

91
0.0.13 (2018-08-27)
Leo Pound Singer's avatar
Leo Pound Singer committed
92
93
===================

Leo Pound Singer's avatar
Leo Pound Singer committed
94
95
96
- 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
97

98
99
100
- Fix a corner case in the initialization of the ``distance.marginal_ppf``
  solver that could cause NaN return values.

101
102
103
104
105
- 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>`_.

106
107
108
109
- Silence deprecation warning in ``ligo-skymap-plot-stats`` due to Matplotlib
  renaming the ``hist`` method's keyword argument from ``normed`` to
  ``density``.

110
111
112
- The ``bayestar-realize-coincs`` tool now copies over spins from the input
  ``sim_inspiral`` table to the output ``sngl_inspiral`` table.

113
114
115
116
117
- 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).

118
119
120
121
- Add ``--seed`` option to ``bayestar-localize-coincs``,
  ``bayestar-localize-lvalert``, ``bayestar-mcmc``, and
  ``bayestar-realize-coincs``.

122
123
124
125
126
127
128
129
- 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.

130
131
- Rewrite ``ligo-skymap-plot-stats`` to reduce code duplication.

132
133
134
- Add ``--measurement-error gaussian-noise`` option to
  ``bayestar-realize-coincs`` to simulate a matched filter in Gaussian noise.

135
136
- Remove deprecated module ``ligo.skymap.postprocess.detector_frame``.

137
0.0.12 (2018-07-18)
Leo Pound Singer's avatar
Leo Pound Singer committed
138
139
===================

140
141
142
- ``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
143

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

146
147
- Add phase convention for gstlal-spiir, which needs to be confirmed upstream.

148
149
150
- Fix datatype of simulated SNR time series produced by
  ``bayestar-realize-coincs``.

151
0.0.11 (2018-06-11)
Leo Pound Singer's avatar
Leo Pound Singer committed
152
153
===================

154
155
- 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
156

157
0.0.10 (2018-06-07)
Leo Pound Singer's avatar
Leo Pound Singer committed
158
159
===================

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

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

165
0.0.9 (2018-06-06)
Leo Pound Singer's avatar
Leo Pound Singer committed
166
167
==================

168
169
170
- 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
171

Leo Pound Singer's avatar
Leo Pound Singer committed
172
173
174
175
176
177
178
179
- 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
180

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

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

187
188
- Update common files from Astropy package template.

189
0.0.8 (2018-05-10)
Leo Pound Singer's avatar
Leo Pound Singer committed
190
191
==================

192
193
- 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
194

195
0.0.7 (2018-04-27)
Leo Pound Singer's avatar
Leo Pound Singer committed
196
197
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
198
199
200
201
202
203
204
- 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
205

206
207
208
- Overhaul documentation so that all essential functionality is presented on
  the front page.

209
210
- Move ``ligo.skymap.command`` to top-level ``ligo.skymap.tool`` module.

211
212
213
214
- 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
215
0.0.6 (2018-04-13)
Leo Pound Singer's avatar
Leo Pound Singer committed
216
217
==================

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

Leo Pound Singer's avatar
Leo Pound Singer committed
220
221
222
- 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
223

Leo Pound Singer's avatar
Leo Pound Singer committed
224
0.0.5 (2018-04-12)
Leo Pound Singer's avatar
Leo Pound Singer committed
225
226
==================

227
228
229
- 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
230

231
232
233
- Start process of switching to tqdm for progress bars so that long-running
  operations show time estimates.

234
235
236
237
- 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
238
0.0.4 (2018-03-22)
Leo Pound Singer's avatar
Leo Pound Singer committed
239
240
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
241
242
243
244
245
246
247
248
- 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
249

250
251
252
- 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
253
0.0.3 (2018-03-21)
Leo Pound Singer's avatar
Leo Pound Singer committed
254
255
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
256
- Bring back simulation tools from LALSuite.
Leo Pound Singer's avatar
Leo Pound Singer committed
257

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

Leo Pound Singer's avatar
Leo Pound Singer committed
260
0.0.2 (2018-03-12)
Leo Pound Singer's avatar
Leo Pound Singer committed
261
262
==================

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

Leo Pound Singer's avatar
Leo Pound Singer committed
265
0.0.1 (2018-03-12)
Leo Pound Singer's avatar
Leo Pound Singer committed
266
267
268
==================

- Initial release.