gri-convolve 0.2.0__tar.gz

gri_convolve-0.2.0/.coveragerc

@@ -0,0 +1,8 @@
+[run]
+omit = */test*, ./*.py, .venv/*
+branch = True
+source = .
+[report]
+skip_empty = True
+[html]
+directory = .cov_html

gri_convolve-0.2.0/.docs_other_projects.md

@@ -0,0 +1,81 @@
+[![GeoSol Research Logo](https://geosolresearch.com/logos/foss_logo.png "GeoSol Research")](https://geosolresearch.com)
+
+# GeoSol FOSS Projects
+
+[Back to main README](README.md)
+
+GeoSol Research is working to create, maintain, and improve several FOSS projects in the geolocation space. Here is what we are currently offering!
+
+## Foundation Libraries
+
+### [GRI Utils](https://gitlab.com/geosol-foss/python/gri-utils)
+
+The math back end to many other projects. This includes constants, coordinate conversion and transformation, orbit propagation, observable calculations, and geolocation algorithms. Most are based around numpy arrays.
+
+### [GRI Memoize](https://gitlab.com/geosol-foss/python/gri-memoize)
+
+Class-based memoization with full type hints and IDE integration. Provides caching decorators for performance optimization.
+
+### [GRI Fitter](https://gitlab.com/geosol-foss/python/gri-fitter)
+
+Equation fitting wrapper around scipy.optimize.curve\_fit. Simplifies curve fitting workflows with a clean API.
+
+### [GRI Plot](https://gitlab.com/geosol-foss/python/gri-plot)
+
+Plotting utilities for Plotly and Matplotlib. Provides consistent styling and common plot types for geospatial visualization.
+
+### [GRI Signal](https://gitlab.com/geosol-foss/python/gri-signal)
+
+Functional signal processing library with pure functions operating on numpy arrays. Includes filters (lowpass, bandpass, analytic), FFT metrics, PSD analysis, cross-correlation, beamforming, and signal generation utilities.
+
+## Core Libraries
+
+### [GRI Pos](https://gitlab.com/geosol-foss/python/gri-pos)
+
+A position object that greatly simplifies handling coordinates, distances, and memory, mostly on the WGS-84 ellipsoid.
+
+### [GRI Ell](https://gitlab.com/geosol-foss/python/gri-ell)
+
+An object to handle statistical locations like ellipse and ellipsoid, centered around a GRI-Position object. Transformations between statistical spaces, conversions between sigma and percentages in 2D and 3D, statistical distances, and attributes.
+
+### [GRI NSEpoch](https://gitlab.com/geosol-foss/python/gri-nsepoch)
+
+A lot of the work we do is down to nanosecond or tens of nanosecond accuracy. We needed an object that could both handle that level of precision as well as do a lot of the string <=> time conversions for the many semi-standards formats we run into in this field.
+
+### [GRI Convolve](https://gitlab.com/geosol-foss/python/gri-convolve)
+
+Ellipsoid convolution with outlier detection and clustering. Combines multiple statistical position estimates into refined solutions.
+
+## Atmospheric Libraries
+
+### [GRI Tropo](https://gitlab.com/geosol-foss/python/gri-tropo)
+
+Tropospheric delay corrections using ITU-R 2019 models and ERA5 refractivity data.
+
+### [GRI Tropo Data](https://gitlab.com/geosol-foss/python/gri-tropo-data)
+
+ERA5 data pipeline for downloading and processing tropospheric refractivity data used by gri-tropo.
+
+### [GRI Iono](https://gitlab.com/geosol-foss/python/gri-iono)
+
+Ionospheric delay corrections using Bent, IRI, and NeQuick models.
+
+### [GRI Iono Data](https://gitlab.com/geosol-foss/python/gri-iono-data)
+
+Solar flux and NeQuickG coefficient data pipeline for ionospheric modeling.
+
+## Simulation Libraries
+
+### [GRI GeoSim](https://gitlab.com/geosol-foss/python/gri-geosim)
+
+Geometric/geolocation simulation library for platforms, sensors, emitters, and observables. Simulate satellite and ground-based geolocation scenarios with AOA/TDOA/FDOA measurements.
+
+### [GRI SigSim](https://gitlab.com/geosol-foss/python/gri-sigsim)
+
+Object-based RF signal simulation library. Wraps gri-signal functions with chainable object-oriented classes for waveforms (chirp, OFDM, pulsed), channel modeling (delay, Doppler, multipath), receiver simulation, and observable extraction (TOA, FOA, AOA).
+
+## Examples and Testing
+
+### [GRI Sandbox](https://gitlab.com/geosol-foss/python/gri-sandbox)
+
+Some neat (small) examples and projects we've put together over time using the above libraries!

gri_convolve-0.2.0/.gitignore

@@ -0,0 +1,35 @@
+### Python ###
+*.py[cod]
+__pycache__/
+build/
+dist/
+wheels/
+lib/
+lib64/
+*.egg-info/
+*.egg
+.venv
+
+### Temp files ###
+*~
+*.swp
+.version
+.pytest_cache/
+.mypy_cache/
+testreports/
+.VSCodeCounter/
+.coverage
+coverage.xml
+.cov_html/
+*.pstats
+*.stats
+.claude/
+CLAUDE.md
+
+### Credentials ###
+.env*
+*.key
+*.pem
+*.p12
+.cdsapirc
+.ecmwfdatastoresrc

gri_convolve-0.2.0/.gitlab-ci-deps.yml

@@ -0,0 +1,10 @@
+# Project-specific dependencies to clone
+# Customize this file per project to clone different repositories
+# TODO: This is only a stopgap until the projects are on pypi. For projects with no
+# dependencies: "before_script: []"
+.clone_dependencies:
+  before_script:
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-ell.git ../gri-ell
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-pos.git ../gri-pos
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-utils.git ../gri-utils
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-memoize.git ../gri-memoize

gri_convolve-0.2.0/.gitlab-ci.yml

@@ -0,0 +1,95 @@
+include:
+  - local: .gitlab-ci-deps.yml
+
+stages:
+  - test
+  - lint
+  - deploy
+
+variables:
+  UV_CACHE_DIR: "$CI_PROJECT_DIR/.uv-cache"
+  COVERAGE_THRESHOLD: "70"
+
+cache:
+  key: "${CI_COMMIT_REF_SLUG}"
+  paths:
+    - .uv-cache/
+    - .venv/
+
+.python_base:
+  image: python:3.14
+  before_script:
+    # TODO: This reference and include is a stopgap until we have the projects on pypi
+    - !reference [.clone_dependencies, before_script]
+    - pip install uv
+    - uv sync
+    - source .venv/bin/activate
+
+test:
+  extends: .python_base
+  stage: test
+  script:
+    - pytest --cov --cov-report=term --cov-report=html --cov-report=xml --junitxml=report.xml -v
+  coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
+  artifacts:
+    when: always
+    reports:
+      junit: report.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+    paths:
+      - report.xml
+      - .cov_html/
+      - coverage.xml
+    expire_in: 30 days
+  only:
+    - branches
+    - merge_requests
+    - tags
+
+lint:ruff:
+  extends: .python_base
+  stage: lint
+  script:
+    - ruff check . --config .ruff.toml
+    - ruff format --check . --config .ruff.toml
+  allow_failure: false
+  only:
+    - branches
+    - merge_requests
+    - tags
+
+lint:pyright:
+  extends: .python_base
+  stage: lint
+  variables:
+    PYRIGHT_PYTHON_FORCE_VERSION: latest
+  script:
+    - pyright
+  allow_failure: false
+  only:
+    - branches
+    - merge_requests
+    - tags
+
+deploy:pypi:
+  stage: deploy
+  image: python:3.14
+  id_tokens:
+    PYPI_ID_TOKEN:
+      aud: pypi
+  variables:
+    UV_CACHE_DIR: /tmp/uv-cache
+  cache: []
+  before_script:
+    - pip install uv
+  script:
+    - uv build
+    - uv publish
+  artifacts:
+    paths:
+      - dist/
+    expire_in: 1 week
+  only:
+    - tags

gri_convolve-0.2.0/.init_venv.sh

@@ -0,0 +1,82 @@
+# Source this file to set up the virtual environment
+#
+# > . .init_venv.sh
+#
+# To be used with our uv-based setup. Assumes python version and all dependencies are
+# in pyproject.toml. Will finalize uv.sources editable libraries with uv pip compat.
+#
+# Once this has been done once, you can just use the normal virtual environment's
+# 'activate' command to re-renter the virtual environment.
+#
+# You can also re-source this file to reinstall / update the project. Calls 'uv sync'
+# and re-updates editable sources.
+
+# Text output highlighting
+bold=$(tput bold)
+normal=$(tput sgr0)
+
+VENV=".venv"
+export PYRIGHT_PYTHON_FORCE_VERSION=latest
+
+# Make sure we're out of any venvs
+deactivate &> /dev/null
+
+# Find if we have any editable local paths
+regex="\{ *path *= *\".*\",.* *editable *= *true *\}"
+MATCHES=$(grep -oP "$regex" pyproject.toml)
+if [[ -n $MATCHES ]]; then
+    # We have locally editable installs. Check for editable mode setting
+    grep "config-settings *= *{ *editable_mode *= *\"compat\" *}" pyproject.toml > /dev/null
+    if [ $? -ne 0 ]; then
+        echo "${bold}ERROR: Locally editable package requested, but incorrect toml config${normal}"
+        echo
+        echo "Add to pyproject.toml:"
+        echo
+        echo "[tool.uv]"
+        echo "config-settings = { editable_mode = \"compat\" }"
+        echo
+        return 1
+    fi
+fi
+
+# Sync with uv
+echo "${bold}Syncing environment${normal}"
+# Check if installed
+which uv &> /dev/null
+if [ $? -ne 0 ]; then
+    while true; do
+        read -p "uv is not installed. Install it now? (y/n) " yn
+        case $yn in
+            [yY] )
+                break
+                ;;
+            [nN] )
+                echo "Exiting ..."
+                return 1
+                ;;
+            * )
+                echo "Invalid response. Please enter 'y' or 'n'"
+                ;;
+        esac
+    done
+    echo "Installing uv ..."
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+    . $HOME/.local/bin/env
+fi
+uv sync
+
+# activate and print version
+echo "${bold}Activating environment${normal}"
+. $VENV/bin/activate
+$VENV/bin/python --version
+
+# Install pre-commit scripts
+echo "${bold}Installing git hooks${normal}"
+pre-commit install
+if [ $? -ne 0 ]; then
+    return 1
+fi
+
+# print final hints
+echo
+echo "$VENV activated. To deactivate, use ${bold}\"deactivate\".${normal}"

gri_convolve-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/gitleaks/gitleaks
+  rev: v8.24.3
+  hooks:
+    - id: gitleaks
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  # Base pre-commit-provided hooks
+  rev: v6.0.0
+  hooks:
+    - id: trailing-whitespace
+      args: [ --markdown-linebreak-ext=md ]
+      exclude: '\.dt[012]$'
+    - id: end-of-file-fixer
+      exclude: '\.dt[012]$'
+    - id: check-added-large-files
+- repo: local
+  hooks:
+    - id: ruff-check
+      name: ruff check
+      entry: ruff check --fix --config .ruff.toml
+      language: system
+      types: [python]
+    - id: ruff-format
+      name: ruff format
+      entry: ruff format
+      language: system
+      types: [python]
+    - id: pyright
+      name: pyright
+      entry: pyright
+      language: system
+      types: [python]
+    - id: unskipped
+      name: Check for pytest skipped tests commented back in
+      entry: python .pre-commit-unskipped.py
+      language: system
+      files: '\.py$'
+      stages: [pre-commit]

gri_convolve-0.2.0/.pre-commit-unskipped.py

@@ -0,0 +1,38 @@
+# ruff: noqa: T201
+"""Find all the unit tests and make sure none of the skips are commented in!
+
+You can run this manually with:
+> python .pre-commit-noskips.py
+"""
+
+import sys
+from pathlib import Path
+
+
+def _main() -> None:
+    # Get the test directory, which should be adjascent to this script
+    script_dir = Path(__file__)
+    test_dir = script_dir.parent / "test"
+    if not test_dir.exists():
+        print("WARNING::: Didn't find a test directory!")
+        sys.exit(0)
+    tests = test_dir.rglob("test*.py")
+    found = False
+    for testfile in tests:
+        with testfile.open("r") as fp:
+            for idx, line in enumerate(fp, 1):
+                if line.strip().startswith("#") and (
+                    "pytest.skip" in line or "pytest.mark.skip" in line
+                ):
+                    print(
+                        f"ERROR::: Line {idx} of {testfile.relative_to(test_dir)} "
+                        "has a skip commented out:",
+                    )
+                    print(f" {idx}: {line}")
+                    found = True
+    if found:
+        sys.exit(1)  # Error4 aborts the commit
+
+
+if __name__ == "__main__":
+    _main()

gri_convolve-0.2.0/.python-version

@@ -0,0 +1 @@
+3.14

gri_convolve-0.2.0/.ruff.toml

@@ -0,0 +1,60 @@
+extend = "pyproject.toml"
+
+[lint]
+select = ["ALL"]
+#select = [
+#    # pycodestyle
+#    "E",
+#    # Pyflakes
+#    "F",
+#    # pyupgrade
+#    "UP",
+#    # flake8-bugbear
+#    "B",
+#    # flake8-simplify
+#    "SIM",
+#    # isort
+#    "I",
+#    # docstring
+#    "D",
+#    # TODO
+#    "TD",
+#]
+
+ignore = [
+    "D105",   # Do not require magic method documentation
+    "ANN002", # Allow non-typed *args
+    "ANN003", # Allow non-typed **kwargs
+    "ANN204", # Do not require magic method documentation
+    "CPY",    # Copyright notices
+    "EM101",  # raw string in exception
+    "EM102",  # fstrings in exceptions
+    "ERA001", # allow commented out code
+    "PERF203",# allow try-except in loops
+    "TRY003", # raise vanilla
+    "TD002",  # TODO author
+    "TD003",  # TODO link
+    "TD004",  # TODO colon
+    "FIX001", # Fixme
+    "FIX002", # TODO
+]
+
+[lint.extend-per-file-ignores]
+"test/**/*.py" = [
+    "D100",    # undocumented public module
+    "D103",    # undocumented public function
+    "D104",    # undocumented public package
+    "ANN001",  # no type annotations for function arguments
+    "ANN201",  # no return type for public function
+    "S101",    # asserts allowed
+    "SLF001",  # Allow private member access in unit tests
+    "PLR2004", # magic values allowed in comparisons
+    "PT011",   # pytest.raises can be broad
+    "PT013",   # allow sub-imports of pytest
+    "PLR0913", # allow many arguments in parameterized tests
+]
+
+[lint.pydocstyle]
+convention = "google"
+ignore-var-parameters = true
+ignore-decorators = ["typing.overload"]

