gri-multitrack 0.1.0__tar.gz

gri_multitrack-0.1.0/.docs_other_projects.md

@@ -0,0 +1,85 @@
+[![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!
+
+## Layer 1: Foundation
+
+### [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 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 Signal](https://gitlab.com/geosol-foss/python/gri-signal)
+
+Functional signal processing library with pure functions operating on numpy arrays. Includes signal generation (tones, PRN, pulsed), channel simulation (delay, AWGN, Doppler, multipath), modulation (AM/FM/PM, BPSK/QPSK/QAM), sampling (ADC), filtering (lowpass, highpass, bandpass, notch, analytic), spectral analysis (PSD, SNR, THD, time-bandwidth product), cross-correlation, and beamforming.
+
+### [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.
+
+## Layer 2: Mid-Level
+
+### [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 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.
+
+### [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 Obs](https://gitlab.com/geosol-foss/python/gri-obs)
+
+Typed observation objects (TDOA, FDOA, AOA, Range, PDOA) for geolocation measurements. Each observation carries measurement data, noise characterization, sensor geometry, and measurement math (predicted values, Jacobians, noise covariance) for EKF integration with Kalman filters.
+
+### [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 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 Terrain](https://gitlab.com/geosol-foss/python/gri-terrain)
+
+Unified terrain elevation data access with fallback chain across multiple sources including DTED, Cloud-Optimized GeoTIFF, and Copernicus DEM.
+
+### [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.
+
+## Layer 3: Applications
+
+### [GRI Convolve](https://gitlab.com/geosol-foss/python/gri-convolve)
+
+Ellipsoid convolution with outlier detection and clustering, plus Kalman tracking via Interacting Multiple Model (IMM) filter. Combines multiple statistical position estimates into refined solutions. The Kalman tracker supports both ellipsoid-based and raw observable (EKF) updates, bidirectional outlier detection, and online track segmentation.
+
+### [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 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 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 (pulsed, PRN, tone), channel modeling (delay, Doppler, multipath), receiver simulation, and TOA estimation.

gri_multitrack-0.1.0/.githooks/pre-push

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+# Tracked pre-push hook. Wired up automatically by the hatch build hook on
+# `uv sync` (it sets core.hooksPath to this directory). Delegates to pre-commit
+# in the project's .venv. Unlike a `pre-commit install` generated hook, the
+# python path is resolved at run time, so this file is portable across clones.
+ARGS=(hook-impl --config=.pre-commit-config.yaml --hook-type=pre-push)
+HERE="$(cd "$(dirname "$0")" && pwd)"
+ARGS+=(--hook-dir "$HERE" -- "$@")
+
+INSTALL_PYTHON="$(git rev-parse --show-toplevel)/.venv/bin/python"
+if [ -x "$INSTALL_PYTHON" ]; then
+    exec "$INSTALL_PYTHON" -mpre_commit "${ARGS[@]}"
+elif command -v pre-commit > /dev/null; then
+    exec pre-commit "${ARGS[@]}"
+else
+    echo '`pre-commit` not found. Run `uv sync` to set up the environment.' 1>&2
+    exit 1
+fi

gri_multitrack-0.1.0/.gitignore

@@ -0,0 +1,36 @@
+### 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
+AGENTS.md
+
+### Credentials ###
+.env*
+*.key
+*.pem
+*.p12
+.cdsapirc
+.ecmwfdatastoresrc

gri_multitrack-0.1.0/.gitlab-ci-deps.yml

@@ -0,0 +1,18 @@
+# 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-utils.git ../gri-utils
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-memoize.git ../gri-memoize
+    - 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-ell.git ../gri-ell
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-nsepoch.git ../gri-nsepoch
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-tropo.git ../gri-tropo
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-iono.git ../gri-iono
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-obs.git ../gri-obs
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-convolve.git ../gri-convolve
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-kalman.git ../gri-kalman
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-trajectory.git ../gri-trajectory
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/geosol-foss/python/gri-geosim.git ../gri-geosim

gri_multitrack-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,99 @@
+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.12
+  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:ty:
+  extends: .python_base
+  stage: lint
+  script:
+    - ty check --output-format gitlab --exit-zero > ty-report.json
+    - ty check
+  allow_failure: false
+  artifacts:
+    when: always
+    reports:
+      codequality: ty-report.json
+    expire_in: 30 days
+  only:
+    - branches
+    - merge_requests
+    - tags
+
+deploy:pypi:
+  stage: deploy
+  image: python:3.12
+  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_multitrack-0.1.0/.hatch_build.py

@@ -0,0 +1,46 @@
+"""Custom hatchling build hook that wires up the project's git hooks.
+
+`uv sync` installs this project in editable mode, which runs the hatchling
+build backend and therefore this hook. The hook points git's ``core.hooksPath``
+at the tracked ``.githooks`` directory, so a fresh clone gets working git hooks
+on its first sync without a separate install step.
+
+This only adjusts local git config and is a no-op outside a git work tree (for
+example, in an isolated sdist/wheel build), so it is safe in CI release builds.
+"""
+
+import shutil
+import subprocess
+from pathlib import Path
+from typing import Any
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+class GitHooksBuildHook(BuildHookInterface):
+    """Set ``core.hooksPath`` to the tracked ``.githooks`` directory."""
+
+    PLUGIN_NAME = "custom"
+
+    def initialize(self, version: str, build_data: dict[str, Any]) -> None:  # noqa: ARG002
+        """Point git at ``.githooks`` if this build runs inside a work tree."""
+        root = Path(self.root)
+        git = shutil.which("git")
+        if git is None or not (root / ".githooks").is_dir():
+            return
+        # Only act inside a real git work tree; check=False keeps release
+        # builds (sdist/wheel in a non-git temp dir) from failing.
+        inside = subprocess.run(  # noqa: S603
+            [git, "rev-parse", "--is-inside-work-tree"],
+            cwd=root,
+            capture_output=True,
+            text=True,
+            check=False,
+        )
+        if inside.stdout.strip() != "true":
+            return
+        subprocess.run(  # noqa: S603
+            [git, "config", "core.hooksPath", ".githooks"],
+            cwd=root,
+            check=False,
+        )

gri_multitrack-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,47 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+# Checks run at pre-push (not pre-commit): commits stay fast, the suite runs
+# once before code is shared. Hooks are wired up automatically on `uv sync`
+# (see .hatch_build.py), so no separate `pre-commit install` step is needed.
+default_stages: [pre-push]
+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: uv run --no-sync ruff check --fix --config .ruff.toml
+      language: system
+      types: [python]
+    - id: ruff-format
+      name: ruff format
+      entry: uv run --no-sync ruff format
+      language: system
+      types: [python]
+    - id: ty
+      name: ty
+      entry: uv run --no-sync ty check
+      language: system
+      types: [python]
+      # ty's [tool.ty.src] include scoping is overridden by explicit file
+      # args; run without filenames so it checks the configured source set
+      # (matching CI) instead of, say, test files passed in by pre-commit.
+      pass_filenames: false
+    - id: unskipped
+      name: Check for pytest skipped tests commented back in
+      entry: uv run --no-sync python .pre-commit-unskipped.py
+      language: system
+      files: '\.py$'

gri_multitrack-0.1.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_multitrack-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

gri_multitrack-0.1.0/.ruff.toml

@@ -0,0 +1,52 @@
+extend = "pyproject.toml"
+
+line-length = 88
+
+[lint]
+select = ["ALL"]
+
+ignore = [
+    "COM812", # conflicts with the ruff formatter (trailing comma)
+    "ISC001", # conflicts with the ruff formatter (implicit str concat)
+    "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
+    "ANN202",  # no return type for private test helpers
+    "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
+]
+"examples/**/*.py" = [
+    "D100",
+    "INP001",  # examples are not a package
+    "T201",    # allow print in examples
+]
+
+[lint.pydocstyle]
+convention = "google"
+ignore-var-parameters = true
+ignore-decorators = ["typing.overload"]

gri_multitrack-0.1.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_multitrack-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,124 @@
+# Contributing
+
+Thanks for your interest in contributing! This guide covers everything you need
+to get started.
+
+## Setup
+
+Requires **Python 3.12+** and **bash**.
+
+```bash
+git clone <repo-url>
+cd <repo>
+uv sync
+```
+
+`uv sync` creates a virtual environment with [uv](https://docs.astral.sh/uv/),
+installs all dependencies (including any editable local siblings), and wires up
+the git hooks automatically: a [hatchling](https://hatch.pypa.io/) build hook
+(`.hatch_build.py`) runs during the editable install and points
+`core.hooksPath` at the tracked `.githooks/` directory. No separate
+`pre-commit install` step is needed. To run commands in the environment, prefix
+them with `uv run` (for example `uv run pytest`), or activate it with
+`source .venv/bin/activate`.
+
+To start fresh, delete `.venv/` and run `uv sync` again.
+
+> **Note (editable local siblings):** some `gri-*` projects depend on sibling
+> packages as editable path sources. uv requires `[tool.uv]`
+> `config-settings = { editable_mode = "compat" }` in `pyproject.toml` for those
+> to import correctly. If a project declares editable path dependencies and
+> imports fail, verify that setting is present.
+
+## 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
+```
+
+### ty
+
+[ty](https://docs.astral.sh/ty/) for static type checking:
+
+```bash
+ty check
+```
+
+### Pre-push hooks
+
+All of the above run automatically on `git push` via
+[pre-commit](https://pre-commit.com/) (configured for the `pre-push` stage, so
+commits stay fast). If the push fails, fix the issues, commit the fix, and push
+again.
+
+```bash
+uv run pre-commit run --all-files --hook-stage pre-push  # run manually
+```
+
+> **Tip:** To force a push past the hooks (e.g. a work-in-progress branch), use
+> `git push --no-verify`. 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 `uv run pre-commit run --all-files --hook-stage pre-push` 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"]
+}
+```
+
+For type checking in VS Code, install the
+[ty extension](https://marketplace.visualstudio.com/items?itemName=astral-sh.ty)
+by Astral. To avoid conflicts with Pylance, either let ty disable the Python
+language server (the default) or keep Pylance and set
+`"ty.disableLanguageServices": true` to use ty for diagnostics only.