Skip to content

Latest commit

 

History

History
308 lines (194 loc) · 10.6 KB

README.md

File metadata and controls

308 lines (194 loc) · 10.6 KB
Raw

coulomb2gmt -- v1.0-rc1.0

Bash scripts to plot coulomb output on GMT

License MIT

Author

  • Demitris G. Anastasiou

Decleration

The present project was developed during my doctoral dissertation, at the Laboratory of Higher Geodesy and Dionysos Sastellite Observatory, at the School of Rural & Surveying Engineering of National Technical University of Athens.

Features

  • Αuto-configure map lat-long from input files (.inp)

  • Plot Stress changes (Coulomb, Normal, Shear)

  • Plot cross section for stress changes and dilatation.

  • Plot all strain components (E**, Dilatation)

  • Overlay stress/strain on the top of topographic DEM.

  • Plot Fault geometry (Projection, Surface, Depth).

  • Plot GPS displacements observed and modeled.

  • Plot Fault and CMT databases and earhtquake distribution.

  • Add GMT timestamp logo and custom logo of your organization.

  • Adjust paper size to map and convert in different output formats (.jpg, .png, .eps, .pdf).

Requirements

  • GMT: The Generic Mappting Tools - GMT version > 5.1.1 . It is recommented to install it from source code.

    • for Ubuntu/Debian: if you use default package installation you have to install also libgmt-dev package

  • Coulomb 3: Coulomb 3, developed by USGS

  • python: required for some math calculations included in the main script.

Usage details

The main script is: coulomb2gmt.sh

run:

 ./coulomb2gmt.sh  <inputfile> <inputdata> | options

  • <inputfile>: name of input file used from Coulomb. Extention .inp not needed. Path to the directory of input files configured at default-param.

  • <inputdata>: Code name of input files include results of coulmb calculations. Input data files are:

Fault geometry files:

  • <inputdata>-gmt_fault_surface.dat: Source and receiver faults’ trace at surface.

  • <inputdata>-gmt_fault_map_proj.dat: Surface of source and receiver faults.

  • <inputdata>-gmt_fault_calc_dep.dat: Intersection of target depth with fault plane.

Stress change output files:

  • <inputdata>-coulomb_out.dat: Coulomb matrix data output.

  • <inputdata>-dcff.cou: Output of all stress components.

  • <inputdata>-dcff_section.cou: Output of all stress components in cross section.

  • <inputdata>-Cross_section.dat: Cross section parameters.

  • <inputdata>-Focal_mech_stress_output.csv:

Strain output files:

  • <inputdata>-Strain.cou: Data matrix of starin components.

Earthquakes, GPS, custom text files:

  • Earthquakes distribution: Earthquakes catalogue files. Structure is
line1: Header line
line2: Header line
line*: YEAR MONTH DAY    HH MM SS    LAT.   LONG.  DEPTH    MAGNITUDE  (10 fields)
  • Centroid Moment Tensors file: Structure of file is the old GMT format for CMT. Use # to comment lines.
line* :  lon  lat   d  str dip slip str dip slip magnt exp plon  plat  name (14 fields)
  • Custom text files: Use new gmt format for pstext. (GMT ver > 5.1 )
line* :lon lat font_size,font_type,font_color angle potision text
  • <inputdata>-gps.dist: GPS displacements.

All paths can be configured in the deafault-param file. Default the paths are where coulomb create by default each file.

Default parameters

Many parameters configured at default-param file. Read carefully guideline in comments

  1. Paths to general files (DEM, logo, faults)
  2. Paths to input file directories (.inp, .dat, .cou, .disp)
  3. ColorMaps Palette, frame variable.
  4. General variables.

General options

  • -r | --region: set custom region parameters. Structure -r minlon maxlon minlat maxlat prjscale

  • -t | --topography: plot topography using DEM file

  • -o | --output <filename>: set custom name of output file. Default is <inputdata>.

  • -cmt | --moment_tensor <file> : Plot Centroid Moment Tensors list of earthquakes.

  • -ed | --eq_distribution <file> : Plot earthquakes distribution. No classification.

  • -fl | --faults_db: Plot custom fault database catalogue.

  • -mt | --map_title "map title": Custom map title.

  • -ct | --custom_text <path to file> : Plot Custom text file.

  • -lg | --logo_gmt: Plot GMT logo and time stamp.

  • -lc | --logo_custom: Plot custom logo (image) of your organization.

  • -h | --help: Help menu.

  • -v | --version: Plot version.

  • -d | --debug: Enable Debug option.

Plot fault parameters

  • -fproj: Plot source and receiver faults' trace at surface.

  • -fsurf: Plot surface of source and receiver faults.

  • -fdep: Plot intersection of target depth with fault plane.

