-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added README.md. Added [compat] julia = "1.0".
- Loading branch information
1 parent
8398e02
commit 46de341
Showing
2 changed files
with
22 additions
and
0 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
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 |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# BlochSim.jl | ||
This package provides functionality for simulating arbitrary MRI sequences. It | ||
includes support for (traditional) single-compartment Bloch simulations (using | ||
`Spin` objects) as well as multi-compartment Bloch-McConnell simulations (using | ||
`SpinMC` objects). | ||
|
||
## Examples | ||
See the examples given in the documentation for how to use the provided | ||
functions. To access the documentation for, e.g., `freeprecess`, simply type | ||
`?freeprecess` at the Julia REPL after loading the package. | ||
|
||
For examples of how to simulate full MRI sequences, see | ||
[src/sequences.jl](https://github.com/StevenWhitaker/BlochSim.jl/blob/master/src/sequences.jl). | ||
|
||
## Acknowledgement | ||
This package was developed based on [Brian Hargreaves' Bloch simulation | ||
tutorial](http://mrsrl.stanford.edu/~brian/bloch/). All tests for this package | ||
of the form `testX0x` (like `testA5b` or `testF3d`) are based on the | ||
corresponding section in the tutorial. |