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

Leo P. Singer's avatar
Leo P. Singer committed
5
6
7
0.0.19 (unreleased)
===================

8
9
- 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
10

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

15
0.0.18 (2018-11-19)
Leo P. Singer's avatar
Leo P. Singer committed
16
17
===================

Leo P. Singer's avatar
Leo P. Singer committed
18
19
- 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
20

21
22
- Un-pin Numpy version now that Numpy 1.15.4 is out.

23
24
25
- 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.
26

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

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

34
35
36
- Add ``--cosmology`` feature to ``ligo-skymap-stats`` to calculate comoving
  volumes.

37
0.0.17 (2018-10-24)
Leo P. Singer's avatar
Leo P. Singer committed
38
39
===================

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

43
44
45
46
47
- 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
48
49
50
- 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
51
52
53
54
55
56
- 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>.

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

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

66
0.0.16 (2018-09-11)
Leo P. Singer's avatar
Leo P. Singer committed
67
68
===================

Leo P. Singer's avatar
Leo P. Singer committed
69
- Drop support for Python 3.5.
Leo P. Singer's avatar
Leo P. Singer committed
70

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

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

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

85
86
87
- ``bayestar-realize-coincs`` now prints a running count of the number of
  injections that have been found and saved.

88
0.0.15 (2018-09-04)
Leo P. Singer's avatar
Leo P. Singer committed
89
90
===================

91
- Parallelize ``bayestar-realize-coincs``.
Leo P. Singer's avatar
Leo P. Singer committed
92

93
94
95
- Add ``--min-distance`` and ``--max-distance`` options to
  ``bayestar-realize-coincs``.

96
97
- Add unit tests and binary wheels for Python 3.7.

98
0.0.14 (2018-08-28)
Leo P. Singer's avatar
Leo P. Singer committed
99
100
===================

101
102
- 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
103

104
0.0.13 (2018-08-27)
Leo P. Singer's avatar
Leo P. Singer committed
105
106
===================

Leo P. Singer's avatar
Leo P. Singer committed
107
108
109
- 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
110

111
112
113
- 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
114
115
116
117
118
- 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>`_.

119
120
121
122
- Silence deprecation warning in ``ligo-skymap-plot-stats`` due to Matplotlib
  renaming the ``hist`` method's keyword argument from ``normed`` to
  ``density``.

123
124
125
- The ``bayestar-realize-coincs`` tool now copies over spins from the input
  ``sim_inspiral`` table to the output ``sngl_inspiral`` table.

126
127
128
129
130
- 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).

131
132
133
134
- Add ``--seed`` option to ``bayestar-localize-coincs``,
  ``bayestar-localize-lvalert``, ``bayestar-mcmc``, and
  ``bayestar-realize-coincs``.

135
136
137
138
139
140
141
142
- 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.

143
144
- Rewrite ``ligo-skymap-plot-stats`` to reduce code duplication.

145
146
147
- Add ``--measurement-error gaussian-noise`` option to
  ``bayestar-realize-coincs`` to simulate a matched filter in Gaussian noise.

148
149
- Remove deprecated module ``ligo.skymap.postprocess.detector_frame``.

150
0.0.12 (2018-07-18)
Leo P. Singer's avatar
Leo P. Singer committed
151
152
===================

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

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

159
160
- Add phase convention for gstlal-spiir, which needs to be confirmed upstream.

161
162
163
- Fix datatype of simulated SNR time series produced by
  ``bayestar-realize-coincs``.

164
0.0.11 (2018-06-11)
Leo P. Singer's avatar
Leo P. Singer committed
165
166
===================

167
168
- 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
169

170
0.0.10 (2018-06-07)
Leo P. Singer's avatar
Leo P. Singer committed
171
172
===================

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

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

178
0.0.9 (2018-06-06)
Leo P. Singer's avatar
Leo P. Singer committed
179
180
==================

181
182
183
- 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
184

Leo P. Singer's avatar
Leo P. Singer committed
185
186
187
188
189
190
191
192
- 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
193

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

Leo P. Singer's avatar
Leo P. Singer committed
196
197
198
199
- 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.

200
201
- Update common files from Astropy package template.

202
0.0.8 (2018-05-10)
Leo P. Singer's avatar
Leo P. Singer committed
203
204
==================

205
206
- 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
207

208
0.0.7 (2018-04-27)
Leo P. Singer's avatar
Leo P. Singer committed
209
210
==================

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

219
220
221
- Overhaul documentation so that all essential functionality is presented on
  the front page.

222
223
- Move ``ligo.skymap.command`` to top-level ``ligo.skymap.tool`` module.

224
225
226
227
- 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
228
0.0.6 (2018-04-13)
Leo P. Singer's avatar
Leo P. Singer committed
229
230
==================

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

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

Leo P. Singer's avatar
Leo P. Singer committed
237
0.0.5 (2018-04-12)
Leo P. Singer's avatar
Leo P. Singer committed
238
239
==================

Leo P. Singer's avatar
Leo P. Singer committed
240
241
242
- 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
243

244
245
246
- Start process of switching to tqdm for progress bars so that long-running
  operations show time estimates.

247
248
249
250
- 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
251
0.0.4 (2018-03-22)
Leo P. Singer's avatar
Leo P. Singer committed
252
253
==================

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

Leo P. Singer's avatar
Leo P. Singer committed
263
264
265
- 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
266
0.0.3 (2018-03-21)
Leo P. Singer's avatar
Leo P. Singer committed
267
268
==================

Leo P. Singer's avatar
Leo P. Singer committed
269
- Bring back simulation tools from LALSuite.
Leo P. Singer's avatar
Leo P. Singer committed
270

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

Leo P. Singer's avatar
Leo P. Singer committed
273
0.0.2 (2018-03-12)
Leo P. Singer's avatar
Leo P. Singer committed
274
275
==================

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

Leo P. Singer's avatar
Leo P. Singer committed
278
0.0.1 (2018-03-12)
Leo P. Singer's avatar
Leo P. Singer committed
279
280
281
==================

- Initial release.