Skip to content

Commit d84012a

Browse files
committed
update doc
1 parent 63b1ef2 commit d84012a

File tree

3 files changed

+20
-24
lines changed

3 files changed

+20
-24
lines changed

docs/src/index.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,25 @@ CurrentModule = SEQ_BRUKER_a_MP2RAGE_CS_360
44

55
# SEQ\_BRUKER\_A\_MP2RAGE\_CS\_360
66

7-
SEQ_BRUKER_a_MP2RAGE_CS_360.jl is a Julia package that implements a reconstruction for an accelerated MP2RAGE sequence for Bruker scanner (**PV360-3.5**).
7+
SEQ\_BRUKER\_a\_MP2RAGE\_CS\_360.jl is a Julia package that implements a reconstruction for an accelerated MP2RAGE sequence for Bruker scanner (**PV360-3.5**).
88
The reconstruction is performed using MRIReco.jl
99

10-
More information and examples are available in the article [![][paper-img]][paper-url] and in the [![][docs-img]][docs-url]
10+
More information and examples are available in the initial [article](https://img.shields.io/badge/doi-10.1002/mrm.27438-blue.svg)
1111

12-
## How to give credit
12+
## Raw datasets
1313

14-
If you use this package please acknowledge us by citing : https://doi.org/10.1002/mrm.27438
14+
The rawdata used in the example are stored on zenodo : https://zenodo.org/records/14046657
15+
- One is a fully sampled acquisition (128x128x96)
16+
- The other one is accelerated by a factor of 2
17+
```
18+
##$PVM_EncCSUndersampling=50
19+
##$PVM_EncCSCenterRatio=5
20+
```
1521

16-
Additionally, if you use the sequence available in the MR sequence folder, please contact us to sign the sequence transfer agreement : aurelien.trotier@rmsb.u-bordeaux.fr
22+
They are used for each merge to generate the figures used in examples.
1723

24+
## How to give credit
1825

19-
[docs-img]: https://img.shields.io/badge/docs-latest%20release-blue.svg
20-
[docs-url]: https://crmsb.github.io/SEQ_BRUKER_a_MP2RAGE_CS_360/dev/
26+
If you use this package please acknowledge us by citing : https://doi.org/10.1002/mrm.27438
2127

22-
[paper-img]: https://img.shields.io/badge/doi-10.1002/mrm.27438-blue.svg
23-
[paper-url]: https://doi.org/10.1002/mrm.27438
28+
Additionally, if you use the sequence available in the MR sequence folder, please contact us to sign the sequence transfer agreement : aurelien.trotier@rmsb.u-bordeaux.fr

docs/src/reconstruction.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11

2-
# Package Installation
2+
# Installation and usage
3+
4+
## Package Installation
35

46
You can install the package in any project with the following command :
57

@@ -10,7 +12,7 @@ You can install the package in any project with the following command :
1012
- if you want to use the package in your script just add the following line : `using SEQ_BRUKER_a_MP2RAGE_CS_360`
1113

1214

13-
# How to use the package
15+
## How to use the package
1416

1517
Follow the example in the [documentation](https://crmsb.github.io/SEQ_BRUKER_a_MP2RAGE_CS_360/dev/generated/examples/simple_reco/)
1618

docs/src/sequence.md

+2-13
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Bruker sequence and protocol
1+
# Sequence and protocols
22

33
The sequence, implemented for **Bruker Paravision PV-360.3.5**, and the corresponding protocol for fully-sampled is available in the folder `MR sequence/PV-360.3.5`.
44

@@ -12,16 +12,5 @@ Compressed-sensing implementation is available through the standard Bruker tab `
1212

1313
## Source code
1414

15-
Source code is available in this private directory : https://github.com/aTrotier/a_MP2RAGE_CS_360
15+
Source code is available in this private directory : [https://github.com/aTrotier/a\_MP2RAGE\_CS\_360](https://github.com/aTrotier/a_MP2RAGE_CS_360)
1616

17-
# Raw datasets
18-
19-
The rawdata used in the example are stored on zenodo : https://zenodo.org/records/14046657
20-
- One is a fully sampled acquisition (128x128x96)
21-
- The other one is accelerated by a factor of 2
22-
```
23-
##$PVM_EncCSUndersampling=50
24-
##$PVM_EncCSCenterRatio=5
25-
```
26-
27-
They are used for each merge to generate the figures used in examples.

0 commit comments

Comments
 (0)