https://github.com/malcolmw/pykonal
Travel-time calculator based on the fast-marching method solution to the Eikonal equation.
https://github.com/malcolmw/pykonal
Last synced: 3 months ago
JSON representation
Travel-time calculator based on the fast-marching method solution to the Eikonal equation.
- Host: GitHub
- URL: https://github.com/malcolmw/pykonal
- Owner: malcolmw
- License: gpl-3.0
- Created: 2017-09-23T05:14:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-10T16:52:25.000Z (about 1 year ago)
- Last Synced: 2024-04-24T17:10:14.321Z (12 months ago)
- Language: Jupyter Notebook
- Homepage: https://malcolmw.github.io/pykonal-docs/
- Size: 25.5 MB
- Stars: 143
- Watchers: 8
- Forks: 54
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-seismology - pykonal - Fast Marching Method in cartesian or spherical coordinates in 2 or 3 dimensions.  (Raytracing)
README
# Welcome to the *pykonal* repository!
This code implements the Fast Marching Method (FMM; Sethian *et al.*, 1996) for solving the eikonal equation in Cartesian or spherical coordinates in 2 or 3 dimensions. The method implements mixed first- and second-order finite differences.
PyKonal offers two features that are absent from the comparable [scikit-fmm](https://pythonhosted.org/scikit-fmm/ "sckit-fmm documentation") package: (a) an implementation in spherical coordinates, and (b) functionality to compute shortest-traveltime paths.
## Documentation
Documentation is available [here](https://malcolmw.github.io/pykonal-docs/ "PyKonal documentation").
## Citation
If you make use of this code in published work, please cite White *et al.* (2020).
## Installation
### PIP—recommended
```bash
sh$> pip install pykonal
```
### From source code
Download and unzip the [latest release](https://github.com/malcolmw/pykonal/releases "Releases").
```bash
sh$> cd path/to/pykonal
sh$> pip install .
```
## Bugs
Please report bugs, feature requests, and questions through the [Issues](https://github.com/malcolmw/pykonal/issues "PyKonal Issues tracker") tracker.
## References
1. Sethian, J. A. (1996). A fast marching level set method for monotonically advancing fronts. *Proceedings of the National Academy of Sciences, 93*(4), 1591–1595. https://doi.org/10.1073/pnas.93.4.1591
2. White, M. C. A., Fang, H., Nakata, N., & Ben-Zion, Y. (2020). PyKonal: A Python Package for Solving the Eikonal Equation in Spherical and Cartesian Coordinates Using the Fast Marching Method. *Seismological Research Letters, 91*(4), 2378-2389. https://doi.org/10.1785/0220190318