Plot stress

  • -cstress: Plot Coulomb Stress change.

  • -sstress: Plot Shear Stress change.

  • -nstress: Plot Normal Stress change.

  • -fcross: Plot cross section of stress change or dilatation.

Plot Strain components

  • -stre**: Where ** you can fill all strain components xx,yy,zz, yz, xz, xy.

  • -strdil: Plot dilatation (Exx + Eyy + Ezz )

Overlay Stress/strain on the top of DEM

-****+ot: use +ot after the main argument to overlay the raster output on the top of DEM. configure transparency in default-param file. Be careful transparency can printed only in JPEG, PNG and PDF outputs.

Plot gps velocities, observed and modeled

  • -dgpsho: Observed GPS horizontal displacements.

  • -dgpshm: Modeled horizontal displacements on GPS sites (Okada 1985).

  • -dgpsvo: Observed GPS vertical desplacements.

  • -dgpsvm: Modeled vertical displacements on GPS sites (Okada 1985).

Configure displacement scale in default-param file

Output formats

Default format is *.ps file. You can use the options bellow to convert to other format and adjust paper size to map size.

  • -outjpg : Adjust and convert to JPEG.

  • -outpng : Adjust and convert to PNG (transparent where nothing is plotted).

  • -outeps : Adjust and convert to EPS.

  • -outpdf : Adjust and convert to PDF.

Move and rename coulomb output files

An assistant script mvclbfiles.sh developed to move and rename all output files in specific directories on coulomb home directory.

You must first set CLB34_HOME variable the path to coulomb home directory, etc. $ export CLB34_HOME=${HOME}/coulomb34

Usage:

  • $ ./mvclsbfiles.sh -h | --help: print help message

  • $ ./mnclbfiles.sh -ch| --check_files: check which of coulomb files exist

  • $ ./mvclsbfiles.sh <inputdata>: rename and move files <inputdata> is the code as mentioned in the main script above.

Files, rename and move:

1. `coulomb_out.dat`  -> `/gmt_files/<inputdata>-coulomb_out.dat`

Fault geometry files

2. `gmt_fault_calc_dep.dat` -> `/gmt_files/<inputdata>-gmt_fault_calc_dep.dat`

3. `gmt_fault_map_proj.dat` ->  `/gmt_files/<inputdata>-gmt_fault_map_proj.dat`

4. `gmt_fault_surface.dat`  -> `/gmt_files/<inputdata>-gmt_fault_surface.dat`

GPS displacements

5. `/output_files/GPS_output.csv` -> ` /gps_data/<inputdata>-gps.disp`

Stress change files

6. `/output_files/Cross_section.dat` ->  `/output_files/<inputdata>-Cross_section.dat`

7. `/output_files/dcff.cou` ->  `/output_files/<inputdata>-dcff.cou`

8. `/output_files/dcff_section.cou` -> `/output_files/<inputdata>-dcff_section.cou`

9. `/output_files/dilatation_section.cou` -> `/output_files/<inputdata>-dilatation_section.cou`

10. `/output_files/Focal_mech_stress_output.csv` -> `/output_files/<inputdata>-Focal_mech_stress_output.csv`

Strain output files

11. `/output_files/Strain.cou` -> `/output_files/<inputdata>-Strain.cou`

Contributing

  1. Create an issue and describe your idea
  2. Fork it
  3. Create your feature branch (git checkout -b my-new-idea)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Publish the branch (git push origin my-new-idea)
  6. Create a new Pull Request
  7. Profit! ✅

For contributors

git structure

  • branch master/develop: stucture of main branch

    • bash scripts
      • coulomb2gmt.sh: main script
      • mvclbfiles.sh: assistant script, move and rename files
      • default-param: configure parameters
    • functions: bash functions called from main script
      • messages.sh: help function and ptint messages.
      • gen_func.sh: general functions.
      • clbplots.sh: functions for gmt plots
      • checknum.sh: check number function.
    • docs: MarkDown templates for issues, pull requests, contributions etc.

  • branch documents :

    • tutorial: reference and user guide, tex files.
    • examples: presentation of examples, tex/beamer files.

  • branch testcase: Include configured files for testing the script.

Simple guidances for coding

  • general
    • Use 80 characters long line.
    • Surround variables with {} and use "${}" in if case.
    • Use comments in coding.
  • gmt functions
    • Use -K -O -V${VRBLEVM} at the end of each function.
    • Create a function if a part of the script will be used more than two times.
    • Add printed comments and debug messages in the code.

ChangeLog

The history of releases can be viewed at ChangeLog

Acknowlegments

References