From 95d34de2b9c2d07dfb375641ef4c0afb21287657 Mon Sep 17 00:00:00 2001 From: Brandon Clayton <bclayton@usgs.gov> Date: Tue, 26 Sep 2023 10:22:59 -0600 Subject: [PATCH] add citation --- README.md | 9 +++++++-- geophys/README.md | 16 ++++++++++++---- matlab/README.md | 24 ++++++++++++++++++------ 3 files changed, 37 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 44ebc83..c1aff67 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,8 @@ Python requires all of the NCM databases: * MineralPhysicsDatabase.nc -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>) +These codes are part of an effort to produce a three dimensional national crustal mode +for use with seismic hazard studies. (<https://doi.org/10.5066/P9T96Q67>) ## Python @@ -36,10 +37,14 @@ See the [README](matlab/README.md) file in the [matlab](matlab) directory for ru ## 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 *Boyd, O.S., 2020, Calibration of the U.S. Geological Survey National Crustal Model: U.S. Geological Survey Open-File Report 2020–1052, 23 p., <https://doi.org/10.3133/ofr20201052>* + +**Suggested citation:** Boyd, O. S., Clayton, B. S., 2019, GeoPhys—Set of utilities is used +to extract geophysical information from the National Crustal Model: U.S. Geological Survey +software release, <https://doi.org/10.5066/P9NQ5LNU>, IP-116829, BAO Approval 02/24/20. diff --git a/geophys/README.md b/geophys/README.md index 2ec8a24..186e5ee 100644 --- a/geophys/README.md +++ b/geophys/README.md @@ -1,8 +1,16 @@ # GeoPhys Python routines  -This set of utilities is used to extract geophysical profiles from the NCM (Boyd, 2020). Running the code requires the NCM Calibration dataset (<https://doi.org/10.5066/P9GO3CP8>), NCM Geologic Framework databases (<https://doi.org/10.5066/P9SBQENM>), NCM thermal model, NCM_TemperatureGrids.nc (<https://doi.org/10.5066/P935DT1G>), and the NCM Petrologic and Mineral Physics database (<https://doi.org/10.5066/P9HN170G>). These codes and datasets 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>) - -Profiles can be returned from roughly -126 degrees to -100 degrees longitude and 22 to 53 degrees latitude. If the requested location is outside of the bounds of the NCM, a message to that effect will be returned. +This set of utilities is used to extract geophysical profiles from the NCM (Boyd, 2020). +Running the code requires the NCM Calibration dataset (<https://doi.org/10.5066/P9GO3CP8>), +NCM Geologic Framework databases (<https://doi.org/10.5066/P9SBQENM>), NCM thermal model, +NCM_TemperatureGrids.nc (<https://doi.org/10.5066/P935DT1G>), and the NCM Petrologic and +Mineral Physics database (<https://doi.org/10.5066/P9HN170G>). These codes and datasets +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>) + +Profiles can be returned from roughly -126 degrees to -100 degrees longitude and 22 to 53 degrees +latitude. If the requested location is outside of the bounds of the NCM, a message to that effect +will be returned. ## Prerequisites @@ -103,7 +111,7 @@ Please see or query the code for help. poetry run help ``` -Any questions regarding the code and data can be directed to olboyd@usgs.gov. +Any questions regarding the code and data can be directed to <olboyd@usgs.gov>. ## Development diff --git a/matlab/README.md b/matlab/README.md index 52fcd5f..ad0bded 100644 --- a/matlab/README.md +++ b/matlab/README.md @@ -1,12 +1,24 @@ # GeoPhys MATLAB routines  -This program is used to extract geophysical profiles from the NCM (Boyd, 2020). Running the code requires the NCM Calibration dataset (<https://doi.org/10.5066/P9GO3CP8>), NCM Geologic Framework databases (<https://doi.org/10.5066/P9SBQENM>), NCM thermal model, NCM_TemperatureGrids.nc (<https://doi.org/10.5066/P935DT1G>), and the NCM Petrologic and Mineral Physics database (<https://doi.org/10.5066/P9HN170G>). These codes and datasets 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>) - -Profiles can be returned from roughly -126 degrees to -100 degrees longitude and 22 to 53 degrees latitude. If the requested location is outside of the bounds of the NCM, a message to that effect will be returned. +This program is used to extract geophysical profiles from the NCM (Boyd, 2020). +Running the code requires the NCM Calibration dataset (<https://doi.org/10.5066/P9GO3CP8>), +NCM Geologic Framework databases (<https://doi.org/10.5066/P9SBQENM>), NCM thermal model, +NCM_TemperatureGrids.nc (<https://doi.org/10.5066/P935DT1G>), and the NCM Petrologic and +Mineral Physics database (<https://doi.org/10.5066/P9HN170G>). These codes and datasets +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>) + +Profiles can be returned from roughly -126 degrees to -100 degrees longitude and 22 to 53 +degrees latitude. If the requested location is outside of the bounds of the NCM, a message +to that effect will be returned. ## Installation -Within matlab, add to your path the location of the GeoPhys matlab scripts. The LoadNCMData.m script assumes that the databases (mentioned above) are installed in NCMBase/database where NCMBase is ../../(Location of LoadNCMData.m). For example, GeoPhys.m might be located in Path/NCM/GeoPhys/matlab. The database directory would then be in Path/NCM/database. LoadNCMData.m can be edited to allow for a different location of the database. +Within matlab, add to your path the location of the GeoPhys matlab scripts. The LoadNCMData.m +script assumes that the databases (mentioned above) are installed in NCMBase/database where +NCMBase is ../../(Location of LoadNCMData.m). For example, GeoPhys.m might be located in +Path/NCM/GeoPhys/matlab. The database directory would then be in Path/NCM/database. +LoadNCMData.m can be edited to allow for a different location of the database. ## Example @@ -16,9 +28,9 @@ See example.m for an example. Please see or query the code for help. -**matlab>> help GeoPhys** +### Matlab Help -Any questions regarding the code and data can be directed to olboyd@usgs.gov. +Any questions regarding the code and data can be directed to <olboyd@usgs.gov>. ## References -- GitLab