CHANGES.rst 11.5 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.4 (unreleased)
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
8 9
- The ``bayestar-localize-lvalert`` and ``ligo-skymap-from-samples`` tools will
  now generate multiresolution FITS files by default.
Leo Pound Singer's avatar
Leo Pound Singer committed
10

11
0.1.3 (2019-03-04)
Leo Pound Singer's avatar
Leo Pound Singer committed
12 13
==================

14 15 16 17
- Fix a bug in ``ligo-skymap-plot-airmass`` that caused the airmass chart to be
  blank if the lower and upper credible levels were always in opposite
  hemispheres. The root cause was that ``plt.fill_between`` does not clip
  infinities to the plot's data range.
Leo Pound Singer's avatar
Leo Pound Singer committed
18

19
0.1.2 (2019-02-28)
Leo Pound Singer's avatar
Leo Pound Singer committed
20 21
==================

22 23
- Require lalsuite >6.53 and lscsoft-glue >=2.0.0 due to breaking changes in
  API and behavior for LIGO-LW XML reading.
Leo Pound Singer's avatar
Leo Pound Singer committed
24

25
0.1.1 (2019-02-20)
Leo Pound Singer's avatar
Leo Pound Singer committed
26 27
==================

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

31 32 33 34
- Add the ``ligo-skymap-unflatten`` tool to convert flat, fixed resolution,
  implicitly indexed HEALPix files to multi-resolution HEALPix files. This
  tools is the inverse of ``ligo-skymap-flatten``.

35 36
0.1.0 (2019-02-01)
==================
Leo Pound Singer's avatar
Leo Pound Singer committed
37

38
- Migrate from glue.segments to ligo.segments.
Leo Pound Singer's avatar
Leo Pound Singer committed
39

40 41 42 43
- 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.

44 45 46
- Un-pin ligo-segments and require version >= 1.2.0 due to packaging
  bugfixes.

47
0.0.19 (2018-12-13)
Leo Pound Singer's avatar
Leo Pound Singer committed
48 49
===================

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

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

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

61 62 63
- ``ligo-skymap-plot`` no longer requires a DATE-OBS entry in the FITS header
  when plotting in astronomical coordinates.

64
0.0.18 (2018-11-19)
Leo Pound Singer's avatar
Leo Pound Singer committed
65 66
===================

Leo Pound Singer's avatar
Leo Pound Singer committed
67 68
- 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
69

70 71
- Un-pin Numpy version now that Numpy 1.15.4 is out.

72 73 74
- 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.
75

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

79 80 81 82
- 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.

83 84 85
- Add ``--cosmology`` feature to ``ligo-skymap-stats`` to calculate comoving
  volumes.

86
0.0.17 (2018-10-24)
Leo Pound Singer's avatar
Leo Pound Singer committed
87 88
===================

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

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

97 98 99
- 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
100 101 102 103 104 105
- 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>.

106 107 108 109 110
- 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.

111 112 113 114
- 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>.

115
0.0.16 (2018-09-11)
Leo Pound Singer's avatar
Leo Pound Singer committed
116 117
===================

Leo Pound Singer's avatar
Leo Pound Singer committed
118
- Drop support for Python 3.5.
Leo Pound Singer's avatar
Leo Pound Singer committed
119

120 121 122 123 124
- 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.
125

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

129 130 131 132
- ``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.
133

134 135 136
- ``bayestar-realize-coincs`` now prints a running count of the number of
  injections that have been found and saved.

137
0.0.15 (2018-09-04)
Leo Pound Singer's avatar
Leo Pound Singer committed
138 139
===================

140
- Parallelize ``bayestar-realize-coincs``.
Leo Pound Singer's avatar
Leo Pound Singer committed
141

142 143 144
- Add ``--min-distance`` and ``--max-distance`` options to
  ``bayestar-realize-coincs``.

145 146
- Add unit tests and binary wheels for Python 3.7.

147
0.0.14 (2018-08-28)
Leo Pound Singer's avatar
Leo Pound Singer committed
148 149
===================

150 151
- 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
152

153
0.0.13 (2018-08-27)
Leo Pound Singer's avatar
Leo Pound Singer committed
154 155
===================

Leo Pound Singer's avatar
Leo Pound Singer committed
156 157 158
- 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
159

