Skip to content

Commit

Permalink
correct filename
Browse files Browse the repository at this point in the history
  • Loading branch information
aTrotier committed Feb 12, 2024
1 parent 465d927 commit 367c590
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Those steps are described in their dedicated sections.

# Example

Reproduction of figure 8 can be performed at this link : https://atrotier.github.io/PAPER_subspace_MESE/dev/generated/examples/subspace_julia_epg/
Reproduction of figure 8 can be performed at this [link](https://atrotier.github.io/PAPER_subspace_MESE/dev/generated/examples/subspace_julia_epg/)
30 changes: 30 additions & 0 deletions docs/src/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Unregistered 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/aTrotier/PAPER_subspace_MESE`
- if you want to use the package : `using Subspace_MESE`


## Reproducing figure 8

In order to reproduce figure 8, you need to :
- compile the BART toolbox : https://mrirecon.github.io/bart/ (you can skip this step if you don't want to plot the BART reconstruction). After compilation/installation you can check the library path with `which bart`
- download the dataset : https://zenodo.org/records/10610639 and extract the zip file.
- download the current repository : `git clone https://github.com/aTrotier/PAPER_subspace_MESE`
- Open a terminal and move to the docs folder in this repository
- edit the script in `docs/lit/example/subspace_julia_epg.jl` and put the correct path in the variable
- line 27 : `path_raw` should point to the bruker folder `10`
- line 30 : `path_bart` should point to the compiled bart library
- launch julia in the docs folder with this command in the terminal: `julia --project -t auto`
- run the literate example :
```julia
using Pkg
Pkg.add(url="https://github.com/aTrotier/PAPER_subspace_MESE")
Pkg.instantiate()
include("lit/examples/subspace_julia_epg.jl")
```
The figure will be saved as `fig_bart_julia.png` in the `docs` folder.

0 comments on commit 367c590

Please sign in to comment.