gri_convolve-0.2.0/.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+  "python.testing.pytestArgs": ["test"],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true,
+  "editor.rulers": [88],
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
+      "source.organizeImports.ruff": "explicit"
+    }
+  },
+  "ruff.interpreter": ["${workspaceFolder}/.venv/bin/python"]
+}

gri_convolve-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,113 @@
+# Contributing
+
+Thanks for your interest in contributing! This guide covers everything you need
+to get started.
+
+## Setup
+
+Requires **Python 3.14+** and **bash**.
+
+```bash
+git clone <repo-url>
+cd <repo>
+. .init_venv.sh
+```
+
+This creates a virtual environment with [uv](https://docs.astral.sh/uv/),
+installs all dependencies (including editable local siblings), and sets up
+pre-commit hooks. After the first run you can just activate the existing
+environment:
+
+```bash
+source .venv/bin/activate
+```
+
+To start fresh, delete `.venv/` and re-source `.init_venv.sh`.
+
+## Running Tests
+
+[pytest](https://docs.pytest.org/) with
+[pytest-cov](https://pypi.org/project/pytest-cov/) for coverage:
+
+```bash
+pytest --cov                    # terminal summary
+pytest --cov --cov-report html  # detailed HTML report in .cov_html/
+```
+
+CI requires **70% minimum** coverage. Open the HTML report to see exactly which
+lines are covered:
+
+```bash
+xdg-open .cov_html/index.html  # or: google-chrome, firefox
+```
+
+## Linting and Type Checking
+
+### Ruff
+
+[Ruff](https://docs.astral.sh/ruff/) handles both linting and formatting. The
+configuration selects **all rules** (`select = ["ALL"]`) with a small ignore
+list in `.ruff.toml`.
+
+```bash
+ruff check     # lint
+ruff format    # format
+```
+
+### Pyright
+
+[Pyright](https://microsoft.github.io/pyright/#/) for static type checking:
+
+```bash
+pyright
+```
+
+### Pre-commit
+
+All of the above run automatically on `git commit` via
+[pre-commit](https://pre-commit.com/). If the commit fails, fix the issues,
+re-stage, and commit again.
+
+```bash
+pre-commit run --all-files  # run manually against everything
+```
+
+> **Tip:** To force a commit past hooks (e.g. work-in-progress), use
+> `git commit -n`. CI will still enforce the same checks.
+
+## Code Style
+
+- **Docstrings**: [Google convention](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
+- **Type hints**: Required on all public function signatures
+- **Line length**: 88 characters max
+- **Formatting**: Let `ruff format` handle it
+- **Imports**: All at the top of the file, organized by ruff's isort rules
+
+## Submitting Changes
+
+1. Create a branch from `main`
+2. Make your changes with tests
+3. Ensure `pytest --cov` passes with >= 70% coverage
+4. Ensure `pre-commit run --all-files` passes
+5. Open a merge request against `main`
+
+## IDE Setup (VS Code)
+
+Install the [Ruff extension](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)
+by Astral and add to your `settings.json`:
+
+```json
+{
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
+      "source.organizeImports.ruff": "explicit"
+    }
+  },
+  "ruff.interpreter": ["${workspaceFolder}/.venv/bin/python"]
+}
+```
+
+Pyright is included in VS Code's Pylance extension by default.

gri_convolve-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 GeoSol Research Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.