Skip to content

Commit

Permalink
⬆️ Update README
Browse files Browse the repository at this point in the history
Update README with correct documentation links (now it has been
successfully uploaded and compiled!). Unfortunately, the base
"anisotropy".readthedocs.io was already taken by a dead project. For
now, I have gone with seismicanisotropy.readthedocs.io. Maybe in the
future this will change, but it's not critical.

Add documentation build badge.
  • Loading branch information
hemmelig committed Jan 31, 2022
1 parent 1ce3b62 commit 12f1dfd
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,19 @@
<img src="./docs/img/AnilogoBig.png" width="80%">
</p>

[![Documentation Status](https://readthedocs.org/projects/seismicanisotropy/badge/?version=latest)](https://seismicanisotropy.readthedocs.io/en/latest/?badge=latest)

AnisotroPy is a Python package that provides standard routines for a number of aspects of the study of seismic anisotropy, including: shear-wave splitting analysis (to be implemented), effective media modelling, multiple layer fitting, and more.

The package has been built to provide an efficient pythonic implementation of a number of long-established methods that can be either incorporated into analysis scripts, or used with a high-level dashboard interface. Where possible, we aim to provide parsers for the outputs of a number of established packages for shear-wave splitting analysis. This will be accomplished in future via a sibling project, AnIO, which will establish a standard, unified file format for shear-wave splitting analyses.

Documentation
-------------
Documentation for AnisotroPy is hosted [here](https://anisotropy.readthedocs.io/en/latest/index.html).
Documentation for AnisotroPy is hosted [here](https://seismicanisotropy.readthedocs.io/en/latest/index.html).

Installation
------------
Installation instructions can be found [here](https://anisotropy.readthedocs.io/en/latest/installation.html).
Installation instructions can be found [here](https://seismicanisotropy.readthedocs.io/en/latest/installation.html).

Usage
-----
Expand Down

0 comments on commit 12f1dfd

Please sign in to comment.