CHANGELOG.md 9.86 KB
Newer Older
1
2
# All notable changes will be documented in this file

3
## v1.0.7 2022-11-07
4

5
See full MR log [here](https://git.ligo.org/lscsoft/bilby_pipe/-/merge_requests?scope=all&state=merged&milestone_title=1.0.7)
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

### Changes
- Update keys stored in result for ligo skymap (!482)
- Improve npool behavior (!477)
- Improve htcondor sync method (!475, !464, !470)
- Updates for online PE (!478, !471, !467)
- Default to using the LALCBCWaveformGenerator (!462)
- Improvements to versioning and CI infrastructure (see logs)

### Added
- Enable specifying job queue (!485)
- ROQ time marginalization (!461)
- Python 3.10 testing

### Removed
- online-pe flag removed in favour of job queueu (!485)


Gregory Ashton's avatar
Gregory Ashton committed
24
25
26
27
28
29
30
31
32
33
34
35
36
## v1.0.6: 2022-04-25

See MR log [here](https://git.ligo.org/lscsoft/bilby_pipe/-/merge_requests?scope=all&state=merged&milestone_title=1.0.6)

### Changes
- Updates for O3 replay (!448)
- Improve plotting (!449, !438)
- Minor bug fixes

### Added
- Command line tool to online-process bilby_mcmc runs (!402)
- Option to specify job sides on IGWN network (!437)
- Option to specify alternative parser (!442)
Gregory Ashton's avatar
Gregory Ashton committed
37
38
39
40
41
42
43
44
45
46
47
48

## v1.0.5: 2022-01-31
### Changes
- Enable PP tests to handle real-data injections (!429)
- Update dependencies (!428, !431)
- Enable setting a range of injection values (!425)
- Use print rather than tqdm by default (!423)
- Bug fixed (https://git.ligo.org/lscsoft/bilby_pipe/-/merge_requests?scope=all&state=all&milestone_title=1.0.5)

### Added
- Add noconversion option (!420)

Gregory Ashton's avatar
Gregory Ashton committed
49
50
51
52
53
54
55
56
57
58
## v1.0.4: 2021-05-14
### Changes
- Allow different result file formats (!395)
- Address minor bugs (!394, !399)
- Add dtype kwarg to TimeSeries.get call (!401)
- Fixes to dependencies (!398, !404)

### Added
- Add parallelisation of bilby_mcmc (!397)
- Added zero likelihood option (!396)
59

Gregory Ashton's avatar
Gregory Ashton committed
60
61
62
63
64
65
66
67
68
69
70
71
72
## v1.0.3: 2021-02-17
### Changes
- Clean up the submit scripts, fixing bugs in the OSG (!380, !389, !387, !386)
- Force the use of outdirs to prevent complications (!382)
- Regenerate look-up tables based on new distance priors (!381)

### Added
- Allow data from tape (!385)
- Enable extra detectors (!383)
- Behaviour to prevent overwriting of directories (!375)
- Checking of duplicate entries (!372)
- Option to pass through the conversion functions (!373)

Gregory Ashton's avatar
Gregory Ashton committed
73
74
75
76
77
78
79
80
81
82
83
84
## v1.0.1: 2020-26-08
### Changed
- Updated bilby dependency to v1.0.2
- Enable support for the OSG and documentation (!364)
- PESummary now pointed to the "complete" config files (!366)
- Fixed bug related to nested outdir (!365)
- Add support for numerical relativity injection file (!361)
- Add support for generic waveform-arguments (!361)
- Improve behaviour for specifying single mode (!362)
- Improve slurm documentation and version information (!363, !362)
- Improve suppory for multi-line prior-dicts (!369)

Gregory Ashton's avatar
Gregory Ashton committed
85
86
87
88
89
90
91
92
93
94
95
96
97
## v1.0.1: 2020-26-08
### Added
- Priority setting for condor
- Email notofications

### Changed
- Python 3.6+ requirement
- Review files to use reference frequency of 100Hz
- Improved parent-child relation to avoid recreating cached files
- Job creation modularised
- Overhaul and improvements to the slurm backend


Gregory Ashton's avatar
Gregory Ashton committed
98
99
100
101
102
103
104
105
106
107
## v1.0.00: 2020-27-07
### Added
- Trigger-time now able to use event names (!333)
- Add option to pass in ROQ weight file directly (!340)
- Prior check and print-out and run time and sampler check (!337, !338)

### Changes
- Modularation of the main module (!336)
- Documentation bug fixes and versioning (!341 !343)

Gregory Ashton's avatar
Gregory Ashton committed
108
109
110
111
112
113
114
115
## v0.3.12: 2020-15-04
### Added
- Add support for the sky-frame in bilby 0.6.8
- Add support for post processing individual results

### Changes
- Fixed a bug in the periodic restart time

116
117
118
119
120
121
122
123
124
125
126
127
128
## v0.3.11: 2020-15-04

### Changes
-   Put periodic restart into job submission parser (!306)
-   Injection number fix (!281)
-   Changes to data read-in logic (!305)
-   Update lookup tables following changes in bilby (!307)
-   Remove hardcoded checkpoint from review runs (!309)
-   Fix issues with checkpointing (!308)
-   Remove future imports (!310)
-   Fix bug where request-cpu value was not passed through (!311)
-   Allow lal resampling (!312)

Gregory Ashton's avatar
Gregory Ashton committed
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
## v0.3.10 : 2020-30-03

### Added
-   Waveform arguments (!296)
-   prior-dict option (!288)
-   Variable waveform generator class (!283)
-   Calibration in injections (!282)
-   Likelihood kwargs (!285)

### Changes
-   Improved --help message (!298)
-   Update to date calibration files for online runs
-   Improvements to the review tests script (!286)
-   Documentation on injections (!275)

Gregory Ashton's avatar
Gregory Ashton committed
144
145
146
147
148
149
150
151
152
153
## v0.3.9 : 2020-30-03

### Changes
-   Update documentation for using CVMFS
-   Allow other samplers in the review script
-   Fix the timeslide check
-   Tweak the generation: add read methods for gwp, txt and hdf5 and improve PSD data handling
-   Use the generated complete config file at run time
-   Add an XML conversion method

Shanika Galaudage's avatar
Shanika Galaudage committed
154
## v0.3.8 : 2020-01-03
Gregory Ashton's avatar
Gregory Ashton committed
155
-   Minor release updating to bilby v0.6.3
Shanika Galaudage's avatar
Shanika Galaudage committed
156

Shanika Galaudage's avatar
Shanika Galaudage committed
157
## v0.3.7 : 2019-12-20
Gregory Ashton's avatar
Gregory Ashton committed
158
-   Minor release updating to bilby v0.6.2
Shanika Galaudage's avatar
Shanika Galaudage committed
159
160

### Changes
Gregory Ashton's avatar
Gregory Ashton committed
161
162
163
-   Fixes ROQ scaling issues
-   Modifies Default and FastTest sampler settings
-   Edits template priors to allow component mass scaling
Shanika Galaudage's avatar
Shanika Galaudage committed
164

Gregory Ashton's avatar
Gregory Ashton committed
165
## v0.3.6 : 2019-12-10
Gregory Ashton's avatar
Gregory Ashton committed
166
-   Minor release fixing bugs with the ROQ
Gregory Ashton's avatar
Gregory Ashton committed
167

Shanika Galaudage's avatar
Shanika Galaudage committed
168
## v0.3.5 : 2019-12-06
Gregory Ashton's avatar
Gregory Ashton committed
169
-   Minor release following small fixes
Shanika Galaudage's avatar
Shanika Galaudage committed
170
171
172
173
174
175
176
177
178
179
180

### Added
-   PESummary CI test
-   Mass 1 constraint to prior files

### Changes
-   Fix --convert-to-flat-in-component-mass flag
-   Pass the ROQ scale factor to the likelihood
-   Fix ROQ waveform plotting
-   Set max skymaps points to 5000

Gregory Ashton's avatar
Gregory Ashton committed
181
182
183
184
185
186
## v0.3.4 : 2019-12-02
-   Minor version release updating to bilby v0.6.1
-   Remove reflective boundaries from defaults priors
-   Resolve issue with ROQ times steps and the PSD roll off (!230)
-   Update the minimum pesummary version

Shanika Galaudage's avatar
Shanika Galaudage committed
187
## v0.3.3 : 2019-11-26
Gregory Ashton's avatar
Gregory Ashton committed
188
-   Minor release following small fixes
Shanika Galaudage's avatar
Shanika Galaudage committed
189
190
191
192
193
194

### Changes
-   All gracedb jobs default to "vanilla" universe
-   Fixes dict conversion error of reading negative numbers
-   Minor fix to gwdata paths

Shanika Galaudage's avatar
Shanika Galaudage committed
195
196
197
198
199
200
201
202
203
204
205
206
207
## v0.3.2 : 2019-11-13

### Added
-   GWpy data quality check
-   GWpy spectrogram plotting method
-   Method to apply timeshifts with example
-   Option to generate injection with different waveform to PE

### Changes
-   Fix to prior limits for actual spin maximum
-   Updated calls to pesummary
-   Minor improvements to gracedb script

Shanika Galaudage's avatar
Shanika Galaudage committed
208
209
210
211
212
213
214
215
## v0.3.1 : 2019-10-29

### Added
-   Flag for use of online PE dedicated nodes

### Changes
-   Fixed trigger time to zero for simulations
-   Writes review.ini to top level
Gregory Ashton's avatar
Gregory Ashton committed
216

Shanika Galaudage's avatar
Shanika Galaudage committed
217
## v0.3.0 : 2019-10-25
Gregory Ashton's avatar
Gregory Ashton committed
218
219
220
221
222
223
224
225
226
227
228
229
230
Major release with overhaul of main interface

### Added
-   Support for using n-parallel with other tools
-   Support for running on gps_time with injections
-   Default to file_transfer=True
-   Testing running ini files in biby-test-mode
-   Default and fast-PE sampler-kwarg settings

### Changes
-   Expanded default prior limits
-   PSD defaults updated to max at 1024 (user override available)
-   Data dump process changes
231

Gregory Ashton's avatar
Gregory Ashton committed
232
233
234
## v0.2.7 : 2019-10-02
Minor release following small fixes

Gregory Ashton's avatar
Gregory Ashton committed
235
236
237
238
239
240
241
242
243
## v0.2.6 : 2019-09-23
### Added
-   Testing of min/max frequencies
-   A warning message for cases when "tidal" waveforms are used without the appropriate frequency domain source model

### Changes
-   Improvements to the gracedb parsing in preparation for online running
-   Improvements to the logging output

Gregory Ashton's avatar
Gregory Ashton committed
244
245
246
247
## v0.2.5 : 2019-08-22
### Changes
-   Fixed bug in time-jitter option (default was None, now True)

Gregory Ashton's avatar
Gregory Ashton committed
248
249
250
251
252
253
254
255
## v0.2.4 : 2019-08-22
### Added
-   Support for use on a slurm filesystem
-   Limited support for a user-defined likelihood

### Changes
-   Improvements to the gracedb script (changes to the filenames and channels)

Gregory Ashton's avatar
Gregory Ashton committed
256
257
## v0.2.3 : 2019-08-15

258
259
260
261
262
263
### Changed
-   Removed testing against python3.5: it was found that the
    python-ldas-tools-framecpp package was no longer compatible with python3.5.
    As such, this breaks the C.I. testing environment. While basic running is
    still expected to work with python3.5, it is strongly recommended people
    update to a modern python installation.
Gregory Ashton's avatar
Gregory Ashton committed
264
265
266
267
268
269
-   Update to the review defaults and online running settings
-   Fixed bug when sampler_kwargs is None
-   Allow users to specific external source functions
-   Fix standard priors to have hign-spin (0.8) upper boundaries
-   Add time jittering option
-   Add shell script
270

Gregory Ashton's avatar
Gregory Ashton committed
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
## v0.2.2 : 2019-06-19
Release coinciding with bilby 0.5.2. Minor changes fixing bugs in 0.5.2 only

### Changed
-   Fix issues in ROQ rescaling
-   Remove print os environ statement
-   Add summary pages to fiducial runs
-   Fix minor bugs in the pp tests
-   Increase default periodic restart time to 12hrs 
-   Tweak plotting script
-   Remove double escape from priors
-   Review ini files not written to outdir
-   Compatibility issues with bilby 0.5.2


## v0.2.1 : 2019-06-18
Gregory Ashton's avatar
Gregory Ashton committed
287
Release coinciding with bilby 0.5.2
288

Gregory Ashton's avatar
Gregory Ashton committed
289
290
291
292
### Added
-   Automated rescaling
-   Automated calibration
-   pesummary as a dependency
293

Gregory Ashton's avatar
Gregory Ashton committed
294
295
296
## v0.2.0 : 2019-06-05
Release coinciding with bilby 0.5.1, planned for initial review

297
### Added
Gregory Ashton's avatar
Gregory Ashton committed
298
-   Gaussian noise flag
Gregory Ashton's avatar
Gregory Ashton committed
299
300
301
302
-   Review script
-   Gracedb module and CLI
-   Plotting module and CLI
-   PP-test module and CLI
303

Gregory Ashton's avatar
Gregory Ashton committed
304
### Changed
Gregory Ashton's avatar
Gregory Ashton committed
305
306
-   examples_ini_file -> examples 
-   Many bug fixes
Gregory Ashton's avatar
Gregory Ashton committed
307
308
309
310

## v0.1.0 : 2019-04-29

### Added
Gregory Ashton's avatar
Gregory Ashton committed
311
-   Calibration, ROQ, PSD estimation, data-setting methods, etc
Gregory Ashton's avatar
Gregory Ashton committed
312
313

## v0.0.4 : 2019-03-05
Gregory Ashton's avatar
Gregory Ashton committed
314

Gregory Ashton's avatar
Gregory Ashton committed
315
### Added
Gregory Ashton's avatar
Gregory Ashton committed
316
317
-   Flag for running the data generation step on the local head node
-   Flag for setting random seeds
Gregory Ashton's avatar
Gregory Ashton committed
318
319

### Changes
Gregory Ashton's avatar
Gregory Ashton committed
320
321
322
-   Moved all command line argument logic to a single module with switches
-   Moved data generation to use gwpy only
-   Moved PSD generation t use gwpy only
Gregory Ashton's avatar
Gregory Ashton committed
323

Gregory Ashton's avatar
Gregory Ashton committed
324
## v0.0.3 : 2019-01-14
Gregory Ashton's avatar
Gregory Ashton committed
325
326

### Added
Gregory Ashton's avatar
Gregory Ashton committed
327
-   Support for pesummary module to produce summary files
Gregory Ashton's avatar
Gregory Ashton committed
328
329

### Changed
Gregory Ashton's avatar
Gregory Ashton committed
330
-   Minor bug fixes for argument passing and result file naming
Gregory Ashton's avatar
Gregory Ashton committed
331

Gregory Ashton's avatar
Gregory Ashton committed
332
## v0.0.2 : 2019-01-10
Gregory Ashton's avatar
Gregory Ashton committed
333
334

### Added
Gregory Ashton's avatar
Gregory Ashton committed
335
336
337
338
-   Added singularity containers
-   Add testing in python 3.5, 3.6, and 3.7
-   Add a `--local` flag for testing/debug (runs the code on the host rather than submitting to a queue)
-   Add a `--query_types` flag to specify list of LDRDataFind query types to use when building the `gw_data_find` command line
339
340
341

## [0.0.1] 2018-12-31

Gregory Ashton's avatar
Gregory Ashton committed
342
-   First working version release with basic functionality