-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
27 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
name = "DECAES" | ||
uuid = "d84fb938-a666-558e-89d9-d531edc6724f" | ||
authors = ["Jonathan Doucette <[email protected]>"] | ||
version = "0.4.5" | ||
version = "0.5.0" | ||
|
||
[deps] | ||
ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
name = "DECAESApp" | ||
uuid = "d8797698-3039-405c-b3a8-98519dba00aa" | ||
authors = ["Jonathan Doucette <[email protected]>"] | ||
version = "0.4.5" | ||
version = "0.5.0" | ||
|
||
[deps] | ||
DECAES = "d84fb938-a666-558e-89d9-d531edc6724f" | ||
|
@@ -10,5 +10,5 @@ Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" | |
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" | ||
|
||
[compat] | ||
DECAES = "0.4.5" | ||
DECAES = "0.5.0" | ||
PackageCompiler = "2" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,24 +2,24 @@ | |
%DECAES (DE)composition and (C)omponent (A)nalysis of (E)xponential (S)ignals | ||
% Call out to the DECAES command line tool. The DECAES.jl Julia package will | ||
% be installed automatically, if necessary. | ||
% | ||
% | ||
% See the online documentation for more information on DECAES: | ||
% https://jondeuce.github.io/DECAES.jl/dev/ | ||
% | ||
% | ||
% See the mwiexamples github repository for myelin water imaging examples, | ||
% including sample data: | ||
% https://github.com/jondeuce/mwiexamples | ||
% | ||
% | ||
% If you use DECAES in your research, please cite our work: | ||
% https://doi.org/10.1016/j.zemedi.2020.04.001 | ||
% | ||
% | ||
% INPUTS: | ||
% Input argument syntax mimics that of the DECAES command line interface. | ||
% Arguments must be strings, numeric values, or arrays of numeric values. | ||
% For arrays, each element is treated as a separate input argument. | ||
% All arguments will be forwarded to DECAES, with the exception of the | ||
% following Matlab-specific flags: | ||
% | ||
% | ||
% --runtime: Path to Julia binary runtime. Defaults to 'julia'. | ||
% --threads: Number of computational threads for DECAES to use. | ||
% Defaults to 'auto', deferring to Julia to choose the optimal value. | ||
|
@@ -33,10 +33,10 @@ | |
% much friendlier interactive use. The Julia server will be killed | ||
% automatically when Matlab exits. Do not use this flag if DECAES | ||
% only needs to be run once. | ||
% | ||
% | ||
% OUTPUTS: | ||
% status: (optional) System call status; see SYSTEM for details | ||
% | ||
% | ||
% EXAMPLES: | ||
% Run DECAES multithreaded on 'image.nii.gz' using command syntax: | ||
% * We specify an output folder named 'results' using the '--output' | ||
|
@@ -52,16 +52,16 @@ | |
% parameter using the --Reg flag | ||
% * Lastly, we indicate that the regularization parameters should be | ||
% saved using the --SaveRegParam flag | ||
% | ||
% | ||
% decaes image.nii.gz --output results --mask image_mask.mat --T2map --T2part --TE 7e-3 --nT2 60 --T2Range 7e-3 2.0 --SPWin 7e-3 25e-3 --MPWin 25e-3 200.0e-3 --Reg lcurve --SaveRegParam | ||
% | ||
% | ||
% Run the same command using function syntax: | ||
% | ||
% | ||
% decaes('image.nii.gz', '--output', 'results', '--mask', 'image_mask.mat', '--T2map', '--T2part', '--TE', 7e-3, '--nT2', 60, '--T2Range', [7e-3, 2.0], '--SPWin', [7e-3, 25e-3], '--MPWin', [25e-3, 200.0e-3], '--Reg', 'lcurve', '--SaveRegParam') | ||
% | ||
% | ||
% Create a settings file called 'settings.txt' containing the settings | ||
% from the above example (note: only one value or flag per line): | ||
% | ||
% | ||
% image.nii.gz | ||
% --output | ||
% results | ||
|
@@ -85,14 +85,14 @@ | |
% --Reg | ||
% lcurve | ||
% --SaveRegParam | ||
% | ||
% | ||
% Run the example using the above settings file 'settings.txt' on a local Julia server: | ||
% | ||
% | ||
% decaes --server @settings.txt | ||
% | ||
% | ||
% Note the separation of the Matlab-specific flags from the DECAES settings file. | ||
% | ||
% This version of decaes.m was written for DECAES v0.4.5. | ||
% | ||
% This version of decaes.m was written for DECAES v0.5.0. | ||
% DECAES was written by Jonathan Doucette ([email protected]). | ||
% Original MATLAB implementation is by Thomas Prasloski ([email protected]). | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2aec6e8
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JuliaRegistrator register
2aec6e8
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Registration pull request created: JuliaRegistries/General/83731
After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.
This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via: