1
- # Changelog
2
- All notable changes to this project will be documented (for humans) in this file.
3
-
4
- The format is based on [ Keep a Changelog] ( http://keepachangelog.com/en/1.0.0/ )
5
- and this project adheres to [ Semantic Versioning] ( http://semver.org/spec/v2.0.0.html ) .
6
-
7
- ## [ 0.10.0] - 2021-09-16
1
+ # [ 0.10.0] - 2021-09-16
8
2
9
3
Various improvements and compatibility/support (dcm2niix, datalad) changes.
10
4
11
- ### Added
5
+ ## Added
12
6
13
7
- Add "AcquisitionTime" to the seqinfo ([ #487 ] [ ] )
14
8
- Add support for saving the Phoenix Report in the sourcedata folder ([ #489 ] [ ] )
15
9
16
- ### Changed
10
+ ## Changed
17
11
18
12
- Python 3.5 EOLed, supported (tested) versions now: 3.6 - 3.9
19
13
- In reprorin heuristic, allow for having multiple accessions since now there is
@@ -22,7 +16,7 @@ Various improvements and compatibility/support (dcm2niix, datalad) changes.
22
16
sub/ses (generates too many identical files) ([ #507 ] [ ] )
23
17
24
18
25
- ### Fixed
19
+ ## Fixed
26
20
27
21
- Compatibility with DataLad 0.15.0. Minimal version is 0.13.0 now.
28
22
- Try to open top level BIDS .json files a number of times for adjustment,
@@ -35,24 +29,24 @@ Various improvements and compatibility/support (dcm2niix, datalad) changes.
35
29
and look for _ bold only under sub-* directories ([ #496 ] [ ] )
36
30
- Ensure bvec/bval files are only created for dwi output ([ #491 ] [ ] )
37
31
38
- ### Removed
32
+ ## Removed
39
33
40
34
- In reproin heuristic, old hardcoded sequence renamings and filters ([ #508 ] [ ] )
41
35
42
36
43
- ## [ 0.9.0] - 2020-12-23
37
+ # [ 0.9.0] - 2020-12-23
44
38
45
39
Various improvements and compatibility/support (dcm2niix, datalad,
46
40
duecredit) changes. Major change is placement of output files to the
47
41
target output directory during conversion.
48
42
49
- ### Added
43
+ ## Added
50
44
51
45
- #454 zenodo referencing in README.rst and support for ducredit for
52
46
heudiconv and reproin heuristic
53
47
- #445 more tutorial references in README.md
54
48
55
- ### Changed
49
+ ## Changed
56
50
57
51
- [ #485 ] [ ] placed files during conversion right away into the target
58
52
directory (with a ` _heudiconv??? ` suffix, renamed into ultimate target
@@ -66,21 +60,21 @@ target output directory during conversion.
66
60
- [ #442 ] [ ] refactored code so there is now heudiconv.main.workflow for
67
61
more convenient use as a Python module
68
62
69
- ### Fixed
63
+ ## Fixed
70
64
71
65
- minimal version of nipype set to 1.2.3 to guarantee correct handling
72
66
of DWI files ([ #480 ] [ ] )
73
67
- ` heudiconvDCM* ` temporary directories are removed now ([ #462 ] [ ] )
74
68
- compatibility with DataLad 0.13 ([ #464 ] [ ] )
75
69
76
- ### Removed
70
+ ## Removed
77
71
78
72
- #443 pathlib as a dependency (we are Python3 only now)
79
73
80
74
81
- ## [ 0.8.0] - 2020-04-15
75
+ # [ 0.8.0] - 2020-04-15
82
76
83
- ### Enhancements
77
+ ## Enhancements
84
78
85
79
- Centralized saving of .json files. Indentation of some files could
86
80
change now from previous versions where it could have used ` 3 `
@@ -92,25 +86,25 @@ target output directory during conversion.
92
86
- Provide an informative exception if command needs heuristic to be
93
87
specified ([ #437 ] [ ] )
94
88
95
- ### Refactored
89
+ ## Refactored
96
90
97
91
- ` embed_nifti ` was refactored into ` embed_dicom_and_nifti_metadata `
98
92
which would no longer create ` .nii ` file if it does not exist
99
93
already ([ #432 ] [ ] )
100
94
101
- ### Fixed
95
+ ## Fixed
102
96
103
97
- Skip datalad-based tests if no datalad available ([ #430 ] [ ] )
104
98
- Search heuristic file path first so we do not pick up a python
105
99
module if name conflicts ([ #434 ] [ ] )
106
100
107
- ## [ 0.7.0] - 2020-03-20
101
+ # [ 0.7.0] - 2020-03-20
108
102
109
- ### Removed
103
+ ## Removed
110
104
111
105
- Python 2 support/testing
112
106
113
- ### Enhancement
107
+ ## Enhancement
114
108
115
109
- ` -g ` option obtained two new modes: ` all ` and ` custom ` . In case of ` all ` ,
116
110
all provided DICOMs will be treated as coming from a single scanning session.
@@ -126,23 +120,23 @@ target output directory during conversion.
126
120
naming (documentation is to come to http://github.com/ReproNim/reproin )
127
121
([ #425 ] [ ] )
128
122
129
- ### Fixed
123
+ ## Fixed
130
124
131
125
- Use nan, not None for absent echo value in sorting
132
126
- reproin heuristic: case seqinfos into a list to be able to modify from
133
127
overloaded heuristic ([ #419 ] [ ] )
134
128
- No spurious errors from the logger upon a warning about ` etelemetry `
135
129
absence ([ #407 ] [ ] )
136
130
137
- ## [ 0.6.0] - 2019-12-16
131
+ # [ 0.6.0] - 2019-12-16
138
132
139
133
This is largely a bug fix. Metadata and order of ` _key-value ` fields in BIDS
140
134
could change from the result of converting using previous versions, thus minor
141
135
version boost.
142
136
14 people contributed to this release -- thanks
143
137
[ everyone] ( https://github.com/nipy/heudiconv/graphs/contributors ) !
144
138
145
- ### Enhancement
139
+ ## Enhancement
146
140
147
141
- Use [ etelemetry] ( https://pypi.org/project/etelemetry ) to inform about most
148
142
recent available version of heudiconv. Please set ` NO_ET ` environment variable
@@ -168,7 +162,7 @@ version boost.
168
162
- Log location of a bad .json file to ease troubleshooting ([ #379 ] [ ] )
169
163
- Add basic pypi classifiers for the package ([ #380 ] [ ] )
170
164
171
- ### Fixed
165
+ ## Fixed
172
166
- Sorting ` _scans.tsv ` files lacking valid dates field should not cause a crash
173
167
([ #337 ] [ ] )
174
168
- Multi-echo files detection based number of echos ([ #339 ] [ ] )
@@ -191,7 +185,7 @@ version boost.
191
185
- Do not crash (with TypeError) while trying to sort absent file list ([ #360 ] [ ] )
192
186
- heudiconv requires nipype >= 1.0.0 ([ #364 ] [ ] ) and blacklists ` 1.2.[12] ` ([ #375 ] [ ] )
193
187
194
- ## [ 0.5.4] - 2019-04-29
188
+ # [ 0.5.4] - 2019-04-29
195
189
196
190
This release includes fixes to BIDS multi-echo conversions, the
197
191
re-implementation of queuing support (currently just SLURM), as well as
@@ -201,17 +195,17 @@ Starting today, we will (finally) push versioned releases to DockerHub.
201
195
Finally, to more accurately reflect on-going development, the ` latest `
202
196
tag has been renamed to ` unstable ` .
203
197
204
- ### Added
198
+ ## Added
205
199
- Readthedocs documentation ([ #327 ] [ ] )
206
200
207
- ### Changed
201
+ ## Changed
208
202
- Update Docker dcm2niix to v.1.0.20190410 ([ #334 ] [ ] )
209
203
- Allow usage of ` --files ` with basic heuristics. This requires
210
204
use of ` --subject ` flag, and is limited to one subject. ([ #293 ] [ ] )
211
205
212
- ### Deprecated
206
+ ## Deprecated
213
207
214
- ### Fixed
208
+ ## Fixed
215
209
- Improve support for multiple ` --queue-args ` ([ #328 ] [ ] )
216
210
- Fixed an issue where generated BIDS sidecar files were missing additional
217
211
information - treating all conversions as if the ` --minmeta ` flag was
@@ -222,24 +216,24 @@ tag has been renamed to `unstable`.
222
216
before '.nii.gz'. Previously would have lead to absent additional metadata
223
217
extraction etc ([ #310 ] [ ] )
224
218
225
- ### Removed
219
+ ## Removed
226
220
- ` --sbargs ` argument was renamed to ` --queue-args ` ([ #304 ] [ ] )
227
221
228
- ### Security
222
+ ## Security
229
223
230
224
231
- ## [ 0.5.3] - 2019-01-12
225
+ # [ 0.5.3] - 2019-01-12
232
226
233
227
Minor hot bugfix release
234
228
235
- ### Fixed
229
+ ## Fixed
236
230
- Do not shorten spaces in the dates while pretty printing .json
237
231
238
- ## [ 0.5.2] - 2019-01-04
232
+ # [ 0.5.2] - 2019-01-04
239
233
240
234
A variety of bugfixes
241
235
242
- ### Changed
236
+ ## Changed
243
237
- Reproin heuristic: ` __dup ` indices would now be assigned incrementally
244
238
individually per each sequence, so there is a chance to properly treat
245
239
associate for multi-file (e.g. ` fmap ` ) sequences
@@ -250,7 +244,7 @@ A variety of bugfixes
250
244
csa.tProtocolName header field if not present in public one
251
245
- nipype>=0.12.0 is required now
252
246
253
- ### Fixed
247
+ ## Fixed
254
248
- Multiple files produced by dcm2niix are first sorted to guarantee
255
249
correct order e.g. of magnitude files in fieldmaps, which otherwise
256
250
resulted in incorrect according to BIDS ordering of them
@@ -259,23 +253,23 @@ A variety of bugfixes
259
253
those files were not regenerated after an initial conversion
260
254
- Unicode handling in anonimization scripts
261
255
262
- ## [ 0.5.1] - 2018-07-05
256
+ # [ 0.5.1] - 2018-07-05
263
257
Bugfix release
264
258
265
- ### Added
259
+ ## Added
266
260
- Video tutorial / updated slides
267
261
- Helper to set metadata restrictions correctly
268
262
- Usage is now shown when run without arguments
269
263
- New fields to Seqinfo
270
264
- series_uid
271
265
- Reproin heuristic support for xnat
272
- ### Changed
266
+ ## Changed
273
267
- Dockerfile updated to use ` dcm2niix v1.0.20180622 `
274
268
- Conversion table will be regenerated if heurisic has changed
275
269
- Do not touch existing BIDS files
276
270
- events.tsv
277
271
- task JSON
278
- ### Fixed
272
+ ## Fixed
279
273
- Python 2.7.8 and older installation
280
274
- Support for updated packages
281
275
- ` Datalad ` 0.10
@@ -286,10 +280,10 @@ Bugfix release
286
280
- ensure phasediff exists
287
281
- support for single magnitude acquisitions
288
282
289
- ## [ 0.5] - 2018-03-01
283
+ # [ 0.5] - 2018-03-01
290
284
The first release after major refactoring:
291
285
292
- ### Changed
286
+ ## Changed
293
287
- Refactored into a proper ` heudiconv ` Python module
294
288
- ` heuristics ` is now a ` heudiconv.heuristics ` submodule
295
289
- you can specify shipped heuristics by name (e.g. ` -f reproin ` )
@@ -301,7 +295,7 @@ The first release after major refactoring:
301
295
- Logging verbosity reduced
302
296
- Increased leniency with missing DICOM fields
303
297
- ` dbic_bids ` heuristic renamed into reproin
304
- ### Added
298
+ ## Added
305
299
- [ LICENSE] ( https://github.com/nipy/heudiconv/blob/master/LICENSE )
306
300
with Apache 2.0 license for the project
307
301
- [ CHANGELOG.md] ( https://github.com/nipy/heudiconv/blob/master/CHANGELOG.md )
@@ -311,11 +305,11 @@ The first release after major refactoring:
311
305
` reproin ` heuristic shipped with heudiconv
312
306
- [ utils/test-compare-two-versions.sh] ( utils/test-compare-two-versions.sh )
313
307
helper to compare conversions with two different versions of heudiconv
314
- ### Removed
308
+ ## Removed
315
309
- Support for converters other than ` dcm2niix ` , which is now the default.
316
310
Explicitly specify ` -c none ` to only prepare conversion specification
317
311
files without performing actual conversion
318
- ### Fixed
312
+ ## Fixed
319
313
- Compatibility with Nipype 1.0, PyDicom 1.0, and upcoming DataLad 0.10
320
314
- Consistency with converted files permissions
321
315
- Ensured subject id for BIDS conversions will be BIDS compliant
@@ -324,54 +318,41 @@ The first release after major refactoring:
324
318
numeric precision issues
325
319
- Many other various issues
326
320
327
- ## [ 0.4] - 2017-10-15
321
+ # [ 0.4] - 2017-10-15
328
322
A usable release to support [ DBIC] [ ] use-case
329
- ### Added
323
+ ## Added
330
324
- more testing
331
- ### Changes
325
+ ## Changes
332
326
- Dockerfile updates (added pigz, progressed forward [ dcm2niix] [ ] )
333
- ### Fixed
327
+ ## Fixed
334
328
- correct date/time in BIDS ` _scans ` files
335
329
- sort entries in ` _scans ` by date and then filename
336
330
337
- ## [ 0.3] - 2017-07-10
331
+ # [ 0.3] - 2017-07-10
338
332
A somewhat working release on the way to support [ DBIC] [ ] use-case
339
- ### Added
333
+ ## Added
340
334
- more tests
341
335
- groupping of dicoms by series if provided
342
336
- many more features and fixes
343
337
344
- ## [ 0.2] - 2016-10-20
338
+ # [ 0.2] - 2016-10-20
345
339
An initial release on the way to support [ DBIC] [ ] use-case
346
- ### Added
340
+ ## Added
347
341
- basic Python project assets (` setup.py ` , etc)
348
342
- basic tests
349
343
- [ datalad] [ ] support
350
344
- dbic_bids heuristic
351
345
- ` --dbg ` command line flag to enter ` pdb ` environment upon failure
352
- ## Fixed
346
+ # Fixed
353
347
- Better Python3 support
354
348
- Better PEP8 compliance
355
349
356
- ## [ 0.1] - 2015-09-23
350
+ # [ 0.1] - 2015-09-23
357
351
358
352
Initial version
359
353
360
354
---
361
355
362
- Just a template for future records:
363
-
364
- ## [ Unreleased] - Date
365
- TODO Summary
366
- ### Added
367
- ### Changed
368
- ### Deprecated
369
- ### Fixed
370
- ### Removed
371
- ### Security
372
-
373
- ---
374
-
375
356
## References
376
357
[ DBIC ] : http://dbic.dartmouth.edu
377
358
[ datalad ] : http://datalad.org
0 commit comments