Skip to content

tianyining/PyRaysum

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Software for modeling ray-theoretical body-wave propagation

This program generates sets of ray-theoretical seismograms for an incident plane wave (teleseismic approximation) for models consisting of a stack of layers with planar but nonparallel (dipping) interfaces, allowing the possibility of anisotropy in the layers. Incident P and S waves are supported.

Although a trimmed down version of the original Fortran code is supplied with PyRaysum, you can find the original version here.

Dependencies

PyRaysum requires a modern Fortran compiler (e.g., gfortran, ifort). In addition, the following packages are required:

Installing

Documentation for PyRaysum is in development and this Readme file provides minimal guidance on how to install and run the code. To install PyRaysum using conda, you can first create a conda environment and install the dependencies at the same time:

conda create -n prs python=3.8 obspy pandas fortran-compiler -c conda-forge
conda activate prs

Then clone and install PyRaysum using pip:

git clone https://github.com/paudetseis/PyRaysum.git
cd PyRaysum
pip install .

After PyRaysum is installed, you need to compile and install the Raysum binaries by running the provided install-raysum script. Check out the helper page for the available options:

install-raysum -h

Running the script without arguments will attempt to install Raysum to default paths and fortran compiler (these are contained in the $PATH and $FC environment variables). If you installed PyRaysum using conda (and the fortran-compiler package), you can safely ignore the options and run the script without any options. To call the script with options (which take precedence over any default conda environment variables), you would specify:

install-raysum --path=/path/to/binaries/bin --fcompiler=gfortran

Note that the --path option requires the full, absolute path. If you specify a path in one of the root directories, you may have to run install-raysum with super-user privileges, for example:

sudo install-raysym --path=/usr/bin

Notebooks

There is currently one notebook bundled with PyRaysum, which reproduces some published examples in Porter et al., 2011. To download it locally and run it, first install jupyter:

conda install jupyter

Then open a Python window and type:

from pyraysum import doc
doc.install_doc(path='Notebooks')

which will install the notebook locally in the folder 'Notebooks'. Then you simply open a jupyter notebook and navigate to the Notebook folder and open the corresponding file.

Citing

If you use PyRaysum in your work, please cite the Zenodo DOI (not yet available) and the following paper:

  • Frederiksen, A.W., and Bostock, M.G. (1999) Modelling teleseismic waves in dipping anisotropic structures. Geophysical Journal International 141: 401-412.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Fortran 46.8%
  • Jupyter Notebook 34.4%
  • Python 17.8%
  • Other 1.0%