diff --git a/README.md b/README.md index acd2f3d..2ad892f 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,24 @@ [![Build Status](https://github.com/Tinggong/Microstructure.jl/actions/workflows/CI.yml/badge.svg?branch=main)](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 tgong1@mgh.harvard.edu. +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 tgong1@mgh.harvard.edu. ## 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. \ No newline at end of file diff --git a/docs/src/getting_started.md b/docs/src/getting_started.md index 3046838..f9de993 100644 --- a/docs/src/getting_started.md +++ b/docs/src/getting_started.md @@ -1,6 +1,6 @@ # What is microstructure imaging? -Microstructure imaging allows us to estimate biologically meaningful cellular parameters from MRI data. This is achieved through simplifying the tissue in a voxel as multiple compartments representing different cellular structures, e.g. neurites and cell bodies etc. Each tissue compartment has unique features in determine the MR signals under a measurement protocol, and therefore can be estimated by solving an inverse problem. +Microstructure imaging allows us to estimate biologically meaningful cellular parameters from MRI data. This is achieved through simplifying the tissue in a voxel as multiple compartments representing different cellular structures, e.g. axons and cell bodies etc. Each tissue compartment has unique features in determine the MR signals under a measurement protocol, and therefore can be estimated by solving an inverse problem. ## Minimal steps Here includes the minimal steps for you to get started with your MRI dataset. Visit tutorial and manual pages for more feature demonstrations. diff --git a/docs/src/index.md b/docs/src/index.md index 9f75df4..7d46966 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -3,25 +3,24 @@ Microstructure.jl is a Julia toolbox aiming at fast and probabilistic microstructure imaging. It supports flexible and extendable compartment modelling with diffusion MRI and combined diffusion-relaxometry MRI. ## Installation -To install Microstructure.jl, type ] in Julia to enter package mode and add the package +To install Microstructure.jl, type ] in Julia to enter package mode and add the package: ```julia julia> ] (@v1.8) pkg> add Microstructrue ``` -or use github link to keep up to date: +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 https://github.com/Tinggong/Microstructure.jl.git +(@v1.8) pkg> up Microstructrue ``` ## Feature Summary -- combined diffusion-relaxometry compartment modelling -- flexible in creating models and adjusting assumptions -- generic mcmc estimator -- parallel computing -- quality checking +- Combined diffusion-relaxometry compartment modelling +- Flexible in creating models and adjusting assumptions +- Generic MCMC and neural network estimators +- Parallel computing ## 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 mri image files. diff --git a/docs/src/manual/multithreads.md b/docs/src/manual/multithreads.md index 6d0eb38..affcb0e 100644 --- a/docs/src/manual/multithreads.md +++ b/docs/src/manual/multithreads.md @@ -1,3 +1,13 @@ # Multi threads -Constructing... \ No newline at end of file +### 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 +``` \ No newline at end of file