Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wayneweiqiang committed Jul 8, 2021
1 parent 529db03 commit 015fbac
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 7 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: documentation

on:
push:
branches:
- master
- main

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- run: pip install mkdocs-material mkdocs-jupyter
- run: mkdocs gh-deploy --force
2 changes: 1 addition & 1 deletion .github/workflows/publish_pypi.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish to Pypi
name: pypi
on:
workflow_dispatch:
inputs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/wheels.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Workflow to build and test wheels
name: Wheel builder
name: wheels

on:

Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
# *GaMMA*: *Ga*ussian *M*ixture *M*odel *A*ssociation

[![](https://github.com/wayneweiqiang/GMMA/workflows/documentation/badge.svg)](https://wayneweiqiang.github.io/GMMA)
[![](https://github.com/wayneweiqiang/GMMA/workflows/pypi/badge.svg)](https://wayneweiqiang.github.io/GMMA)
[![](https://github.com/wayneweiqiang/GMMA/workflows/wheels/badge.svg)](https://wayneweiqiang.github.io/GMMA)

## 1. Install
```bash
pip install gmma
```

## 2. Related papers:
- Zhu Weiqiang et al. Earthquake Phase Association using a Bayesian Gaussian Mixture Model (2021)
![Method](assets/diagram_gmma_annotated.png)
![Method](https://raw.githubusercontent.com/wayneweiqiang/GMMA/master/docs/assets/diagram_gmma_annotated.png)


## 3. Examples:

- Synthetic Example

See details in the [notebook](): [example_synthetic.ipynb]()
See details in the [notebook](https://github.com/wayneweiqiang/GMMA/blob/master/docs/example_phasenet.ipynb): [example_synthetic.ipynb](example_phasenet.ipynb)

![Association result](assets/result_eq05_err0.0_fp0.0_amp1.png)
![Association result](https://raw.githubusercontent.com/wayneweiqiang/GMMA/master/docs/assets/result_eq05_err0.0_fp0.0_amp1.png)

- Real Example using PhaseNet picks

See details in the [notebook](): [example_phasenet.ipynb]()
See details in the [notebook](https://github.com/wayneweiqiang/GMMA/blob/master/docs/example_phasenet.ipynb): [example_phasenet.ipynb](example_phasenet.ipynb)

![Associaiton result](assets/2019-07-04T18-02-01.074.png)
![Associaiton result](https://raw.githubusercontent.com/wayneweiqiang/GMMA/master/docs/assets/2019-07-04T18-02-01.074.png)

0 comments on commit 015fbac

Please sign in to comment.