diff --git a/README.md b/README.md index 8975ff9504c9dacd9fb39fda092971ed7b25f0f2..3c971a1552a2216a7f65fa6c1f9385bee59c9316 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,43 @@ # MinVel  + This program is used to calculate anharmonic p- and s-wave velocity and density for zero-porosity -mineral aggregates. It is based on the work of Hacker and Abers (2004, updated in 2016) with -additional minerals and optimized for related work. Running the code in either MATLAB or Python -requires a mineral physics database, MineralPhysicsDatabase.nc. Combined with a petrologic -database (Sowers and Boyd, 2019) and thermal and geologic models, results from this code are -used in the program RockProp.m, which accounts for rock porosity and seismic attenuation. -These codes are part of an effort to produce a three dimensional national crustal model -for use with seismic hazard studies (https://doi.org/10.5066/P9T96Q67). +mineral aggregates. It is based on the work of Hacker and Abers (2004, updated in 2016) with +additional minerals and optimized for related work. Running the code in either MATLAB or Python +requires a mineral physics database, MineralPhysicsDatabase.nc. Combined with a petrologic +database (Sowers and Boyd, 2019) and thermal and geologic models, results from this code are +used in the program RockProp.m, which accounts for rock porosity and seismic attenuation. +These codes are part of an effort to produce a three dimensional national crustal model +for use with seismic hazard studies (<https://doi.org/10.5066/P9T96Q67>). ## Python + See the [README](minvel/README.md) file in the [minvel](minvel) directory for instructions on installing the mineral velocity database and running in Python. ## Matlab + See the [README](matlab/README.md) file in the [matlab](matlab) directory for running the in MATLAB. ## Help -Any questions regarding the code can be directed to olboyd@usgs.gov. + +Any questions regarding the code can be directed to <olboyd@usgs.gov>. ## References -*Abers, G.A., and Hacker, B.R., 2016, A MATLAB toolbox and Excel workbook for calculating + +*Abers, G.A., and Hacker, B.R., 2016, A MATLAB toolbox and Excel workbook for calculating the densities, seismic wave speeds, and major element composition of minerals and rocks at pressure and temperature: Geochem. Geophys. Geosys., v. 16, p. 616–624.* -*Hacker, B.R., and Abers, G.A., 2004, Subduction Factory 3: An Excel worksheet and macro -for calculating the densities, seismic wave speeds, and H2O contents of minerals and rocks +*Hacker, B.R., and Abers, G.A., 2004, Subduction Factory 3: An Excel worksheet and macro +for calculating the densities, seismic wave speeds, and H2O contents of minerals and rocks at pressure and temperature: Geochem. Geophys. Geosys., v. 5, no. Q01005.* -*Sowers, T., and Boyd, O.S., 2019, Petrologic and mineral physics database for use with -the U.S. Geological Survey National Crustal Model: U.S. Geological Survey Open-File Report -2019–1035, 17 p., https://doi.org/10.3133/ofr20191035.* +*Sowers, T., and Boyd, O.S., 2019, Petrologic and mineral physics database for use with +the U.S. Geological Survey National Crustal Model: U.S. Geological Survey Open-File Report +2019–1035, 17 p., <https://doi.org/10.3133/ofr20191035>.* + +**Suggested citation:** Boyd, O. S., Clayton, B. S., 2019, MinVel—Program to calculate +anharmonic P- and S-wave velocity and density for zero-porosity mineral aggregates: U.S. +Geological Survey software release, <https://doi.org/10.5066/P9FK25WM>, IP-111290, +BAO Approval 08/20/19. diff --git a/matlab/README.md b/matlab/README.md index 328f53d4b4f72555e31b35b31ac10837d5a7467a..63c87d0579afe73a4bb4f83f3e78f0d768eb2f4b 100644 --- a/matlab/README.md +++ b/matlab/README.md @@ -1,10 +1,20 @@ # MinVel MATLAB routine  -This program is used to calculate anharmonic p- and s-wave velocity and density for zero-porosity mineral aggregates. It is based on the work of Hacker and Abers (2004, updated in 2016) with additional minerals and optimized for related work. Running the code requires a mineral physics database, MineralPhysicsDatabase.nc. Combined with a petrologic database (Sowers and Boyd, 2019) and thermal and geologic models, results from this code are used as part of an effort to produce a three dimensional national crustal model for use with seismic hazard studies (<https://doi.org/10.5066/P9T96Q67>). +This program is used to calculate anharmonic p- and s-wave velocity and density for zero-porosity +mineral aggregates. It is based on the work of Hacker and Abers (2004, updated in 2016) with +additional minerals and optimized for related work. Running the code requires a mineral physics +database, MineralPhysicsDatabase.nc. Combined with a petrologic database (Sowers and Boyd, 2019) +and thermal and geologic models, results from this code are used as part of an effort to produce +a three dimensional national crustal model for use with seismic hazard studies +(<https://doi.org/10.5066/P9T96Q67>). ## Installation -Within matlab, add to your path the location of the MinVel matlab scripts. MinVel.m assumes that the database (mentioned above) is installed in NCMBase/database where NCMBase is ../../(Location of MinVel.m). For example, MinVel.m might be located in Path/NCM/MinVel/matlab. The database directory would then be in Path/NCM/database. MinVel.m can be edited to allow for a different location of the database. +Within matlab, add to your path the location of the MinVel matlab scripts. MinVel.m assumes +that the database (mentioned above) is installed in NCMBase/database where NCMBase +is ../../(Location of MinVel.m). For example, MinVel.m might be located in Path/NCM/MinVel/matlab. +The database directory would then be in Path/NCM/database. MinVel.m can be edited to allow for a +different location of the database. ## Example @@ -14,14 +24,20 @@ See example.m for an example. Please see or query the code for help. -**matlab>> help MinVel** +### Matlab Help -Any questions regarding the code can be directed to olboyd@usgs.gov. +Any questions regarding the code can be directed to <olboyd@usgs.gov>. -# References +## References -*Abers, G.A., and Hacker, B.R., 2016, A MATLAB toolbox and Excel workbook for calculating the densities, seismic wave speeds, and major element composition of minerals and rocks at pressure and temperature: Geochem. Geophys. Geosys., v. 16, p. 616–624.* +*Abers, G.A., and Hacker, B.R., 2016, A MATLAB toolbox and Excel workbook for calculating the +densities, seismic wave speeds, and major element composition of minerals and rocks at pressure +and temperature: Geochem. Geophys. Geosys., v. 16, p. 616–624.* -*Hacker, B.R., and Abers, G.A., 2004, Subduction Factory 3: An Excel worksheet and macro for calculating the densities, seismic wave speeds, and H2O contents of minerals and rocks at pressure and temperature: Geochem. Geophys. Geosys., v. 5, no. Q01005.* +*Hacker, B.R., and Abers, G.A., 2004, Subduction Factory 3: An Excel worksheet and macro +for calculating the densities, seismic wave speeds, and H2O contents of minerals and rocks at +pressure and temperature: Geochem. Geophys. Geosys., v. 5, no. Q01005.* -*Sowers, T., and Boyd, O.S., 2019, Petrologic and mineral physics database for use with the U.S. Geological Survey National Crustal Model: U.S. Geological Survey Open-File Report 2019–1035, 17 p., <https://doi.org/10.3133/ofr20191035>.* +*Sowers, T., and Boyd, O.S., 2019, Petrologic and mineral physics database for use with the U.S. +Geological Survey National Crustal Model: U.S. Geological Survey Open-File Report 2019–1035, +17 p., <https://doi.org/10.3133/ofr20191035>.* diff --git a/minvel/README.md b/minvel/README.md index 0f658ea13693dec8c0898653b9b2fd37396c2115..648de7d3e700e8a042d656f066953a44b1be2c88 100644 --- a/minvel/README.md +++ b/minvel/README.md @@ -11,7 +11,7 @@ hazard studies (<https://doi.org/10.5066/P9T96Q67>). ## Prerequisites -* [Python](https://www.python.org/downloads/) 3.6+ +* [Python](https://www.python.org/downloads/) 3.8+ * [Poetry](https://python-poetry.org/) Python dependency manager ### Poetry Install @@ -106,7 +106,7 @@ Please see or query the code for help. poetry run help ``` -Any questions regarding the code can be directed to olboyd@usgs.gov. +Any questions regarding the code can be directed to <olboyd@usgs.gov>. ## Development