Skip to content

Commit

Permalink
update readme and add sequence
Browse files Browse the repository at this point in the history
  • Loading branch information
aTrotier committed Nov 6, 2024
1 parent 14e3064 commit de21db6
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 1 deletion.
Binary file not shown.
Binary file not shown.
128 changes: 127 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,130 @@



Rawdata for tests are available here : https://zenodo.org/records/14046657


Rawdata for tests are available here : https://zenodo.org/records/14046657




---

| **Documentation** | **Paper** |
|:------------------------- |:--------------------------- |
| [![][docs-img]][docs-url] | [![][paper-img]][paper-url] |



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**).
The reconstruction is performed using MRIReco.jl

More information and examples are available in the article [![][paper-img]][paper-url] and in the [![][docs-img]][docs-url]

![](./docs/src/img/fig_explain.png)

## How to give credit

If you use this package please acknowledge us by citing : https://doi.org/10.1002/mrm.27438

Additionally, if you use the sequence available in the MR sequence folder, please contact us to sign the sequence transfer agreement : [email protected]

## Bruker sequence and protocol

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`. Source code is available in this private directory : https://github.com/aTrotier/a_MP2RAGE_CS_360

## Julia Installation

To use the code, we recommend downloading Julia version 1.10 with `juliaup`.

<details>
<summary>Windows</summary>

#### 1. Install juliaup
```
winget install julia -s msstore
```
#### 2. Add Julia 1.10.4
```
juliaup add 1.10.4
```
#### 3. Make 1.10.4 default
```
juliaup default 1.10.4
```

<!---#### Alternative
Alternatively you can download [this installer](https://julialang-s3.julialang.org/bin/winnt/x64/1.7/julia-1.9.3-win64.exe).--->

</details>


<details>
<summary>Mac</summary>

#### 1. Install juliaup
```
curl -fsSL https://install.julialang.org | sh
```
You may need to run `source ~/.bashrc` or `source ~/.bash_profile` or `source ~/.zshrc` if `juliaup` is not found after installation.

Alternatively, if `brew` is available on the system you can install juliaup with
```
brew install juliaup
```
#### 2. Add Julia 1.10.4
```
juliaup add 1.10.4
```
#### 3. Make 1.10.4 default
```
juliaup default 1.10.4
```

<!---#### Alternative
Alternatively you can download [this installer](https://julialang-s3.julialang.org/bin/mac/x64/1.7/julia-1.9.3-mac64.dmg)--->

</details>

<details>
<summary>Linux</summary>

#### 1. Install juliaup

```
curl -fsSL https://install.julialang.org | sh
```
You may need to run `source ~/.bashrc` or `source ~/.bash_profile` or `source ~/.zshrc` if `juliaup` is not found after installation.

Alternatively, use the AUR if you are on Arch Linux or `zypper` if you are on openSUSE Tumbleweed.
#### 2. Add Julia 1.10.4
```
juliaup add 1.10.4
```
#### 3. Make 1.10.4 default
```
juliaup default 1.10.4
```
</details>

## Package Installation

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

- launch julia with the command `julia`
- enter the Julia package manager by typing `]` in the REPL. (the REPL should turn in blue)
- if you want to activate an environment, type : `activate .` (otherwise the package will be installed in the global environment)
- In order to add our unregistered package, type `add https://github.com/CRMSB/SEQ_BRUKER_A_MP2RAGE_CS_360`
- if you want to use the package : `using SEQ_BRUKER_A_MP2RAGE_CS_360`

## How to use the package


## Version


[docs-img]: https://img.shields.io/badge/docs-latest%20release-blue.svg
[docs-url]: https://crmsb.github.io/SEQ_BRUKER_a_MP2RAGE_CS_360/dev/

[paper-img]: https://img.shields.io/badge/doi-10.1002/mrm.27438-blue.svg
[paper-url]: https://doi.org/10.1002/mrm.27438

0 comments on commit de21db6

Please sign in to comment.