160 161 162
- Fix a corner case in the initialization of the ``distance.marginal_ppf``
  solver that could cause NaN return values.

163 164 165 166 167
- 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>`_.

168 169 170 171
- Silence deprecation warning in ``ligo-skymap-plot-stats`` due to Matplotlib
  renaming the ``hist`` method's keyword argument from ``normed`` to
  ``density``.

172 173 174
- The ``bayestar-realize-coincs`` tool now copies over spins from the input
  ``sim_inspiral`` table to the output ``sngl_inspiral`` table.

175 176 177 178 179
- 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).

180 181 182 183
- Add ``--seed`` option to ``bayestar-localize-coincs``,
  ``bayestar-localize-lvalert``, ``bayestar-mcmc``, and
  ``bayestar-realize-coincs``.

184 185 186 187 188 189 190 191
- 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.

192 193
- Rewrite ``ligo-skymap-plot-stats`` to reduce code duplication.

194 195 196
- Add ``--measurement-error gaussian-noise`` option to
  ``bayestar-realize-coincs`` to simulate a matched filter in Gaussian noise.

197 198
- Remove deprecated module ``ligo.skymap.postprocess.detector_frame``.

199
0.0.12 (2018-07-18)
Leo Pound Singer's avatar
Leo Pound Singer committed
200 201
===================

202 203 204
- ``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
205

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

208 209
- Add phase convention for gstlal-spiir, which needs to be confirmed upstream.

210 211 212
- Fix datatype of simulated SNR time series produced by
  ``bayestar-realize-coincs``.

213
0.0.11 (2018-06-11)
Leo Pound Singer's avatar
Leo Pound Singer committed
214 215
===================

216 217
- 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
218

219
0.0.10 (2018-06-07)
Leo Pound Singer's avatar
Leo Pound Singer committed
220 221
===================

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

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

227
0.0.9 (2018-06-06)
Leo Pound Singer's avatar
Leo Pound Singer committed
228 229
==================

230 231 232
- 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
233

Leo Pound Singer's avatar
Leo Pound Singer committed
234 235 236 237 238 239 240 241
- 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
242

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

Leo Pound Singer's avatar
Leo Pound Singer committed
245 246 247 248
- 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.

249 250
- Update common files from Astropy package template.

251
0.0.8 (2018-05-10)
Leo Pound Singer's avatar
Leo Pound Singer committed
252 253
==================

254 255
- 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
256

257
0.0.7 (2018-04-27)
Leo Pound Singer's avatar
Leo Pound Singer committed
258 259
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
260 261 262 263 264 265 266
- 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
267

268 269 270
- Overhaul documentation so that all essential functionality is presented on
  the front page.

271 272
- Move ``ligo.skymap.command`` to top-level ``ligo.skymap.tool`` module.

273 274 275 276
- 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
277
0.0.6 (2018-04-13)
Leo Pound Singer's avatar
Leo Pound Singer committed
278 279
==================

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

Leo Pound Singer's avatar
Leo Pound Singer committed
282 283 284
- 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
285

Leo Pound Singer's avatar
Leo Pound Singer committed
286
0.0.5 (2018-04-12)
Leo Pound Singer's avatar
Leo Pound Singer committed
287 288
==================

289 290 291
- 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
292

293 294 295
- Start process of switching to tqdm for progress bars so that long-running
  operations show time estimates.

296 297 298 299
- 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
300
0.0.4 (2018-03-22)
Leo Pound Singer's avatar
Leo Pound Singer committed
301 302
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
303 304 305 306 307 308 309 310
- 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
311

312 313 314
- 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
315
0.0.3 (2018-03-21)
Leo Pound Singer's avatar
Leo Pound Singer committed
316 317
==================

Leo Pound Singer's avatar
Leo Pound Singer committed
318
- Bring back simulation tools from LALSuite.
Leo Pound Singer's avatar
Leo Pound Singer committed
319

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

Leo Pound Singer's avatar
Leo Pound Singer committed
322
0.0.2 (2018-03-12)
Leo Pound Singer's avatar
Leo Pound Singer committed
323 324
==================

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

Leo Pound Singer's avatar
Leo Pound Singer committed
327
0.0.1 (2018-03-12)
Leo Pound Singer's avatar
Leo Pound Singer committed
328 329 330
==================

- Initial release.