Oop refactor

.github/workflows/python-app.yml

@@ -1,39 +1,45 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Python application
+name: CI tests /linting for SN-CAST
 
 on:
   push:
-    branches: [ "master" ]
+    branches: [ "master", "oop-refactor" ]
   pull_request:
-    branches: [ "master" ]
+    branches: [ "master", "oop-refactor" ]
 
 permissions:
   contents: read
 
 jobs:
   build:
-
+    name : Continuous Integration Job
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v3
+    - uses: actions/checkout@v5
+
+    - name: Set up Python
+      uses: actions/setup-python@v6
       with:
-        python-version: "3.10"
-    - name: Install dependencies
+        python-version-file : pyproject.toml
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        # pin uv version 
+        version: '0.9.13'
+    - name : Install project and dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with flake8
+        uv sync --locked  --dev
+
+    - name: Lint with ruff
       run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        uv run ruff check .
+        uv run ruff format --check .
+
     - name: Test with pytest
       run: |
-        pytest
+        uv run pytest
+
+

.gitignore

@@ -104,4 +104,5 @@ ENV/
 .DS_Store
 
 #vscode
-.vscode/*
+.vscode/
+settings.json

README.md

@@ -1,3 +1,150 @@
 # SN-CAST 2.0
 
 The Seismic Network Capability Assessment Software Tool
+
+This version of SN-CAST is updated from the original code supporting Möllhoff et al., (2019).
+
+## Overview
+
+SN-CAST (Seismic Network Capability Assessment Software Tool) is a Python package for modeling and assessing the detection capability of seismic networks. It calculates minimum detectable magnitudes across a geographic grid based on station noise levels, network geometry, and various ground motion prediction models.
+
+## Features
+
+- Network detection capability modeling using local magnitude (ML) or GMPE methods
+- Support for multiple types on instrumentation: traditional stations, seismic arrays, ocean bottom seismometers (OBS), and distributed acoustic sensing (DAS).
+- Support for  UK and California empirical local magnitude scales.
+- Flexible grid-based calculations with multiprocessing support
+- Noise estimation tools for seismic data
+- **Cross-section analysis** for 2D detection capability profiles
+
+### Work in progress
+
+- Support for using ground motion prediction equations (GMPEs) instead of local magnitude scales
+
+## Installation
+
+### Requirements
+
+See pyproject.toml
+
+### Install from source
+
+```bash
+git clone https://github.com/jasplet/sncast.git
+cd sncast
+pip install -e .
+```
+
+**PiPy release TBD**
+
+### Install dependencies
+
+```bash
+pip install -r requirements.txt
+```
+
+## Quick Start
+
+### Basic usage
+
+```python
+from sncast.model_detection_capability import find_min_ml
+
+# Calculate minimum detectable magnitude for a grid
+result = find_min_ml(
+    lon0=-1.0, lon1=1.0,      # Longitude bounds
+    lat0=50.0, lat1=52.0,      # Latitude bounds
+    dlon=0.2, dlat=0.2,        # Grid spacing
+    networks=['stations.csv'], # Station data file
+    stat_num=[5],              # Number of stations required
+    foc_depth=0.0,             # Focal depth in km
+    snr=3.0,                   # Signal-to-noise ratio
+    mag_min=-2.0,              # Minimum magnitude to test
+    mag_delta=0.1,             # Magnitude increment
+    method='ML',               # Method: 'ML' or 'GMPE'
+    region='UK'                # Region: 'UK' or 'CAL'
+)
+
+# Result is an xarray DataArray with detection capability grid
+print(result)
+```
+
+### Station data format
+
+Station data should be a CSV file with the following columns:
+
+```csv
+station,longitude,latitude,elevation_km,noise [nm]
+STA1,0.0,50.0,0.0,1.0
+STA2,0.5,50.5,0.1,1.5
+STA3,1.0,51.0,0.2,2.0
+```
+
+### DAS data format
+
+```csv
+channel_index,fiber_length_m,longitude,latitude,noise_m,elevation_km
+10010,1000,0.01,50.01,1e-8,0.0
+10020,2000,0.02,50.02,2e-8,0.0
+```
+
+## Documentation
+
+Full documentation is under construction.
+
+### Key modules
+
+- **`model_detection_capability`**: Main detection modeling functions
+- **`gmpes`**: Ground motion prediction equations
+- **`magnitude_conversions`**: ML ↔ Mw conversions
+- **`noise_estimation`**: Seismic noise analysis tools
+
+## Examples
+
+See the `examples/` directory for:
+
+- Basic network modeling
+- Multi-network analysis (stations + arrays + DAS)
+- Cross-section calculations
+- Custom GMPE usage
+
+## Testing
+
+Run the test suite:
+
+```bash
+pytest tests/
+```
+
+Run with coverage:
+
+```bash
+pytest --cov=sncast --cov-report=html
+```
+
+## Citation
+
+If you use SN-CAST in your research, please cite:
+
+**Original version:**
+```
+Möllhoff, M., Bean, C. J., & Meredith, P. G. (2019). Seismic detection 
+capability of the Irish National Seismic Network. Seismological Research 
+Letters, 90(4), 1607-1617.
+```
+
+**Version 2.0:**
+```
+[Your citation here when published]
+```
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/citations.rst

@@ -0,0 +1,39 @@
+.. _citations:
+
+Citations
+=========
+
+.. [Akkar2014] Akkar, S., Sandikkaya, M.A., Bommer, J.J. (2014),
+    Empirical ground-motion models for point- and extended-source crustal
+    earthquake scenarios in Europe and the Middle East. Bull Earthquake Eng 12, 359-387.
+    https://doi.org/10.1007/s10518-013-9461-4
+
+.. [Butcher2020] Butcher, A., Luckett, R., Verdon, J. P., Kendall, J. M., 
+   Baptie, B., & Wookey, J. (2020). Local magnitude discrepancies for 
+   near-surface seismicity: Implications for understanding exploration-related 
+   seismicity. *Seismological Society of America*, 91(6), 3270-3281.
+   https://doi.org/10.1785/0120190032
+
+.. [Haskov2016] Havskov, J., Alguacil, G., (2016). Instrumentation in Earthquake Seismology. Springer International Publishing, Cham. https://doi.org/10.1007/978-3-319-21314-9
+
+.. [Hutton1987] Hutton, L. K., & Boore, D. M. (1987). The ML scale in southern California. *Bulletin of the Seismological Society of America*, 77(6), 2074-2094. https://doi.org/10.1785/BSSA0770062074
+
+.. [Luckett2019] Luckett, R., Butcher, A., Verdon, J. P., Kendall, J. M., 
+   Baptie, B., & Wookey, J. (2019). A local magnitude scale for northern England 
+   and southern Scotland. *Bulletin of the Seismological Society of America*, 
+   109(2), 546-558. https://doi.org/10.1785/0120180140
+
+.. [Molhoff2019] Möllhoff, M., Bean, C.J. & Baptie, B.J.,
+   SN-CAST: seismic network capability assessment software tool for regional networks - examples from Ireland.
+   *J Seismol*, 23, 493-504 (2019). https://doi.org/10.1007/s10950-019-09819-0
+
+.. [Ottemöller2013] Ottemöller, L., & Sargeant, S. (2013). A local magnitude 
+   scale ML for the United Kingdom. *Bulletin of the Seismological Society 
+   of America*, 103(5), 2884-2893. https://doi.org/10.1785/0120130085
+
+.. [Richter1935] Richter, C. F. (1935). An instrumental earthquake magnitude scale. *Bulletin of the Seismological Society of America*, 25(1), 1-32. https://doi.org/10.1785/BSSA0250010001
+
+.. [Rietbrock2019] Rietbrock, A., & Edwards, B. (2019). Update of the UK stochastic ground motion model using
+    a decade of broadband data. In: *SECED 2019 Conference, 2019-9-9 - 2019-9-10,*
+    Greenwich, London. https://livrepository.liverpool.ac.uk/3060529/1/SECED_2019_paper_Rietbrock_Edwards_FINAL.pdf
+