Skip to content

Commit

Permalink
update website
Browse files Browse the repository at this point in the history 
notebook links updated
  • Loading branch information
@marcoalopez
marcoalopez committed Nov 15, 2023
1 parent 70b46ae commit 304b078
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
13 changes: 7 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![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: 2023-10-26
This project is maintained by [Marco A. Lopez-Sanchez](https://marcoalopez.github.io/) - Last update: 2023-11-15

## What is PyRockWave?

Expand All @@ -18,14 +18,15 @@ TODO

> 🚨**Beware**🚨: still under heavy development (alpha state)!
- [Interacting with the mineral elastic data](https://deepnote.com/viewer/github/marcoalopez/PyRockWave/blob/main/src/example_database.ipynb)
- [Interacting with the mineral elastic data](https://github.com/marcoalopez/PyRockWave/blob/main/src/example_database.ipynb)

- [The ElasticProps class explained](https://deepnote.com/viewer/github/marcoalopez/PyRockWave/blob/main/src/ElasticTensor_explained.ipynb)
- [The ElasticProps class explained](https://github.com/marcoalopez/PyRockWave/blob/main/src/ElasticTensor_explained.ipynb)

- [Demonstration of the functionality of the ``coordinates`` module](https://deepnote.com/viewer/github/marcoalopez/PyRockWave/blob/main/src/example_coordinates.ipynb)
- [Demonstration of the functionality of the ``coordinates`` module](https://github.com/marcoalopez/PyRockWave/blob/main/src/example_coordinates.ipynb)

- [Demonstration of the functionality of the ``polar_models`` module](https://deepnote.com/viewer/github/marcoalopez/PyRockWave/blob/main/src/example_polar.ipynb)
- [Demonstration of the functionality of the ``christoffel`` module](https://deepnote.com/viewer/github/marcoalopez/PyRockWave/blob/main/src/example_christoffel.ipynb)
- [Demonstration of the functionality of the ``polar_models`` module](https://github.com/marcoalopez/PyRockWave/blob/main/src/example_polar.ipynb)

- [Demonstration of the functionality of the ``christoffel`` module](https://github.com/marcoalopez/PyRockWave/blob/main/src/example_christoffel.ipynb)

## How to contribute to this project?

Expand Down
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2078,6 +2078,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: 2023-10-26 </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 realistic 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>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><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><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><blockquote><p><span>🚨</span><strong><span>Beware</span></strong><span>🚨: still under heavy development (alpha state)!</span></p></blockquote><ul><li><p><a href='https://deepnote.com/viewer/github/marcoalopez/PyRockWave/blob/main/src/example_database.ipynb'><span>Interacting with the mineral elastic data</span></a></p></li><li><p><a href='https://deepnote.com/viewer/github/marcoalopez/PyRockWave/blob/main/src/ElasticTensor_explained.ipynb'><span>The ElasticProps class explained</span></a></p></li><li><p><a href='https://deepnote.com/viewer/github/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://deepnote.com/viewer/github/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://deepnote.com/viewer/github/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>Share ideas.</span></p></li><li><p><span>Engage 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 track bugs or requests for specific features on the notebooks.</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><p><span>Besides, if you want to contribute to the project, you might want to glimpse at the </span><a href='https://github.com/marcoalopez/strength_envelopes/blob/master/CODE_OF_CONDUCT.md'><span>code of conduct</span></a><span> (TLDR: be nice to others 😉). </span></p><hr /><p><em><span>Copyright © 2023 Marco A. Lopez-Sanchez</span></em><span></span><br/><em><span>Information presented on this website and the notebooks is provided without any express or implied warranty and may include technical inaccuracies or typing errors; the author reserve the right to modify or enhance the content of this website as well as the notebooks at any time without previous notice. This webpage and the notebooks are not liable 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><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: 2023-11-15 </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 realistic 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>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><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><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><blockquote><p><span>🚨</span><strong><span>Beware</span></strong><span>🚨: still under heavy development (alpha state)!</span></p></blockquote><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_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>Share ideas.</span></p></li><li><p><span>Engage 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 track bugs or requests for specific features on the notebooks.</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><p><span>Besides, if you want to contribute to the project, you might want to glimpse at the </span><a href='https://github.com/marcoalopez/strength_envelopes/blob/master/CODE_OF_CONDUCT.md'><span>code of conduct</span></a><span> (TLDR: be nice to others 😉). </span></p><hr /><p><em><span>Copyright © 2023 Marco A. Lopez-Sanchez</span></em><span></span><br/><em><span>Information presented on this website and the notebooks is provided without any express or implied warranty and may include technical inaccuracies or typing errors; the author reserve the right to modify or enhance the content of this website as well as the notebooks at any time without previous notice. This webpage and the notebooks are not liable 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><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 304b078

Please sign in to comment.