markdown

README.md

@@ -1,65 +1,39 @@
 # bruges is a library of geophysical equations
 
-```{image} http://agile.geosci.ai/bruges.png
-```
+![Bruges](http://agile.geosci.ai/bruges.png)
 
 In other words, it's just a load of functions that implement important equations in (mostly seismic) geophysics, from Aki-Richards to Zoeppritz.
 
-```{image} https://img.shields.io/travis/agile-geoscience/bruges.svg
-:alt: Travis build status
-:target: https://travis-ci.org/agile-geoscience/bruges
-```
-
-```{image} https://readthedocs.org/projects/bruges/badge/?version=latest
-:alt: Documentation Status
-:target: https://bruges.readthedocs.io/?badge=latest
-```
-
-```{image} https://img.shields.io/pypi/status/bruges.svg
-:alt: Development status
-:target: https://pypi.python.org/pypi/bruges/
-```
-
-```{image} https://img.shields.io/pypi/v/bruges.svg
-:alt: Latest version
-:target: https://pypi.python.org/pypi/bruges/
-```
+[![Run tests](https://github.com/agile-geoscience/bruges/actions/workflows/run-tests.yml/badge.svg)](https://github.com/agile-geoscience/bruges/actions/workflows/run-tests.yml)
+[![Build docs](https://github.com/agile-geoscience/bruges/actions/workflows/build-docs.yml/badge.svg)](https://github.com/agile-geoscience/bruges/actions/workflows/build-docs.yml)
+[![PyPI version](https://img.shields.io/pypi/v/bruges.svg)](https://pypi.python.org/pypi/bruges/)
+[![PyPI versions](https://img.shields.io/pypi/pyversions/bruges.svg)](https://pypi.org/project/bruges//)
+[![PyPI license](https://img.shields.io/pypi/l/bruges.svg)](https://pypi.org/project/bruges/)
 
-```{image} https://img.shields.io/pypi/pyversions/bruges.svg
-:alt: Python version
-:target: https://pypi.python.org/pypi/bruges/
-```
 
-```{image} https://img.shields.io/pypi/l/bruges.svg
-:alt: License
-:target: http://www.apache.org/licenses/LICENSE-2.0
-```
+## Quick start
 
-```{eval-rst}
-.. line-block::
-   The bruges module contains several common geophysics functions
-   used for modelling and post-processing seismic reflection data.
+Install with:
 
+```shell
+pip install bruges
 ```
 
-## Installation
+Make a trapezoidal wavelet like:
 
-Install with
-
-```shell
-pip install bruges
+```python
+import bruges as bg
+w, t = bg.filters.ormsby(duration=0.256, dt=0.002, f=[5, 10, 40, 80])
 ```
 
-**bruges** requires NumPy and SciPy.
+This produces two arrays: amplitude `w` and time `t`.
 
 
 ## Links
 
 - [Documentation](https://code.agilescientific.com/bruges)
-- [Project page](http://agile-geoscience.github.com/bruges/)
 - [Issue Tracker](https://github.com/agile-geoscience/bruges/issues/)
 - [PyPi](http://pypi.python.org/pypi/bruges/)
 - [Agile's website](http://www.agilescientific.com)
 
-```{image} https://www.dropbox.com/s/tzvi22ujq6rozdb/bruges_long_rooves.png?raw=1
-```
+![Bruges rooves](https://www.dropbox.com/s/tzvi22ujq6rozdb/bruges_long_rooves.png?raw=1)