cmt-solutions 0.0.0__tar.gz

cmt_solutions-0.0.0/.github/workflows/claude-review.yml

@@ -0,0 +1,11 @@
+name: Claude PR Review
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  review:
+    uses: ucgmsim/meta-ci-action/.github/workflows/claude-review.yml@main
+    secrets:
+      claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}

cmt_solutions-0.0.0/.github/workflows/deptry.yml

@@ -0,0 +1,20 @@
+name: Deptry Dependency Check
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # Setup the minimum required python distribution
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - run: pip install -r requirements.txt
+      # Install deptry
+      - run: pip install deptry
+      # Remove pyproject.toml so that deptry doesn't get confused
+      - run: rm pyproject.toml
+      # Run deptry to check that all dependencies are present.
+      - run: deptry .

cmt_solutions-0.0.0/.github/workflows/publish-PyPi.yml

@@ -0,0 +1,62 @@
+name: Publish to PyPI
+run-name: Publish Python Package to PyPI for release ${{ github.event.release.tag_name }}
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      tag_name:
+        description: 'Git tag to checkout and publish'
+        required: false
+        type: string
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.tag_name || github.ref }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install pypa/build
+        run: >-
+          python3 -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/cmt_solutions
+
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

cmt_solutions-0.0.0/.github/workflows/ruff.yml

@@ -0,0 +1,8 @@
+name: Ruff
+on: [pull_request]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1

cmt_solutions-0.0.0/.github/workflows/wiki.yml

