Matlab Seismic Anisotropy Toolbox
=================================

This user guide is incomplete and will be updated soon. A full list of the MSAT functions (with links to more information) is below.

MSAT function tables
--------------------

.MSAT Input / generation of elastic constants. 
[width="80%",cols="3,10",frame="topbot",options="header"]
|======================
|Function|Purpose
| link:funcs/MS_VTI.html[MS_VTI]                                     | Generate elastic constants for a vertically transverse isotropic medium from Thomsen parameters. Symmetry is in the 3-axis. 
| link:funcs/MS_VTI2.html[MS_VTI2]                                   | Generate elastic constants for a vertically transverse isotropic medium from xi, phi, eta parameters. Symmetry is in the 3-axis. 
| link:funcs/MS_build_isotropic.html[MS_build_isotropic]             | Create elasticity matrix from pairs of isotropic moduli.
| link:funcs/MS_checkC.html[MS_checkC]                               | Check consistency of a stiffness matrix against various criteria
| link:funcs/MS_effective_medium.html[MS_effective_medium]           | Generate elastic constants from various effective medium theories. 
| link:funcs/MS_elasticDB.html[MS_elasticDB]                         | Database of various elastic constants..
| link:funcs/MS_expand.html[MS_expand]                               | Fill out elasticity matrix.
| link:funcs/MS_iso.html[MS_iso]                                     | Generate elastic matrix from isotropic velocities.
| link:funcs/MS_load.html[MS_load]                                   | Load a set of elastic constants from a file.
| link:funcs/MS_load_list.html[MS_load_list]                         | Load a list of CIJs, in a specific format
|======================                                                
                                                                       
.MSAT Manipulation / transformation                                    
[width="80%",cols="3,10",frame="topbot",options="header"]              
|======================                                                
|Function|Purpose                                                      
| link:funcs/MS_VRH.html[MS_VRH]                                     | N phase Voigt-Reuss-Hill average of elasticity.
| link:funcs/MS_axes.html[MS_axes]                                   | Reorient elasticity matrix for optimal decomposition.
| link:funcs/MS_decomp.html[MS_decomp]                               | Browaeys and Chevrot decomposition of the elasticity matrix.
| link:funcs/MS_interpolate.html[MS_interpolate]                     | Symmetry preserving elasticity interpolation 
| link:funcs/MS_norms.html[MS_norms]                                 | Browaeys and Chevrot analysis of the elasticity matrix.
| link:funcs/MS_polyaverage.html[MS_polyaverage]                     | Isotropic elasticity for polycrystal 
| link:funcs/MS_rot3.html[MS_rot3]                                   | Elasticity matrix rotation.
| link:funcs/MS_rotEuler.html[MS_rotEuler]                           | Rotate an elasticity matrix using Bunge's Euler angles.
| link:funcs/MS_rotR.html[MS_rotR]                                   | Script to rotate a set of elastic constants by a rotation matrix
|======================                                                
                                                                       
.MSAT Analysis                                                         
[width="80%",cols="3,10",frame="topbot",options="header"]              
|======================                                                
|Function|Purpose                                                      
| link:funcs/MS_anisotropy.html[MS_anisotropy]                       | Simple measures of anisotropy 
| link:funcs/MS_info.html[MS_info]                                   | Information about an elasticity matrix.
| link:funcs/MS_phasevels.html[MS_phasevels]                         | Wave velocities in anisotropic media.
| link:funcs/MS_plot.html[MS_plot]                                   | Plot phasevels/anisotropy on pole figures.
| link:funcs/MS_poisson.html[MS_poisson]                             | Poisson's ratio in anisotropic media.
|======================                                                
                                                                       
.MSAT Visualisation                                                    
[width="80%",cols="3,10",frame="topbot",options="header"]              
|======================                                                
|Function|Purpose                                                      
| link:funcs/MS_plot.html[MS_plot]                                   | Plot phasevels/anisotropy on pole figures.
| link:funcs/MS_sphere.html[MS_sphere]                               | Plot a spherical plot of phasevels/anisotropy from a set of elastic constants.
|======================                                                
                                                                       
.MSAT Miscellaneous / utility                                          
[width="80%",cols="3,10",frame="topbot",options="header"]              
|======================                                                
|Function|Purpose                                                      
| link:funcs/MS_Vrot3.html[MS_Vrot3]                                 | Rotate a (set of) 3-vector(s) by 3 angles.
| link:funcs/MS_cij2cijkl.html[MS_cij2cijkl]                         | Convert from Voigt elasticity matrix to tensor
| link:funcs/MS_cijkl2cij.html[MS_cijkl2cij]                         | Convert from elastic tensor to Voigt elasticity matrix
| link:funcs/MS_list.html[MS_list]                                   | Print elasticity matrix (in 'list' format)
| link:funcs/MS_rotM.html[MS_rotM]                                   | Create a cartesian rotation matrix.
| link:funcs/MS_unwind_pm_90.html[MS_unwind_pm_90]                   | Unwind an angle until it is between 0 and 360 degrees
|======================
