Skip to content

Commit

Permalink
update website
Browse files Browse the repository at this point in the history
  • Loading branch information
@marcoalopez
marcoalopez committed Jun 22, 2024
1 parent fb496ca commit b65507d
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
@@ -1,15 +1,15 @@
![header](https://raw.githubusercontent.com/marcoalopez/PyRockWave/main/img/header.jpg)

This project is maintained by [Marco A. Lopez-Sanchez](https://marcoalopez.github.io/) - Last update: 2024-03-13
This project is maintained by [Marco A. Lopez-Sanchez](https://marcoalopez.github.io/) - Last update: 2024-06-22

## What is PyRockWave?

PyRockWave is a Python-based tool for reading single-crystal elasticity databases and modelling elastic properties of earth materials (e.g. seismic wave propagation and anisotropy in heterogeneous media). It allows you to create models of the physical properties of rocks or rock units and simulate and illustrate how seismic waves propagate through them. The code is designed in a modular way to facilitate its development and the interaction with other codes.
PyRockWave is a Python-based tool for reading single-crystal elasticity databases and modelling the elastic properties of earth materials (e.g. seismic wave propagation and anisotropy in heterogeneous media). It allows you to create models of the physical properties of rocks or rock units and to simulate and illustrate how seismic waves propagate through them. The code is designed in a modular way to facilitate its development and the interaction with other codes.

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

> [!CAUTION]
> PyRockWave is still under heavy development (alpha state), so the functionality may be subject to major changes that break retrocompatibility, 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), so the functionality may be subject to major changes that break backwards compatibility, some of the code is untested, 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.
## 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: 2024-03-13 </span></p><h2 id='what-is-pyrockwave'><span>What is PyRockWave?</span></h2><p><span>PyRockWave is a Python-based tool for reading single-crystal elasticity databases and modelling elastic properties of earth materials (e.g. seismic wave propagation and anisotropy in heterogeneous media). It allows you to create models of the physical properties of rocks or rock units and simulate and illustrate how seismic waves propagate through them. The code is designed in a modular way to facilitate its development and the interaction with other codes.</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 heavy development (alpha state), so the functionality may be subject to major changes that break retrocompatibility, 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_polar.ipynb'><span>Demonstration of the functionality of the </span><code>polar_models</code><span> module</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_orthotropic.ipynb'><span>Demonstration of the functionality of the </span><code>orthorhombic_models</code><span> module</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_christoffel.ipynb'><span>Demonstration of the functionality of the </span><code>christoffel</code><span> module</span></a></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 © 2024 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 contents 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 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 indicated.</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: 2024-06-22 </span></p><h2 id='what-is-pyrockwave'><span>What is PyRockWave?</span></h2><p><span>PyRockWave is a Python-based tool for reading single-crystal elasticity databases and modelling the elastic properties of earth materials (e.g. seismic wave propagation and anisotropy in heterogeneous media). It allows you to create models of the physical properties of rocks or rock units and to simulate and illustrate how seismic waves propagate through them. The code is designed in a modular way to facilitate its development and the interaction with other codes.</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, some of the code is untested, 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_polar.ipynb'><span>Demonstration of the functionality of the </span><code>polar_models</code><span> module</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_orthotropic.ipynb'><span>Demonstration of the functionality of the </span><code>orthorhombic_models</code><span> module</span></a></p></li><li><p><a href='https://github.com/marcoalopez/PyRockWave/blob/main/src/example_christoffel.ipynb'><span>Demonstration of the functionality of the </span><code>christoffel</code><span> module</span></a></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 © 2024 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 contents 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 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 indicated.</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 b65507d

Please sign in to comment.