diff --git a/README.md b/README.md new file mode 100644 index 0000000..47dca87 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# *GaMMA*: *Ga*ussian *M*ixture *M*odel *A*ssociation + +## 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) + + +## 3. Examples: + +- Synthetic Example + +See details in the [notebook](): [example_synthetic.ipynb]() + +![Association result](assets/result_eq05_err0.0_fp0.0_amp1.png) + +- Real Example using PhaseNet picks + +See details in the [notebook](): [example_phasenet.ipynb]() + +![Associaiton result](assets/2019-07-04T18-02-01.074.png) + diff --git a/docs/README.md b/docs/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/docs/assets/2019-07-04T18-02-01.074.png b/docs/assets/2019-07-04T18-02-01.074.png new file mode 100644 index 0000000..ade83b7 Binary files /dev/null and b/docs/assets/2019-07-04T18-02-01.074.png differ diff --git a/docs/assets/diagram_gmma_annotated.png b/docs/assets/diagram_gmma_annotated.png new file mode 100644 index 0000000..e857426 Binary files /dev/null and b/docs/assets/diagram_gmma_annotated.png differ diff --git a/docs/assets/result_eq05_err0.0_fp0.0_amp1.png b/docs/assets/result_eq05_err0.0_fp0.0_amp1.png new file mode 100644 index 0000000..1859130 Binary files /dev/null and b/docs/assets/result_eq05_err0.0_fp0.0_amp1.png differ diff --git a/docs/example_phasenet.ipynb b/docs/example_phasenet.ipynb new file mode 100644 index 0000000..39ab2bb --- /dev/null +++ b/docs/example_phasenet.ipynb @@ -0,0 +1,28 @@ +{ + "metadata": { + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": 3 + }, + "orig_nbformat": 4 + }, + "nbformat": 4, + "nbformat_minor": 2, + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ] +} \ No newline at end of file diff --git a/docs/example_synthetic.ipynb b/docs/example_synthetic.ipynb new file mode 100644 index 0000000..7f68519 --- /dev/null +++ b/docs/example_synthetic.ipynb @@ -0,0 +1,62 @@ +{ + "metadata": { + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.7.10" + }, + "orig_nbformat": 4, + "kernelspec": { + "name": "python3", + "display_name": "Python 3.7.10 64-bit ('base': conda)" + }, + "interpreter": { + "hash": "f4d5179fc222eb76bfd3dcff5bf88b43751287e77ddc0be170fe093e3076340e" + } + }, + "nbformat": 4, + "nbformat_minor": 2, + "cells": [ + { + "source": [ + "# GaMMA association of PhaseNet picks" + ], + "cell_type": "markdown", + "metadata": {} + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": {}, + "outputs": [ + { + "output_type": "execute_result", + "data": { + "text/plain": [ + "1" + ] + }, + "metadata": {}, + "execution_count": 2 + } + ], + "source": [ + "1" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ] +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..0b2f494 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,14 @@ +site_name: "GaMMA" +site_description: 'GaMMA: earthquake phase association using a bayesian gaussian mixture model' +site_author: 'Weiqiang Zhu' +docs_dir: docs/ +repo_name: 'wayneweiqiang/GMMA' +repo_url: 'https://github.com/wayneweiqiang/GMMA' +nav: + - Overview: README.md + - Synthetic Example: example_synthetic.ipynb + - PhaseNet Example: example_phasenet.ipynb +theme: + name: 'material' +plugins: + - mkdocs-jupyter \ No newline at end of file