Develop/dcb correction

.github/workflows/pypi-publish.yml → .github/workflows/release.yml

@@ -1,13 +1,67 @@
-name: Build and publish to PyPI
+name: Release and Publish
 
 on:
   push:
     tags:
-      # Trigger on version tags like v1.0.0
+      # Trigger on version tags like v1.2.3
       - v*
 
+env:
+  PYTHON_VERSION: "3.13"
+  FREE_THREADED_PYTHON_VERSION: "3.13t"
+
 jobs:
+  release:
+    name: Create Github release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Extract Unreleased section from CHANGELOG.md
+        id: extract_changelog
+        shell: bash
+        run: |
+          body=$(awk '
+          /^## \[Unreleased\]/ { flag=1; next }
+          /^## \[/ && flag { exit }
+
+          flag {
+            lines[++n] = $0
+          }
+
+          END {
+            if (n == 0) exit 0
+
+            start = 1
+            while (start <= n && lines[start] ~ /^[[:space:]]*$/) start++
+
+            end = n
+            while (end >= start && lines[end] ~ /^[[:space:]]*$/) end--
+
+            if (end < start) exit 0
+
+            for (i = start; i <= end; i++) {
+              print lines[i]
+            }
+          }' CHANGELOG.md)
+
+          echo 'body<<EOF' >> $GITHUB_OUTPUT
+          printf '%s\n' "$body" >> $GITHUB_OUTPUT
+          echo 'EOF' >> $GITHUB_OUTPUT
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          body: ${{ steps.extract_changelog.outputs.body }}
+          prerelease: false
+          draft: true
+
   linux:
+    name: Build wheels for Linux
     runs-on: ubuntu-latest
 
     strategy:
@@ -22,14 +76,14 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.target }}
-          args: --release --out dist -i python3.13
+          args: --release --out dist -i python${{ env.PYTHON_VERSION }}
           manylinux: manylinux_2_28
 
       - name: Build free-threaded wheels
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.target }}
-          args: --release --out dist -i python3.13t
+          args: --release --out dist -i python${{ env.FREE_THREADED_PYTHON_VERSION }}
           manylinux: manylinux_2_28
 
       - name: Upload wheels
@@ -39,6 +93,7 @@ jobs:
           path: dist
 
   musllinux:
+    name: Build wheels for Musl Linux
     runs-on: ubuntu-latest
 
     strategy:
@@ -53,14 +108,14 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.target }}
-          args: --release --out dist -i python3.13
+          args: --release --out dist -i python${{ env.PYTHON_VERSION }}
           manylinux: musllinux_1_2
 
       - name: Build free-threaded wheels
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.target }}
-          args: --release --out dist -i python3.13t
+          args: --release --out dist -i python${{ env.FREE_THREADED_PYTHON_VERSION }}
           manylinux: musllinux_1_2
 
       - name: Upload wheels
@@ -70,6 +125,7 @@ jobs:
           path: dist
 
   windows:
+    name: Build wheels for Windows
     runs-on: windows-latest
 
     strategy:
@@ -80,10 +136,10 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v6
 
-      - name: Setup Python 3.13
+      - name: Setup Python ${{ env.PYTHON_VERSION }}
         uses: actions/setup-python@v6
         with:
-          python-version: "3.13"
+          python-version: ${{ env.PYTHON_VERSION }}
           architecture: ${{ matrix.target }}
 
       - name: Build wheels
@@ -92,17 +148,17 @@ jobs:
           target: ${{ matrix.target }}
           args: --release --out dist
 
-      - name: Setup Python 3.13t
+      - name: Setup Python ${{ env.FREE_THREADED_PYTHON_VERSION }}
         uses: actions/setup-python@v6
         with:
-          python-version: "3.13t"
+          python-version: ${{ env.FREE_THREADED_PYTHON_VERSION }}
           architecture: ${{ matrix.target }}
 
       - name: Build free-threaded wheels
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.target }}
-          args: --release --out dist -i python3.13t
+          args: --release --out dist -i python${{ env.FREE_THREADED_PYTHON_VERSION }}
 
       - name: Upload wheels
         uses: actions/upload-artifact@v5
@@ -111,6 +167,7 @@ jobs:
           path: dist
 
   macos:
+    name: Build wheels for macOS
     runs-on: macos-latest
 
     strategy:
@@ -121,27 +178,27 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v6
 
-      - name: Setup Python 3.13
+      - name: Setup Python ${{ env.PYTHON_VERSION }}
         uses: actions/setup-python@v6
         with:
-          python-version: "3.13"
+          python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.target }}
-          args: --release --out dist -i python3.13
+          args: --release --out dist -i python${{ env.PYTHON_VERSION }}
 
-      - name: Setup Python 3.13t
+      - name: Setup Python ${{ env.FREE_THREADED_PYTHON_VERSION }}
         uses: actions/setup-python@v6
         with:
-          python-version: "3.13t"
+          python-version: ${{ env.FREE_THREADED_PYTHON_VERSION }}
 
       - name: Build free-threaded wheels
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.target }}
-          args: --release --out dist -i python3.13t
+          args: --release --out dist -i python${{ env.FREE_THREADED_PYTHON_VERSION }}
 
       - name: Upload wheels
         uses: actions/upload-artifact@v5
@@ -150,6 +207,7 @@ jobs:
           path: dist
 
   sdist:
+    name: Build sdist
     runs-on: ubuntu-latest
 
     steps:
@@ -168,8 +226,8 @@ jobs:
           name: wheels-sdist
           path: dist
 
