API Overview
KomaMRI is divided into the following sub-packages:
- KomaMRIBase: Custom types and functions
- KomaMRICore: Simulation functions
- KomaMRIFiles: File I/O functions
- KomaMRIPlots: Plotting functions
- KomaMRI: User Interface
The idea of separating the package into sub-packages is to make it easier to maintain and to allow users to use only the parts they need. Two common use-cases can be:
- GUI users: They will use the
KomaMRI
package to interact with the GUI. Internally this includes al the others. - Advanced users: They will use the sub-packages directly to build their own scripts or notebooks, for simulation only
KomaMRICore
is required.