Skip to content

Commit

Permalink
refine grammar and clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
@marcoalopez
marcoalopez committed Jan 27, 2025
1 parent f3a57f1 commit cce29aa
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ This project is maintained by [Marco A. Lopez-Sanchez](https://marcoalopez.githu

## What is PyRockWave?

PyRockWave is a free and open-source Python code for reading single-crystal elastic databases and modelling and visualizing elastic properties of Earth materials. It allows you to calculate the physical properties of rocks or rock units (e.g. seismic waves propagating through them) using different available models and representing them. It focuses mainly on _seismic anisotropy_, which refers to the directional dependence of seismic wave velocities within a material. This phenomenon is crucial in understanding the Earth's interior, as it provides insights into the orientation of minerals, stress fields, and flow patterns in the mantle and crust.
**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.

PyRockWave code is designed in a modular way to facilitate its development and the interaction with other codes. Application examples, created using Jupyter notebooks, promote ease of use and reproducible workflows.
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), so the functionality may be subject to major changes that break backwards compatibility. Most of the code is undertested, and there is no installation guide or specific documentation on how to use it yet. In any case, the code is (and always will be) open source and free, so even though there is no official release and very little documentation, you can have fun with it at your own risk.
> 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

Expand Down
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2346,6 +2346,6 @@
</style><title>README</title>
</head>
<body class='typora-export os-windows'><div class='typora-export-content'>
<div id='write' class=''><p><img src="https://raw.githubusercontent.com/marcoalopez/PyRockWave/main/img/header.jpg" referrerpolicy="no-referrer" alt="header"></p><p><span>This project is maintained by </span><a href='https://marcoalopez.github.io/'><span>Marco A. Lopez-Sanchez</span></a><span> - Last update: 2025-01-27</span></p><h2 id='what-is-pyrockwave'><span>What is PyRockWave?</span></h2><p><span>PyRockWave is a free and open-source Python code for reading single-crystal elastic databases and modelling and visualizing elastic properties of Earth materials. It allows you to calculate the physical properties of rocks or rock units (e.g. seismic waves propagating through them) using different available models and representing them. It focuses mainly on </span><em><span>seismic anisotropy</span></em><span>, which refers to the directional dependence of seismic wave velocities within a material. This phenomenon is crucial in understanding the Earth&#39;s interior, as it provides insights into the orientation of minerals, stress fields, and flow patterns in the mantle and crust.</span></p><p><span>PyRockWave code is designed in a modular way to facilitate its development and the interaction with other codes. Application examples, created using Jupyter notebooks, promote ease of use and reproducible workflows.</span></p><p><span>View repository on GitHub: </span><a href='https://github.com/marcoalopez/PyRockWave' target='_blank' class='url'>https://github.com/marcoalopez/PyRockWave</a></p><div class="md-alert md-alert-caution caution"><p><span class='md-alert-text md-alert-text-caution'><svg viewBox="0 0 16 16" version="1.1" width="1em" height="1em" aria-hidden="true"><path d="M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Caution</span><br><span>PyRockWave is still under development (alpha state), so the functionality may be subject to major changes that break backwards compatibility. Most of the code is undertested, and there is no installation guide or specific documentation on how to use it yet. In any case, the code is (and always will be) open source and free, so even though there is no official release and very little documentation, you can have fun with it at your own risk.</span></p></div><h2 id='requirements--python-installation'><span>Requirements &amp; Python installation</span></h2><p><span>TODO</span></p><h2 id='how-to-use-it'><span>How to use it?</span></h2><ul><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_database.ipynb'><span>Interacting with the mineral elastic data</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/ElasticTensor_explained.ipynb'><span>The ElasticProps class explained</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_coordinates.ipynb'><span>Demonstration of the functionality of the </span><code>coordinates</code><span> module</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_tensor_tools.ipynb'><span>Demonstration of the functionality of the </span><code>tensor_tools</code><span> module</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_anisotropic_models.ipynb'><span>Demonstration of the functionality of the </span><code>anisotropic_models</code><span> module</span></a></p></li><li><p><span>Demonstration of the functionality of the </span><code>christoffel</code><span> module (I&#39;m working on it! 😊)</span></p></li><li><p><span>Demonstration of the functionality of the </span><code>layered_media</code><span> module (I&#39;m working on it! 😊)</span></p></li></ul><h2 id='how-to-contribute-to-this-project'><span>How to contribute to this project?</span></h2><p><span>The GitHub website hosting the project provides several options (you will need a GitHub account, it’s free!):</span></p><ul><li><p><span>Open a </span><a href='https://github.com/marcoalopez/PyRockWave/discussions'><span>discussion</span></a><span>: This is a place to:</span></p><ul><li><p><span>Ask questions you are wondering about.</span></p></li><li><p><span>Requests for specific features or share ideas.</span></p></li><li><p><span>Interact with the developers (still just me).</span></p></li></ul></li><li><p><span>Open and </span><a href='https://github.com/marcoalopez/PyRockWave/issues'><span>issue</span></a><span>: This is a place to report or track bugs.</span></p></li><li><p><span>Create a </span><a href='https://github.com/marcoalopez/PyRockWave/pulls'><span>pull request</span></a><span>: 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.</span></p></li></ul><h2 id='funding'><span>Funding</span></h2><p><span>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). </span></p><hr /><p><em><span>Copyright © 2025 Marco A. Lopez-Sanchez</span></em><span> </span></p><div class="md-alert md-alert-warning warning"><p><span class='md-alert-text md-alert-text-warning'><svg viewBox="0 0 16 16" version="1.1" width="1em" height="1em" aria-hidden="true"><path d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg>Warning</span><br><em><span>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 </span><a href='https://creativecommons.org/licenses/by/4.0/'><span>Creative Commons Attribution license CC-BY 4.0</span></a><span> and codes are licensed under GNU General Public License v3 (</span><a href='https://www.gnu.org/licenses/gpl-3.0.en.html' target='_blank' class='url'>https://www.gnu.org/licenses/gpl-3.0.en.html</a><span>) unless otherwise noted.</span></em></p></div><p><em><span>Hosted on GitHub Pages — This website was created with </span><a href='https://typora.io/'><span>Typora</span></a></em></p></div></div>
<div id='write' class=''><p><img src="https://raw.githubusercontent.com/marcoalopez/PyRockWave/main/img/header.jpg" referrerpolicy="no-referrer" alt="header"></p><p><span>This project is maintained by </span><a href='https://marcoalopez.github.io/'><span>Marco A. Lopez-Sanchez</span></a><span> - Last update: 2025-01-27</span></p><h2 id='what-is-pyrockwave'><span>What is PyRockWave?</span></h2><p><strong><span>PyRockWave</span></strong><span> 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&#39;s mantle and crust.</span></p><p><span>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.</span></p><p><span>View repository on GitHub: </span><a href='https://github.com/marcoalopez/PyRockWave' target='_blank' class='url'>https://github.com/marcoalopez/PyRockWave</a></p><div class="md-alert md-alert-caution caution"><p><span class='md-alert-text md-alert-text-caution'><svg viewBox="0 0 16 16" version="1.1" width="1em" height="1em" aria-hidden="true"><path d="M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Caution</span><br><span>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.</span></p></div><h2 id='requirements--python-installation'><span>Requirements &amp; Python installation</span></h2><p><span>TODO</span></p><h2 id='how-to-use-it'><span>How to use it?</span></h2><ul><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_database.ipynb'><span>Interacting with the mineral elastic data</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/ElasticTensor_explained.ipynb'><span>The ElasticProps class explained</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_coordinates.ipynb'><span>Demonstration of the functionality of the </span><code>coordinates</code><span> module</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_tensor_tools.ipynb'><span>Demonstration of the functionality of the </span><code>tensor_tools</code><span> module</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_anisotropic_models.ipynb'><span>Demonstration of the functionality of the </span><code>anisotropic_models</code><span> module</span></a></p></li><li><p><span>Demonstration of the functionality of the </span><code>christoffel</code><span> module (I&#39;m working on it! 😊)</span></p></li><li><p><span>Demonstration of the functionality of the </span><code>layered_media</code><span> module (I&#39;m working on it! 😊)</span></p></li></ul><h2 id='how-to-contribute-to-this-project'><span>How to contribute to this project?</span></h2><p><span>The GitHub website hosting the project provides several options (you will need a GitHub account, it’s free!):</span></p><ul><li><p><span>Open a </span><a href='https://github.com/marcoalopez/PyRockWave/discussions'><span>discussion</span></a><span>: This is a place to:</span></p><ul><li><p><span>Ask questions you are wondering about.</span></p></li><li><p><span>Requests for specific features or share ideas.</span></p></li><li><p><span>Interact with the developers (still just me).</span></p></li></ul></li><li><p><span>Open and </span><a href='https://github.com/marcoalopez/PyRockWave/issues'><span>issue</span></a><span>: This is a place to report or track bugs.</span></p></li><li><p><span>Create a </span><a href='https://github.com/marcoalopez/PyRockWave/pulls'><span>pull request</span></a><span>: 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.</span></p></li></ul><h2 id='funding'><span>Funding</span></h2><p><span>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). </span></p><hr /><p><em><span>Copyright © 2025 Marco A. Lopez-Sanchez</span></em><span> </span></p><div class="md-alert md-alert-warning warning"><p><span class='md-alert-text md-alert-text-warning'><svg viewBox="0 0 16 16" version="1.1" width="1em" height="1em" aria-hidden="true"><path d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg>Warning</span><br><em><span>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 </span><a href='https://creativecommons.org/licenses/by/4.0/'><span>Creative Commons Attribution license CC-BY 4.0</span></a><span> and codes are licensed under GNU General Public License v3 (</span><a href='https://www.gnu.org/licenses/gpl-3.0.en.html' target='_blank' class='url'>https://www.gnu.org/licenses/gpl-3.0.en.html</a><span>) unless otherwise noted.</span></em></p></div><p><em><span>Hosted on GitHub Pages — This website was created with </span><a href='https://typora.io/'><span>Typora</span></a></em></p></div></div>
</body>
</html>

0 comments on commit cce29aa

Please sign in to comment.