Skip to content

Commit 2a3f646

Browse files
committed
Reformat CHANGELOG for auto
1 parent 747274d commit 2a3f646

File tree

1 file changed

+52
-71
lines changed

1 file changed

+52
-71
lines changed

CHANGELOG.md

Lines changed: 52 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
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
82

93
Various improvements and compatibility/support (dcm2niix, datalad) changes.
104

11-
### Added
5+
## Added
126

137
- Add "AcquisitionTime" to the seqinfo ([#487][])
148
- Add support for saving the Phoenix Report in the sourcedata folder ([#489][])
159

16-
### Changed
10+
## Changed
1711

1812
- Python 3.5 EOLed, supported (tested) versions now: 3.6 - 3.9
1913
- In reprorin heuristic, allow for having multiple accessions since now there is
@@ -22,7 +16,7 @@ Various improvements and compatibility/support (dcm2niix, datalad) changes.
2216
sub/ses (generates too many identical files) ([#507][])
2317

2418

25-
### Fixed
19+
## Fixed
2620

2721
- Compatibility with DataLad 0.15.0. Minimal version is 0.13.0 now.
2822
- 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.
3529
and look for _bold only under sub-* directories ([#496][])
3630
- Ensure bvec/bval files are only created for dwi output ([#491][])
3731

38-
### Removed
32+
## Removed
3933

4034
- In reproin heuristic, old hardcoded sequence renamings and filters ([#508][])
4135

4236

43-
## [0.9.0] - 2020-12-23
37+
# [0.9.0] - 2020-12-23
4438

4539
Various improvements and compatibility/support (dcm2niix, datalad,
4640
duecredit) changes. Major change is placement of output files to the
4741
target output directory during conversion.
4842

49-
### Added
43+
## Added
5044

5145
- #454 zenodo referencing in README.rst and support for ducredit for
5246
heudiconv and reproin heuristic
5347
- #445 more tutorial references in README.md
5448

55-
### Changed
49+
## Changed
5650

5751
- [#485][] placed files during conversion right away into the target
5852
directory (with a `_heudiconv???` suffix, renamed into ultimate target
@@ -66,21 +60,21 @@ target output directory during conversion.
6660
- [#442][] refactored code so there is now heudiconv.main.workflow for
6761
more convenient use as a Python module
6862

69-
### Fixed
63+
## Fixed
7064

7165
- minimal version of nipype set to 1.2.3 to guarantee correct handling
7266
of DWI files ([#480][])
7367
- `heudiconvDCM*` temporary directories are removed now ([#462][])
7468
- compatibility with DataLad 0.13 ([#464][])
7569

76-
### Removed
70+
## Removed
7771

7872
- #443 pathlib as a dependency (we are Python3 only now)
7973

8074

81-
## [0.8.0] - 2020-04-15
75+
# [0.8.0] - 2020-04-15
8276

83-
### Enhancements
77+
## Enhancements
8478

8579
- Centralized saving of .json files. Indentation of some files could
8680
change now from previous versions where it could have used `3`
@@ -92,25 +86,25 @@ target output directory during conversion.
9286
- Provide an informative exception if command needs heuristic to be
9387
specified ([#437][])
9488

95-
### Refactored
89+
## Refactored
9690

9791
- `embed_nifti` was refactored into `embed_dicom_and_nifti_metadata`
9892
which would no longer create `.nii` file if it does not exist
9993
already ([#432][])
10094

101-
### Fixed
95+
## Fixed
10296

10397
- Skip datalad-based tests if no datalad available ([#430][])
10498
- Search heuristic file path first so we do not pick up a python
10599
module if name conflicts ([#434][])
106100

107-
## [0.7.0] - 2020-03-20
101+
# [0.7.0] - 2020-03-20
108102

109-
### Removed
103+
## Removed
110104

111105
- Python 2 support/testing
112106

113-
### Enhancement
107+
## Enhancement
114108

115109
- `-g` option obtained two new modes: `all` and `custom`. In case of `all`,
116110
all provided DICOMs will be treated as coming from a single scanning session.
@@ -126,23 +120,23 @@ target output directory during conversion.
126120
naming (documentation is to come to http://github.com/ReproNim/reproin)
127121
([#425][])
128122

129-
### Fixed
123+
## Fixed
130124

131125
- Use nan, not None for absent echo value in sorting
132126
- reproin heuristic: case seqinfos into a list to be able to modify from
133127
overloaded heuristic ([#419][])
134128
- No spurious errors from the logger upon a warning about `etelemetry`
135129
absence ([#407][])
136130

137-
## [0.6.0] - 2019-12-16
131+
# [0.6.0] - 2019-12-16
138132

139133
This is largely a bug fix. Metadata and order of `_key-value` fields in BIDS
140134
could change from the result of converting using previous versions, thus minor
141135
version boost.
142136
14 people contributed to this release -- thanks
143137
[everyone](https://github.com/nipy/heudiconv/graphs/contributors)!
144138

145-
### Enhancement
139+
## Enhancement
146140

147141
- Use [etelemetry](https://pypi.org/project/etelemetry) to inform about most
148142
recent available version of heudiconv. Please set `NO_ET` environment variable
@@ -168,7 +162,7 @@ version boost.
168162
- Log location of a bad .json file to ease troubleshooting ([#379][])
169163
- Add basic pypi classifiers for the package ([#380][])
170164

171-
### Fixed
165+
## Fixed
172166
- Sorting `_scans.tsv` files lacking valid dates field should not cause a crash
173167
([#337][])
174168
- Multi-echo files detection based number of echos ([#339][])
@@ -191,7 +185,7 @@ version boost.
191185
- Do not crash (with TypeError) while trying to sort absent file list ([#360][])
192186
- heudiconv requires nipype >= 1.0.0 ([#364][]) and blacklists `1.2.[12]` ([#375][])
193187

194-
## [0.5.4] - 2019-04-29
188+
# [0.5.4] - 2019-04-29
195189

196190
This release includes fixes to BIDS multi-echo conversions, the
197191
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.
201195
Finally, to more accurately reflect on-going development, the `latest`
202196
tag has been renamed to `unstable`.
203197

204-
### Added
198+
## Added
205199
- Readthedocs documentation ([#327][])
206200

207-
### Changed
201+
## Changed
208202
- Update Docker dcm2niix to v.1.0.20190410 ([#334][])
209203
- Allow usage of `--files` with basic heuristics. This requires
210204
use of `--subject` flag, and is limited to one subject. ([#293][])
211205

212-
### Deprecated
206+
## Deprecated
213207

214-
### Fixed
208+
## Fixed
215209
- Improve support for multiple `--queue-args` ([#328][])
216210
- Fixed an issue where generated BIDS sidecar files were missing additional
217211
information - treating all conversions as if the `--minmeta` flag was
@@ -222,24 +216,24 @@ tag has been renamed to `unstable`.
222216
before '.nii.gz'. Previously would have lead to absent additional metadata
223217
extraction etc ([#310][])
224218

225-
### Removed
219+
## Removed
226220
- `--sbargs` argument was renamed to `--queue-args` ([#304][])
227221

228-
### Security
222+
## Security
229223

230224

231-
## [0.5.3] - 2019-01-12
225+
# [0.5.3] - 2019-01-12
232226

233227
Minor hot bugfix release
234228

235-
### Fixed
229+
## Fixed
236230
- Do not shorten spaces in the dates while pretty printing .json
237231

238-
## [0.5.2] - 2019-01-04
232+
# [0.5.2] - 2019-01-04
239233

240234
A variety of bugfixes
241235

242-
### Changed
236+
## Changed
243237
- Reproin heuristic: `__dup` indices would now be assigned incrementally
244238
individually per each sequence, so there is a chance to properly treat
245239
associate for multi-file (e.g. `fmap`) sequences
@@ -250,7 +244,7 @@ A variety of bugfixes
250244
csa.tProtocolName header field if not present in public one
251245
- nipype>=0.12.0 is required now
252246

253-
### Fixed
247+
## Fixed
254248
- Multiple files produced by dcm2niix are first sorted to guarantee
255249
correct order e.g. of magnitude files in fieldmaps, which otherwise
256250
resulted in incorrect according to BIDS ordering of them
@@ -259,23 +253,23 @@ A variety of bugfixes
259253
those files were not regenerated after an initial conversion
260254
- Unicode handling in anonimization scripts
261255

262-
## [0.5.1] - 2018-07-05
256+
# [0.5.1] - 2018-07-05
263257
Bugfix release
264258

265-
### Added
259+
## Added
266260
- Video tutorial / updated slides
267261
- Helper to set metadata restrictions correctly
268262
- Usage is now shown when run without arguments
269263
- New fields to Seqinfo
270264
- series_uid
271265
- Reproin heuristic support for xnat
272-
### Changed
266+
## Changed
273267
- Dockerfile updated to use `dcm2niix v1.0.20180622`
274268
- Conversion table will be regenerated if heurisic has changed
275269
- Do not touch existing BIDS files
276270
- events.tsv
277271
- task JSON
278-
### Fixed
272+
## Fixed
279273
- Python 2.7.8 and older installation
280274
- Support for updated packages
281275
- `Datalad` 0.10
@@ -286,10 +280,10 @@ Bugfix release
286280
- ensure phasediff exists
287281
- support for single magnitude acquisitions
288282

289-
## [0.5] - 2018-03-01
283+
# [0.5] - 2018-03-01
290284
The first release after major refactoring:
291285

292-
### Changed
286+
## Changed
293287
- Refactored into a proper `heudiconv` Python module
294288
- `heuristics` is now a `heudiconv.heuristics` submodule
295289
- you can specify shipped heuristics by name (e.g. `-f reproin`)
@@ -301,7 +295,7 @@ The first release after major refactoring:
301295
- Logging verbosity reduced
302296
- Increased leniency with missing DICOM fields
303297
- `dbic_bids` heuristic renamed into reproin
304-
### Added
298+
## Added
305299
- [LICENSE](https://github.com/nipy/heudiconv/blob/master/LICENSE)
306300
with Apache 2.0 license for the project
307301
- [CHANGELOG.md](https://github.com/nipy/heudiconv/blob/master/CHANGELOG.md)
@@ -311,11 +305,11 @@ The first release after major refactoring:
311305
`reproin` heuristic shipped with heudiconv
312306
- [utils/test-compare-two-versions.sh](utils/test-compare-two-versions.sh)
313307
helper to compare conversions with two different versions of heudiconv
314-
### Removed
308+
## Removed
315309
- Support for converters other than `dcm2niix`, which is now the default.
316310
Explicitly specify `-c none` to only prepare conversion specification
317311
files without performing actual conversion
318-
### Fixed
312+
## Fixed
319313
- Compatibility with Nipype 1.0, PyDicom 1.0, and upcoming DataLad 0.10
320314
- Consistency with converted files permissions
321315
- Ensured subject id for BIDS conversions will be BIDS compliant
@@ -324,54 +318,41 @@ The first release after major refactoring:
324318
numeric precision issues
325319
- Many other various issues
326320

327-
## [0.4] - 2017-10-15
321+
# [0.4] - 2017-10-15
328322
A usable release to support [DBIC][] use-case
329-
### Added
323+
## Added
330324
- more testing
331-
### Changes
325+
## Changes
332326
- Dockerfile updates (added pigz, progressed forward [dcm2niix][])
333-
### Fixed
327+
## Fixed
334328
- correct date/time in BIDS `_scans` files
335329
- sort entries in `_scans` by date and then filename
336330

337-
## [0.3] - 2017-07-10
331+
# [0.3] - 2017-07-10
338332
A somewhat working release on the way to support [DBIC][] use-case
339-
### Added
333+
## Added
340334
- more tests
341335
- groupping of dicoms by series if provided
342336
- many more features and fixes
343337

344-
## [0.2] - 2016-10-20
338+
# [0.2] - 2016-10-20
345339
An initial release on the way to support [DBIC][] use-case
346-
### Added
340+
## Added
347341
- basic Python project assets (`setup.py`, etc)
348342
- basic tests
349343
- [datalad][] support
350344
- dbic_bids heuristic
351345
- `--dbg` command line flag to enter `pdb` environment upon failure
352-
## Fixed
346+
# Fixed
353347
- Better Python3 support
354348
- Better PEP8 compliance
355349

356-
## [0.1] - 2015-09-23
350+
# [0.1] - 2015-09-23
357351

358352
Initial version
359353

360354
---
361355

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-
375356
## References
376357
[DBIC]: http://dbic.dartmouth.edu
377358
[datalad]: http://datalad.org

0 commit comments

Comments
 (0)