Docs

[paudetseis]

This PR addresses several issues (#15-21) from the JOSS review.

• References for elastic constants now point to the paper by Brownlee et al. (2017)
• Function elast.tri_tensor has been moved to the utils module in function set_tri_tensor
• Units of density in conversion to GPa (in the elast module) was clarified
• Documentation for utils.calc_ttime was extended
• README now includes Community contributions guidelines
• Documentation for run_plane was significantly extended with examples and figures
• JOSS paper typos have been fixed
• Added examples in the documentation for utils.run_plane that include generally anisotropic elastic tensors.

[codecov-io]

Codecov Report

Merging #22 into master will decrease coverage by 0.07%.
The diff coverage is 100%.

@@            Coverage Diff            @@
##           master     #22      +/-   ##
=========================================
- Coverage   56.27%   56.2%   -0.08%     
=========================================
  Files           9       9              
  Lines        1139    1137       -2     
=========================================
- Hits          641     639       -2     
  Misses        498     498

Impacted Files	Coverage Δ
telewavesim/elast.py	17.9% <ø> (-6.16%)	⬇️
telewavesim/utils.py	72.85% <100%> (+1.76%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c5312a9...3935dfe. Read the comment docs.