From c26534e160e33fa26101dff32e2b63112ead4db6 Mon Sep 17 00:00:00 2001 From: "Marco A. Lopez-Sanchez" Date: Thu, 26 Oct 2023 16:29:51 +0200 Subject: [PATCH] update readme & website --- README.md | 6 +++--- index.html | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 22837a0..f3648ea 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ ![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-09-06 +This project is maintained by [Marco A. Lopez-Sanchez](https://marcoalopez.github.io/) - Last update: 2023-10-26 ## 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 realistic models of physical properties of rocks and more complex geological structures and simulate and illustrate how seismic waves travel through them. The code is designed in a modular way to facilitate its development and interaction with other codes to create a powerful and versatile tool. +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. -PyRockWave codes are still under heavy development (alpha state), so the functionality may be subject to major changes and there are no installation instructions or specific documentation on how to use it yet. In any case, the code is and will always be completely open source and free, so even though there is still no official release and very little documentation, you can have fun with it at your own risk. +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. View repository on GitHub: https://github.com/marcoalopez/PyRockWave diff --git a/index.html b/index.html index 41f40fa..645e6ba 100644 --- a/index.html +++ b/index.html @@ -2078,6 +2078,6 @@ README
-

header

This project is maintained by Marco A. Lopez-Sanchez - Last update: 2023-09-06

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 realistic models of physical properties of rocks and more complex geological structures and simulate and illustrate how seismic waves travel through them. The code is designed in a modular way to facilitate its development and interaction with other codes to create a powerful and versatile tool.

PyRockWave codes are still under heavy development (alpha state), so the functionality may be subject to major changes and there are no installation instructions or specific documentation on how to use it yet. In any case, the code is and will always be completely open source and free, so even though there is still no official release and very little documentation, you can have fun with it at your own risk.

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

Requirements & Python installation

TODO

How to use it?

🚨Beware🚨: still under heavy development (alpha state)!

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.

    • Share ideas.

    • Engage with the developers (still just me).

  • Open and issue: This is a place to track bugs or requests for specific features on the notebooks.

  • 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.

Besides, if you want to contribute to the project, you might want to glimpse at the code of conduct (TLDR: be nice to others πŸ˜‰).


Copyright Β© 2023 Marco A. Lopez-Sanchez
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 Creative Commons Attribution license CC-BY 4.0 and codes under GNU General Public License v3 (https://www.gnu.org/licenses/gpl-3.0.en.html) unless otherwise indicated.

Hosted on GitHub Pages β€” This website was created with Typora

+

header

This project is maintained by Marco A. Lopez-Sanchez - Last update: 2023-10-26

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 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.

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.

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

Requirements & Python installation

TODO

How to use it?

🚨Beware🚨: still under heavy development (alpha state)!

How to contribute to this project?

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

Besides, if you want to contribute to the project, you might want to glimpse at the code of conduct (TLDR: be nice to others πŸ˜‰).


Copyright Β© 2023 Marco A. Lopez-Sanchez
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 Creative Commons Attribution license CC-BY 4.0 and codes under GNU General Public License v3 (https://www.gnu.org/licenses/gpl-3.0.en.html) unless otherwise indicated.

Hosted on GitHub Pages β€” This website was created with Typora

\ No newline at end of file