-
Notifications
You must be signed in to change notification settings - Fork 0
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
4 changed files
with
27 additions
and
19 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,25 +2,24 @@ | |
|
||
[](https://github.com/Tinggong/Microstructure.jl/actions/workflows/CI.yml?query=branch%3Amain) | ||
|
||
Microstructure.jl is a Julia toolbox aiming at fast and probabilistic microstructure imaging. It features flexible and extendable compartment modelling with diffusion MRI and combined diffusion-relaxometry MRI. Microstructure.jl is currently under testing and optimization. If you have any questions using it, please email me at [email protected]. | ||
Microstructure.jl is a Julia toolbox designed for fast and probabilistic microstructure imaging. It offers flexible and extendable compartment modeling with diffusion MRI and combined diffusion-relaxometry MRI. The toolbox includes generic estimators such as Markov Chain Monte Carlo (MCMC) sampling methods and Monte Carlo dropout with neural networks. Microstructure.jl is currently undergoing testing and optimization. If you have any questions or encounter any issues while using it, please feel free to email me at [email protected]. | ||
|
||
## Installation | ||
To install Microstructure.jl and keep up to date, you can use the repository link. Type ] in Julia to enter package mode and add the link: | ||
To install Microstructure.jl, open Julia and enter the package mode by typing `]`, then add the package: | ||
|
||
```julia | ||
julia> ] | ||
(@v1.8) pkg> add https://github.com/Tinggong/Microstructure.jl.git | ||
(@v1.8) pkg> add Microstructrue | ||
``` | ||
|
||
Once package registry is approved, you will be able to install it by using the package name: | ||
Microstructure.jl is under active development and is frequently updated. To ensure you have the latest version, use the following command in the package mode: | ||
|
||
```julia | ||
(@v1.8) pkg> add Microstructrue | ||
(@v1.8) pkg> up Microstructrue | ||
``` | ||
|
||
## Usage | ||
Documentation demonstrating different features of the package can be found on the [documentation website](https://tinggong.github.io/Microstructure.jl/dev/) | ||
The documentation website is under construction and will be frequently updated. | ||
## Usage | ||
Documentation demonstrating various features of the package can be found on the [documentation website](https://tinggong.github.io/Microstructure.jl/dev/). Please note that the documentation website is currently under construction and will be frequently updated. | ||
|
||
## Relationship to Other Packages | ||
Microstructure.jl focuses on tissue microstructure estimation. If you are also interested in fiber orientation and tractography, please check out FreeSurfer.jl. Microstructure.jl also uses I/O functions from FreeSurfer.jl for reading and writing NIfTI image files. | ||
Microstructure.jl focuses on tissue microstructure estimation. If you are also interested in fiber orientation and tractography, consider exploring FreeSurfer.jl. Additional, Microstructure.jl uses I/O functions from FreeSurfer.jl for reading and writing NIfTI image files. |
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
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,3 +1,13 @@ | ||
# Multi threads | ||
|
||
Constructing... | ||
### Start julia in terminal with multi-threads | ||
```terminal | ||
~ % julia --threads auto | ||
``` | ||
You can also set enviornment variable by adding `export JULIA_NUM_THREADS=auto` in your bash profile, which will use multi-threads automatically when you start julia. | ||
|
||
### Multi-threads for MCMC estimation | ||
|
||
```@docs | ||
threading | ||
``` |
3fadf31
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
Release notes:
3fadf31
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/105249
Tagging
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: