Skip to content

Commit

Permalink
Added README.md. Added [compat] julia = "1.0".
Browse files Browse the repository at this point in the history
  • Loading branch information
StevenWhitaker committed Jul 1, 2019
1 parent 8398e02 commit 46de341
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ version = "0.1.0"
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
MAT = "23992714-dd62-5051-b70f-ba57cb901cac"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[compat]
julia = "1.0"
19 changes: 19 additions & 0 deletions README.md
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.

0 comments on commit 46de341

Please sign in to comment.