@@ -0,0 +1,16 @@
+# .github/workflows/deploy-wiki.yml
+name: deploy-wiki
+on:
+  push:
+    branches: "main"
+    paths: wiki/**
+  workflow_dispatch:
+jobs:
+  deploy-wiki:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: perl -i -pe 's;(\[.*?\])\((?!https:\/\/)(.*?)\.md\);\1(\2);g' wiki/*.md
+      - uses: actions4gh/deploy-wiki@v1

cmt_solutions-0.0.0/.gitignore

@@ -0,0 +1,176 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

cmt_solutions-0.0.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: cmt_solutions
+Version: 0.0.0
+Summary: Provides access to a range of CMT solutions for seismic events in New Zealand.
+Author: QuakeCoRE
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: pandas
+Requires-Dist: typer
+Requires-Dist: numpy
+Requires-Dist: streamlit
+Requires-Dist: pydeck
+Requires-Dist: obspy
+Requires-Dist: shapely
+Requires-Dist: requests
+Requires-Dist: qcore-utils>=2025.12.1
+Requires-Dist: source_modelling>=2025.12.1
+Requires-Dist: BayesISOLA==0.2.0
+
+# CMT Solutions
+
+This repository contains the Centroid Moment Tensor (CMT) solutions and supporting tools used for the John Townend relocation / CMT study.
+
+Contents
+- `cmt_solutions/` — Python package with helpers for reading and working with CMT solution data (includes `cmt_data.py`, `nodal_plane.py`, etc.).
+- `auto_cmt/` — runs BayesISOLA's automated 1-D CMT inversion for a single GeoNet event (`run_cmt.py`), for any event already in GeoNet's archive or, with `--real-time`, for one that has only just happened. Installed as the `auto_cmt` package so callers can launch it as a subprocess (`python -m auto_cmt.run_cmt ...`); see NZGMDB's `nzgmdb.management.background` for an example launcher.
+- `data/` — CSV datasets (e.g. `CMT_solutions.csv`) used by the code and reviewer app.
+- `interfaces/` — Streamlit UI for reviewing nodal planes (`cmt_reviewer.py`).
+- `scripts/` — utility scripts used to build or update datasets.
+- `wiki/` — documentation pages including the CMT review guide, the auto CMT guide, and the John Townend study notes.
+
+Quick links (wiki)
+- CMT Review guide: `wiki/CMT Review.md`
+- Auto CMT guide: `wiki/Auto CMT.md`
+- John Townend CMT study notes: `wiki/John Townend CMT Study.md`
+- Home (scripts summary): open `wiki/Home.md` for descriptions of the scripts in `scripts/`.
+
+---
+
+## Install
+
+We recommend using a new Python virtual environment. From the repository root (the directory containing `pyproject.toml` / `setup.py`) install editable mode so the package is importable during development and by the Streamlit app:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+python -m pip install -e .
+python -m pip install -r requirements.txt
+```
+
+---
+
+### Running the Streamlit reviewer
+
+From the repo root:
+
+```bash
+cd interfaces
+streamlit run cmt_reviewer.py
+```
+
+Open the URL printed by Streamlit (usually `http://localhost:8501`). The `wiki/CMT Review.md` file contains a user guide for the reviewer UI and describes the steps to perform and save reviews.
+
+---
+
+### Using the Python API
+
+This repository exposes a small API for loading and working with the CMT data. The main helper for loading the data is `get_cmt_data()` in `cmt_solutions/cmt_data.py`.
+
+Example: load all CMT solutions
+
+```python
+from cmt_solutions.cmt_data import get_cmt_data
+
+df_all = get_cmt_data()  # returns a pandas.DataFrame with the full contents of data/CMT_solutions.csv
+print(len(df_all), "rows loaded")
+```
+
+Example: load a single event by `PublicID`
+
+```python
+from cmt_solutions.cmt_data import get_cmt_data
+
+df_event = get_cmt_data(event_id="2016p858000")
+```
+
+### Reviewed-plane convention
+
+When reviewing a CMT solution using the Streamlit app, the selected (preferred) plane is stored in the first plane columns and the other (alternative) plane in the second plane columns. Concretely:
+
+- Preferred (chosen) plane -> `strike1`, `dip1`, `rake1`
+- Other (non-preferred) plane -> `strike2`, `dip2`, `rake2`
+- The `PreferredPlane` column is set to the chosen value (`"1"` or `"2"`), and the reviewer name and `reviewed` flag are recorded.
+
+This means consumers of `CMT_solutions.csv` can always treat the first plane as the preferred plane when `reviewed == True`.
+
+Working with reviewed results
+
+The Streamlit reviewer writes the full working table (including `reviewed`, `reviewer`) to the output CSV you specify in the UI. You can use this file directly or replace `data/CMT_solutions.csv` with your reviewed file to share results.
+
+To contribute reviewed results back to the repository follow the steps in the `wiki/CMT Review.md` guide.

cmt_solutions-0.0.0/README.md

@@ -0,0 +1,83 @@
+# CMT Solutions
+
+This repository contains the Centroid Moment Tensor (CMT) solutions and supporting tools used for the John Townend relocation / CMT study.
+
+Contents
+- `cmt_solutions/` — Python package with helpers for reading and working with CMT solution data (includes `cmt_data.py`, `nodal_plane.py`, etc.).
+- `auto_cmt/` — runs BayesISOLA's automated 1-D CMT inversion for a single GeoNet event (`run_cmt.py`), for any event already in GeoNet's archive or, with `--real-time`, for one that has only just happened. Installed as the `auto_cmt` package so callers can launch it as a subprocess (`python -m auto_cmt.run_cmt ...`); see NZGMDB's `nzgmdb.management.background` for an example launcher.
+- `data/` — CSV datasets (e.g. `CMT_solutions.csv`) used by the code and reviewer app.
+- `interfaces/` — Streamlit UI for reviewing nodal planes (`cmt_reviewer.py`).
+- `scripts/` — utility scripts used to build or update datasets.
+- `wiki/` — documentation pages including the CMT review guide, the auto CMT guide, and the John Townend study notes.
+
+Quick links (wiki)
+- CMT Review guide: `wiki/CMT Review.md`
+- Auto CMT guide: `wiki/Auto CMT.md`
+- John Townend CMT study notes: `wiki/John Townend CMT Study.md`
+- Home (scripts summary): open `wiki/Home.md` for descriptions of the scripts in `scripts/`.
+
+---
+
+## Install
+
+We recommend using a new Python virtual environment. From the repository root (the directory containing `pyproject.toml` / `setup.py`) install editable mode so the package is importable during development and by the Streamlit app:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+python -m pip install -e .
+python -m pip install -r requirements.txt
+```
+
+---
+
+### Running the Streamlit reviewer
+
+From the repo root:
+
+```bash
+cd interfaces
+streamlit run cmt_reviewer.py
+```
+
+Open the URL printed by Streamlit (usually `http://localhost:8501`). The `wiki/CMT Review.md` file contains a user guide for the reviewer UI and describes the steps to perform and save reviews.
+
+---
+
+### Using the Python API
+
+This repository exposes a small API for loading and working with the CMT data. The main helper for loading the data is `get_cmt_data()` in `cmt_solutions/cmt_data.py`.
+
+Example: load all CMT solutions
+
+```python
+from cmt_solutions.cmt_data import get_cmt_data
+
+df_all = get_cmt_data()  # returns a pandas.DataFrame with the full contents of data/CMT_solutions.csv
+print(len(df_all), "rows loaded")
+```
+
+Example: load a single event by `PublicID`
+
+```python
+from cmt_solutions.cmt_data import get_cmt_data
+
+df_event = get_cmt_data(event_id="2016p858000")
+```
+
+### Reviewed-plane convention
+
+When reviewing a CMT solution using the Streamlit app, the selected (preferred) plane is stored in the first plane columns and the other (alternative) plane in the second plane columns. Concretely:
+
+- Preferred (chosen) plane -> `strike1`, `dip1`, `rake1`
+- Other (non-preferred) plane -> `strike2`, `dip2`, `rake2`
+- The `PreferredPlane` column is set to the chosen value (`"1"` or `"2"`), and the reviewer name and `reviewed` flag are recorded.
+
+This means consumers of `CMT_solutions.csv` can always treat the first plane as the preferred plane when `reviewed == True`.
+
+Working with reviewed results
+
+The Streamlit reviewer writes the full working table (including `reviewed`, `reviewer`) to the output CSV you specify in the UI. You can use this file directly or replace `data/CMT_solutions.csv` with your reviewed file to share results.
+
+To contribute reviewed results back to the repository follow the steps in the `wiki/CMT Review.md` guide.