Skip to content

Commit e6c5e1b

Browse files
committed
Merge tag 'v0.6.0' into debian
This is largely a bug fix. Metadata and order of `_key-value` fields in BIDS could change from the result of converting using previous versions, thus minor version boost. 14 people contributed to this release -- thanks [everyone](https://github.com/nipy/heudiconv/graphs/contributors)! Enhancement - Use [etelemetry](https://pypi.org/project/etelemetry) to inform about most recent available version of heudiconv. Please set `NO_ET` environment variable if you want to disable it ([#369][]) - BIDS: - `--bids` flag became an option. It can (optionally) accept `notop` value to avoid creation of top level files (`CHANGES`, `dataset_description.json`, etc) as a workaround during parallel execution to avoid race conditions etc. ([#344][]) - Generate basic `.json` files with descriptions of the fields for `participants.tsv` and `_scans.tsv` files ([#376][]) - Use `filelock` while writing top level files. Use `HEUDICONV_FILELOCK_TIMEOUT` environment to change the default timeout value ([#348][]) - `_PDT2` was added as a suffix for multi-echo (really "multi-modal") sequences ([#345][]) - Calls to `dcm2niix` would include full output path to make it easier to discern in the logs what file it is working on ([#351][]) - With recent [datalad]() (>= 0.10), created DataLad dataset will use `--fake-dates` functionality of DataLad to not leak data conversion dates, which might be close to actual data acquisition/patient visit ([#352][]) - Support multi-echo EPI `_phase` data ([#373][] fixes [#368][]) - Log location of a bad .json file to ease troubleshooting ([#379][]) - Add basic pypi classifiers for the package ([#380][]) Fixed - Sorting `_scans.tsv` files lacking valid dates field should not cause a crash ([#337][]) - Multi-echo files detection based number of echos ([#339][]) - BIDS - Use `EchoTimes` from the associated multi-echo files if `EchoNumber` tag is missing ([#366][] fixes [#347][]) - Tolerate empty ContentTime and/or ContentDate in DICOMs ([#372][]) and place "n/a" if value is missing ([#390][]) - Do not crash and store original .json file is "JSON pretification" fails ([#342][]) - ReproIn heuristic - tollerate WIP prefix on Philips scanners ([#343][]) - allow for use of `(...)` instead of `{...}` since `{}` are not allowed ([#343][]) - Support pipolar fieldmaps by providing them with `_epi` not `_magnitude`. "Loose" BIDS `_key-value` pairs might come now after `_dir-` even if they came first before ([#358][] fixes [#357][]) - All heuristics saved under `.heudiconv/` under `heuristic.py` name, to avoid discrepancy during reconversion ([#354][] fixes [#353][]) - Do not crash (with TypeError) while trying to sort absent file list ([#360][]) - heudiconv requires nipype >= 1.0.0 ([#364][]) and blacklists `1.2.[12]` ([#375][]) * tag 'v0.6.0': (60 commits) Version boost to 0.6.0 DOC: populate detailed changelog for 0.6.0 and tune up formatting in previous one Fix miscellaneous typos in ReproIn heuristic file. BF: fix check for the sbatch (SLURM) not being available ENH: make test-compare-two-versions take any two worktrees, and just show diff if results already known Update heudiconv/convert.py apply @mgxd 's suggestions, adding a warning and a timeout environment variable need str typecast Use empty string not None Empty acq_time results in empty cell not 'n/a' DOC: Clarify tarball session handling remove repetitive import statement respond to review - add explicit py2 check - change file saving strategy - use logger instead of print fix remaning py2 errors MNT: Add Python support metadata to package fix some python2/3 incompatibilities add return data (accidently removed return) make content unicode test that load_json provides filename if invalid explicitly name invalid json ...
2 parents f745d8b + ceb1386 commit e6c5e1b

22 files changed

+526
-356
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
language: python
33
python:
44
- 2.7
5-
- 3.4
65
- 3.5
76
- 3.6
7+
- 3.7
88

99
cache:
1010
- apt

CHANGELOG.md

Lines changed: 92 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,72 @@ All notable changes to this project will be documented (for humans) in this file
44
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

7+
## [0.6.0] - 2019-12-05
8+
9+
This is largely a bug fix. Metadata and order of `_key-value` fields in BIDS
10+
could change from the result of converting using previous versions, thus minor
11+
version boost.
12+
14 people contributed to this release -- thanks
13+
[everyone](https://github.com/nipy/heudiconv/graphs/contributors)!
14+
15+
### Enhancement
16+
17+
- Use [etelemetry](https://pypi.org/project/etelemetry) to inform about most
18+
recent available version of heudiconv. Please set `NO_ET` environment variable
19+
if you want to disable it ([#369][])
20+
- BIDS:
21+
- `--bids` flag became an option. It can (optionally) accept `notop` value
22+
to avoid creation of top level files (`CHANGES`, `dataset_description.json`,
23+
etc) as a workaround during parallel execution to avoid race conditions etc.
24+
([#344][])
25+
- Generate basic `.json` files with descriptions of the fields for
26+
`participants.tsv` and `_scans.tsv` files ([#376][])
27+
- Use `filelock` while writing top level files. Use
28+
`HEUDICONV_FILELOCK_TIMEOUT` environment to change the default timeout value
29+
([#348][])
30+
- `_PDT2` was added as a suffix for multi-echo (really "multi-modal")
31+
sequences ([#345][])
32+
- Calls to `dcm2niix` would include full output path to make it easier to
33+
discern in the logs what file it is working on ([#351][])
34+
- With recent [datalad]() (>= 0.10), created DataLad dataset will use
35+
`--fake-dates` functionality of DataLad to not leak data conversion dates,
36+
which might be close to actual data acquisition/patient visit ([#352][])
37+
- Support multi-echo EPI `_phase` data ([#373][] fixes [#368][])
38+
- Log location of a bad .json file to ease troubleshooting ([#379][])
39+
- Add basic pypi classifiers for the package ([#380][])
40+
41+
### Fixed
42+
- Sorting `_scans.tsv` files lacking valid dates field should not cause a crash
43+
([#337][])
44+
- Multi-echo files detection based number of echos ([#339][])
45+
- BIDS
46+
- Use `EchoTimes` from the associated multi-echo files if `EchoNumber` tag is
47+
missing ([#366][] fixes [#347][])
48+
- Tolerate empty ContentTime and/or ContentDate in DICOMs ([#372][]) and place
49+
"n/a" if value is missing ([#390][])
50+
- Do not crash and store original .json file is "JSON pretification" fails
51+
([#342][])
52+
- ReproIn heuristic
53+
- tollerate WIP prefix on Philips scanners ([#343][])
54+
- allow for use of `(...)` instead of `{...}` since `{}` are not allowed
55+
([#343][])
56+
- Support pipolar fieldmaps by providing them with `_epi` not `_magnitude`.
57+
"Loose" BIDS `_key-value` pairs might come now after `_dir-` even if they
58+
came first before ([#358][] fixes [#357][])
59+
- All heuristics saved under `.heudiconv/` under `heuristic.py` name, to avoid
60+
discrepancy during reconversion ([#354][] fixes [#353][])
61+
- Do not crash (with TypeError) while trying to sort absent file list ([#360][])
62+
- heudiconv requires nipype >= 1.0.0 ([#364][]) and blacklists `1.2.[12]` ([#375][])
63+
764
## [0.5.4] - 2019-04-29
865

966
This release includes fixes to BIDS multi-echo conversions, the
10-
re-implementation of queuing support (currently just SLURM), as well as
11-
some bugfixes.
67+
re-implementation of queuing support (currently just SLURM), as well as
68+
some bugfixes.
1269

13-
Starting today, we will (finally) push versioned releases to DockerHub.
14-
Finally, to more accurately reflect on-going development, the `latest`
15-
tag has been renamed to `unstable`.
70+
Starting today, we will (finally) push versioned releases to DockerHub.
71+
Finally, to more accurately reflect on-going development, the `latest`
72+
tag has been renamed to `unstable`.
1673

1774
### Added
1875
- Readthedocs documentation ([#327][])
@@ -189,8 +246,37 @@ TODO Summary
189246
[DBIC]: http://dbic.dartmouth.edu
190247
[datalad]: http://datalad.org
191248
[dcm2niix]: https://github.com/rordenlab/dcm2niix
192-
[#293]: https://github.com/nipy/heudiconv/issues/293
193249
[#301]: https://github.com/nipy/heudiconv/issues/301
250+
[#353]: https://github.com/nipy/heudiconv/issues/353
251+
[#354]: https://github.com/nipy/heudiconv/issues/354
252+
[#357]: https://github.com/nipy/heudiconv/issues/357
253+
[#358]: https://github.com/nipy/heudiconv/issues/358
254+
[#347]: https://github.com/nipy/heudiconv/issues/347
255+
[#366]: https://github.com/nipy/heudiconv/issues/366
256+
[#368]: https://github.com/nipy/heudiconv/issues/368
257+
[#373]: https://github.com/nipy/heudiconv/issues/373
258+
[#293]: https://github.com/nipy/heudiconv/issues/293
194259
[#304]: https://github.com/nipy/heudiconv/issues/304
195260
[#306]: https://github.com/nipy/heudiconv/issues/306
196261
[#310]: https://github.com/nipy/heudiconv/issues/310
262+
[#327]: https://github.com/nipy/heudiconv/issues/327
263+
[#328]: https://github.com/nipy/heudiconv/issues/328
264+
[#334]: https://github.com/nipy/heudiconv/issues/334
265+
[#337]: https://github.com/nipy/heudiconv/issues/337
266+
[#339]: https://github.com/nipy/heudiconv/issues/339
267+
[#342]: https://github.com/nipy/heudiconv/issues/342
268+
[#343]: https://github.com/nipy/heudiconv/issues/343
269+
[#344]: https://github.com/nipy/heudiconv/issues/344
270+
[#345]: https://github.com/nipy/heudiconv/issues/345
271+
[#348]: https://github.com/nipy/heudiconv/issues/348
272+
[#351]: https://github.com/nipy/heudiconv/issues/351
273+
[#352]: https://github.com/nipy/heudiconv/issues/352
274+
[#360]: https://github.com/nipy/heudiconv/issues/360
275+
[#364]: https://github.com/nipy/heudiconv/issues/364
276+
[#369]: https://github.com/nipy/heudiconv/issues/369
277+
[#372]: https://github.com/nipy/heudiconv/issues/372
278+
[#375]: https://github.com/nipy/heudiconv/issues/375
279+
[#376]: https://github.com/nipy/heudiconv/issues/376
280+
[#379]: https://github.com/nipy/heudiconv/issues/379
281+
[#380]: https://github.com/nipy/heudiconv/issues/380
282+
[#390]: https://github.com/nipy/heudiconv/issues/390

README.md

Lines changed: 0 additions & 201 deletions
This file was deleted.

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
`a heuristic-centric DICOM converter`
66

7-
.. image:: https://img.shields.io/badge/docker-nipy/heudiconv:unstable-brightgreen.svg?logo=docker&style=flat
7+
.. image:: https://img.shields.io/badge/docker-nipy/heudiconv:0.5.4-brightgreen.svg?logo=docker&style=flat
88
:target: https://hub.docker.com/r/nipy/heudiconv/tags/
99
:alt: Our Docker image
1010

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
# The short X.Y version
2727
version = ''
2828
# The full version, including alpha/beta/rc tags
29-
release = '0.5.4'
29+
release = '0.6.0'
3030

3131

3232
# -- General configuration ---------------------------------------------------

docs/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ If `Docker <https://docs.docker.com/install/>`_ is available on your system, you
2626
can visit `our page on Docker Hub <https://hub.docker.com/r/nipy/heudiconv/tags>`_
2727
to view available releases. To pull the latest release, run::
2828

29-
$ docker pull nipy/heudiconv:0.5.4
29+
$ docker pull nipy/heudiconv:0.6.0
3030

3131

3232
Singularity
@@ -35,4 +35,4 @@ If `Singularity <https://www.sylabs.io/singularity/>`_ is available on your syst
3535
you can use it to pull and convert our Docker images! For example, to pull and
3636
build the latest release, you can run::
3737

38-
$ singularity pull docker://nipy/heudiconv:0.5.4
38+
$ singularity pull docker://nipy/heudiconv:0.6.0

0 commit comments

Comments
 (0)