-  release:
-    name: Release
+  publish:
+    name: Collect artifacts and publish to PyPI
     runs-on: ubuntu-latest
     needs: [linux, musllinux, windows, macos, sdist]
     environment: pypi

.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: CI - Pytest
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+  workflow_dispatch: {}
+
+jobs:
+  pytest:
+    name: Run tests on ${{ matrix.os }} with Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Check using ruff
+        run: uv run ruff check .
+
+      - name: Run tests
+        run: uv run pytest

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- `calc_tec` function to calculate TEC from RINEX observation and navigation files
+- Support using single layer model (SLM) to map slant TEC to vertical TEC
+- Support DCB bias correction using external bias files
+
+## [0.1.0](https://github.com/Eureka-0/pygnss-tec/releases/tag/v0.1.0) - 2025-11-24
+
+### Added
+
+- Initial release of pygnss-tec
+- `read_rinex_obs` function that supports reading observation RINEX files and automatically calculating azimuth and elevation angles when navigation RINEX files are provided

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Xinlong Liu.
+Copyright (c) 2025 Xinlong Liu
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,9 @@
 # PyGNSS-TEC
 
 [![PyPI - Version](https://img.shields.io/pypi/v/pygnss-tec)](https://pypi.org/project/pygnss-tec/)
-![Supported Python Versions](https://img.shields.io/badge/python-%3E%3D3.9-blue)
+![Supported Python Versions](https://img.shields.io/badge/python-%3E%3D3.10-blue)
 ![License](https://img.shields.io/badge/license-MIT-blue)
-[![Pytest](https://github.com/Eureka-0/pygnss-tec/actions/workflows/pytest.yml/badge.svg)](https://github.com/Eureka-0/pygnss-tec/actions/workflows/pytest.yml)
+[![Test](https://github.com/Eureka-0/pygnss-tec/actions/workflows/test.yml/badge.svg)](https://github.com/Eureka-0/pygnss-tec/actions/workflows/test.yml)
 
 PyGNSS-TEC is a high-performance Python package leveraging Rust acceleration, designed for processing and analyzing Total Electron Content (TEC) data derived from Global Navigation Satellite System (GNSS) observations. The package provides tools for RINEX file reading, TEC calculation, and DCB correction to support ionospheric studies.
 

gnss_tec/rinex/read_rinex.py

@@ -60,7 +60,7 @@ def _handle_fn(fn: str | Path | Iterable[str | Path]) -> list[str]:
         fn_list = [str(f) for f in fn]
     else:
         raise TypeError(
-            f"The file path must be a str, Path, or an iterable of str/Path, not {fn}."
+            f"The file path must be a str, Path, or Iterable of str/Path, not {fn}."
         )
 
     for f in fn_list:
@@ -94,6 +94,7 @@ def read_rinex_obs(
     t_lim: tuple[str | None, str | None] | list[str | None] | None = None,
     codes: Iterable[str] | None = None,
     *,
+    pivot: bool = True,
     lazy: Literal[True],
 ) -> tuple[RinexObsHeader, pl.LazyFrame]: ...
 
@@ -106,6 +107,7 @@ def read_rinex_obs(
     t_lim: tuple[str | None, str | None] | list[str | None] | None = None,
     codes: Iterable[str] | None = None,
     *,
+    pivot: bool = True,
     lazy: Literal[False] = False,
 ) -> tuple[RinexObsHeader, pl.DataFrame]: ...
 
@@ -117,6 +119,7 @@ def read_rinex_obs(
     t_lim: tuple[str | None, str | None] | list[str | None] | None = None,
     codes: Iterable[str] | None = None,
     *,
+    pivot: bool = True,
     lazy: bool = False,
 ) -> tuple[RinexObsHeader, pl.DataFrame | pl.LazyFrame]:
     """Read RINEX observation file into a Polars DataFrame.
@@ -142,7 +145,12 @@ def read_rinex_obs(
         codes (Iterable[str] | None, optional): Specific observation codes to extract
             (e.g., ['C1C', 'L1C']). If None, all available observation types are
             included. Defaults to None.
-        lazy (bool, optional): Whether to return a `polars.LazyFrame`. Defaults to True.
+        pivot (bool, optional): Whether to pivot the DataFrame so that each observation
+            type has its own column. If False, the DataFrame will be in long format with
+            'Code' and 'Value' columns. Pivoted format is generally more convenient for
+            analysis and has better performance. Defaults to True.
+        lazy (bool, optional): Whether to return a `polars.LazyFrame`. Defaults to
+            False.
 
     Returns:
         (RinexObsHeader, pl.DataFrame | pl.LazyFrame): A Dataclass containing metadata from the RINEX observation file header and a DataFrame or LazyFrame containing the RINEX observation data with following columns.
@@ -184,7 +192,8 @@ def read_rinex_obs(
         nav_fn=nav_fn_list,
         constellations=constellations,
         t_lim=tuple(t_lim),
-        codes=codes if codes is None else list(set(codes)),
+        codes=None if codes is None else list(set(codes)),
+        pivot=pivot,
     )
     codes = list(filter(lambda x: re.match(r"[A-Z]\d{1}[A-Z]$", x), result.keys()))
     ordered_cols = ["Time", "Station", "PRN"]
@@ -200,7 +209,10 @@ def read_rinex_obs(
         result["Azimuth"], result["Elevation"], _ = pm.ecef2aer(
             nav_x, nav_y, nav_z, rx_lat, rx_lon, rx_alt, deg=True
         )
-    ordered_cols += sorted(codes)
+    if pivot:
+        ordered_cols += sorted(codes)
+    else:
+        ordered_cols += ["Code", "Value"]
 
     header = RinexObsHeader(
         version=result.pop("Version"),