This project is maintained by Marco A. Lopez-Sanchez - Last update: 2025-01-27

What is PyRockWave?

PyRockWave is a free, open-source Python tool for reading single-crystal elastic databases and modeling the elastic properties of Earth materials. It computes and visualizes physical properties of minerals, rocks, and layered rock units using various averaging models. The tool emphasizes seismic anisotropy —the directional variation of seismic wave velocities within materials— which provides insights into mineral orientation, stress fields, and flow patterns in Earth's mantle and crust.

Designed with modularity in mind using Python functions, PyRockWave facilitates development and integration with other tools. Example applications, built using Jupyter notebooks, ensure ease of use and reproducible workflows.

View repository on GitHub: https://github.com/marcoalopez/PyRockWave

Caution

PyRockWave is still under development (alpha state). Functionality may change significantly, potentially breaking backward compatibility. Most of the code is undertested, and there is no installation guide or detailed documentation yet. However, the code is (and always will be) open source and free. While there is no official release or comprehensive documentation, you are welcome to explore and use it at your own risk.

Requirements & Python installation

TODO

How to use it?

• Interacting with the mineral elastic data

• The ElasticProps class explained

• Demonstration of the functionality of the coordinates module

• Demonstration of the functionality of the tensor_tools module

• Demonstration of the functionality of the anisotropic_models module

• Demonstration of the functionality of the christoffel module (I'm working on it! 😊)

• Demonstration of the functionality of the layered_media module (I'm working on it! 😊)

How to contribute to this project?

The GitHub website hosting the project provides several options (you will need a GitHub account, it’s free!):

• Open a discussion: This is a place to:
  • Ask questions you are wondering about.
  • Requests for specific features or share ideas.
  • Interact with the developers (still just me).
• Open and issue: This is a place to report or track bugs.
• Create a pull request: You modified, corrected or added a feature to one of the notebooks and send it for one of the developers to review it and add it to the main page.

Funding

The seed of these codes has been made possible thanks to funding from the Government of the Principality of Asturias and the Foundation for the Promotion of Applied Research in Asturias (FICYT) (grant: SV-PA-21-AYUD/2021/57163) under the Asturias Plan for Science, Technology and Innovation 2018-2022 (PCTI-Asturias).

---

Copyright © 2025 Marco A. Lopez-Sanchez

Warning

The information on this website and in the script documentation is provided without any warranty of any kind, either expressed or implied, and may include technical inaccuracies or typographical errors; the author reserves the right to make changes or improvements to the content of this website and the script documentation at any time without notice. This website and its documentation are not responsible for the content of external links. Notebook content is licensed under Creative Commons Attribution license CC-BY 4.0 and codes are licensed under GNU General Public License v3 (https://www.gnu.org/licenses/gpl-3.0.en.html) unless otherwise noted.

Hosted on GitHub Pages — This website was created with Typora