-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathREADME
65 lines (43 loc) · 2.75 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Project: Vespa
Contact: Brian J. Soher
Email: [email protected]
Licence: BSD, specifically a "three-clause" BSD license
For the most up-to-date information regarding installation, usage,
technical details, and the complete list of developers see the Pages at:
https://vespa-mrs.github.io/vespa.io
#----------------------------------------------------------------------------#
DESCRIPTION:
Vespa stands for Versatile Simulation, Pulses, and Analysis. It is an
integrated, open source, open development platform that contains four magnetic
resonance spectroscopy (MRS) software applications, written in Python, called:
Pulse - RF pulse design
Simulation - spectral simulation and prototyping
DataSim - application for creating synthetic MRS data sets
Analysis - spectral data processing and analysis
The Vespa project addresses previous software limitations, of non-standard data
access, closed source and multiple language software that complicates algorithm
extension, and a lack of integration between programs by porting all the code
to Python, and using a shared database design, with high-quality documentation.
These applications can be run separately, but can also communicate via a shared
database of objects/results. Integration allows one application to use the
output from another as input. For example, Simulation can make use of an RF
pulse designed in Pulse to create a more realistic MR simulation.
#----------------------------------------------------------------------------#
CITATION
If you publish material that makes use of Vespa, please cite the following publication:
Soher B, Semanchuk P, Todd D, Ji X, Deelchand D, Joers J, Oz G and Young K. Vespa: Integrated applications for RF pulse design, spectral simulation and MRS data analysis. Magn Reson Med. 2023;1-16. epub doi: 10.1002/mrm.29686
#----------------------------------------------------------------------------#
HISTORY
The Vespa package is an extensive redesign of three previous MRS software tools:
MatPulse (Pulse) - software for RF pulse design written in Matlab,
GAVA/Gamma (Simulation) - software for spectral simulation code in IDL
IDL_Vespa (Analysis) - spectral data processing and analysis code in IDL
Thanks to the NIH (grant number 1R01EB008387-01A1) for funding the maintenance
and extension of these separate applications into a combined environment based
entirely on the Python language.
#----------------------------------------------------------------------------#
COMPATIBILITY:
Vespa has been tested and is certified to run on the following systems:
Windows, Macintosh OSX, and Linux.
However, it should run on any system that supports python 3.x and wxpython.
#----------------------------------------------------------------------------#