gnsskit 0.4.0__tar.gz → 0.4.2__tar.gz

gnsskit-0.4.2/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: gnsskit
+Version: 0.4.2
+Summary: RTKLIB-based GNSS post-processing toolkit: RINEX tools, RTKLIB wrappers, static baselines and network adjustment, kinematic trajectories
+Keywords: gnss,gps,rtklib,ppk,surveying,least-squares
+Author: Francesco Ioli
+Author-email: Francesco Ioli <francesco.ioli@polimi.it>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Dist: numpy
+Requires-Dist: pandas>=2
+Requires-Dist: scipy ; extra == 'all'
+Requires-Dist: pyproj ; extra == 'all'
+Requires-Dist: matplotlib ; extra == 'all'
+Requires-Dist: scipy ; extra == 'network'
+Requires-Dist: pyproj ; extra == 'network'
+Requires-Dist: matplotlib ; extra == 'plot'
+Requires-Python: >=3.10
+Project-URL: Repository, https://github.com/franioli/gnsskit
+Project-URL: Issues, https://github.com/franioli/gnsskit/issues
+Provides-Extra: all
+Provides-Extra: network
+Provides-Extra: plot
+Description-Content-Type: text/markdown
+
+# gnsskit
+
+Shared tools for post-processing GNSS data with [RTKLIB](https://www.rtklib.com/) `rnx2rtkp`, used by
+[djippk](https://github.com/franioli/djippk) (drone PPK) and [stopgo](https://github.com/franioli/stopgo)
+(stop-and-go surveys).
+
+> [!IMPORTANT]
+> **RTKLIB is not included and must be installed separately.** gnsskit runs the RTKLIB
+> command-line program `rnx2rtkp` (the CLI of RTKPOST) for the GNSS processing; `pip`/`uv` do
+> not install it. See [RTKLIB](#rtklib-required-separately) below.
+
+- **RTKLIB wrappers** (`gnsskit.rtklib`): `RtkConfig`, a typed, immutable set of `rnx2rtkp` options
+  (`from_file`, `updated`, `with_options`, `with_base_llh`, `write`); `run_rnx2rtkp` and `find_rnx2rtkp`;
+  `read_pos` (llh, xyz and enu `.pos` files).
+- **RINEX** (`gnsskit.rinex`): `rinex_span`, `header_llh`, `trim_rinex`; inspection with `obs_summary`
+  (span, sampling, gaps, satellites), `read_visibility` and `plot_visibility` (RTKPLOT-style satellite
+  visibility, needs the `plot` extra).
+- **Static** (`gnsskit.static`): `solve_static` (one solution over a time window), `process_baseline`
+  (static baselines with covariance), baseline IO and `loop_closures` (misclosure of every triangle of baselines); least-squares adjustment of a redundant baseline
+  network in `gnsskit.static.network` (needs the `network` extra).
+- **Kinematic** (`gnsskit.kinematic`): trajectory interpolation and averaging.
+- **Reference systems** (`gnsskit.refsys`): GPST/UTC, ellipsoids, ECEF/geodetic conversions and
+  `ENUFrame`, a local east-north-up frame at a point (points, vectors and covariances, both ways).
+
+## Install
+
+With [uv](https://docs.astral.sh/uv/) (recommended), in your project:
+
+```sh
+uv add gnsskit                  # library
+uv add "gnsskit[network]"       # + network adjustment (scipy, pyproj)
+uv add "gnsskit[network,plot]"  # + satellite visibility plots (matplotlib)
+uv add "gnsskit[all]"           # every extra
+uv add git+https://github.com/franioli/gnsskit   # development version
+```
+
+or in an existing environment, `uv pip install gnsskit` (same extras).
+
+With pip:
+
+```sh
+pip install gnsskit
+pip install "gnsskit[all]"   # with every extra
+```
+
+### RTKLIB (required separately)
+
+The processing functions (`run_rnx2rtkp`, `process_baseline`, `solve_static`) call the RTKLIB
+command-line program **`rnx2rtkp`**, which must be installed on your system and found on your
+`PATH` (or passed with `exe=`); `trim_rinex(use_convbin=True)` also needs RTKLIB `convbin`.
+The [demo5 fork](https://github.com/rtklibexplorer/RTKLIB) is
+recommended; gnsskit is developed with `rnx2rtkp ver.EX 2.5.1`.
+
+- **Windows**: download a [demo5 release](https://github.com/rtklibexplorer/RTKLIB/releases),
+  unzip it and add the folder with `rnx2rtkp.exe` to your `PATH`.
+- **Linux / macOS**: build it from source:
+  ```sh
+  git clone https://github.com/rtklibexplorer/RTKLIB
+  cd RTKLIB/app/consapp/rnx2rtkp/gcc && make && sudo make install
+  ```
+
+Check it with `rnx2rtkp -?`. If it is missing, `run_rnx2rtkp` raises an error with these
+instructions. The rest of gnsskit (RINEX tools, `read_pos`, loop closures, network adjustment,
+reference systems) is pure Python and works without RTKLIB, e.g. on baselines computed elsewhere.
+
+## Example
+
+```python
+from gnsskit import RtkConfig, read_pos, run_rnx2rtkp
+
+config = RtkConfig(posmode="static", navsys="GEC", solformat="llh").with_base_llh(46.2, 9.8, 2300.0)
+pos_file = run_rnx2rtkp(rover_obs, base_obs, [nav], config, "out.pos")
+pos = read_pos(pos_file)
+```
+
+See [example/](https://github.com/franioli/gnsskit/tree/main/example) for complete static, kinematic and network adjustment examples.
+
+## Contributing
+
+Issues are welcome on [GitHub](https://github.com/franioli/gnsskit/issues). To contribute code:
+
+1. Fork the repository on GitHub and clone your fork:
+   ```sh
+   git clone https://github.com/<your-username>/gnsskit && cd gnsskit
+   git checkout -b my-feature
+   ```
+2. Set up the environment, make your changes and check them:
+   ```sh
+   uv sync                      # environment with the dev dependencies (incl. ruff)
+   uv run pytest                # tests
+   uv run ruff format .         # format the code
+   uv run ruff check --fix .    # lint, fixing what can be fixed automatically
+   ```
+
+3. Push the branch to your fork and open a pull request against `main` of
+   `franioli/gnsskit`.
+
+## Releasing a new version
+
+For the current maintainers only (it needs write access to the repository and to the PyPI
+project).
+
+Publishing a GitHub release runs [`.github/workflows/publish.yml`](.github/workflows/publish.yml),
+which checks that the tag matches the version, runs the tests, builds and uploads to PyPI:
+
+```sh
+uv version --bump patch            # or minor / major: updates pyproject.toml
+uv run pytest
+git commit -am "Release $(uv version --short)" && git push
+gh release create "v$(uv version --short)" --generate-notes   # tag + release -> PyPI
+```
+
+`gh release create` creates the tag on the pushed commit; without the GitHub CLI, push a tag
+(`git tag -a vX.Y.Z -m "gnsskit X.Y.Z" && git push origin vX.Y.Z`) and create the release from it
+on GitHub. PyPI never accepts the same version twice.
+
+One-time setup of the automatic upload (PyPI Trusted Publishing, no token): on pypi.org, project
+gnsskit -> Settings -> Publishing -> add a GitHub publisher with owner `franioli`, repository
+`gnsskit`, workflow `publish.yml` and environment `pypi`.
+
+Manual upload, if needed, with a project-scoped token kept outside the repository:
+
+```sh
+rm -rf dist && uv build
+UV_PUBLISH_TOKEN=$(cat ~/.config/pypi/gnsskit.token) uv publish
+```

gnsskit-0.4.2/README.md

@@ -0,0 +1,126 @@
+# gnsskit
+
+Shared tools for post-processing GNSS data with [RTKLIB](https://www.rtklib.com/) `rnx2rtkp`, used by
+[djippk](https://github.com/franioli/djippk) (drone PPK) and [stopgo](https://github.com/franioli/stopgo)
+(stop-and-go surveys).
+
+> [!IMPORTANT]
+> **RTKLIB is not included and must be installed separately.** gnsskit runs the RTKLIB
+> command-line program `rnx2rtkp` (the CLI of RTKPOST) for the GNSS processing; `pip`/`uv` do
+> not install it. See [RTKLIB](#rtklib-required-separately) below.
+
+- **RTKLIB wrappers** (`gnsskit.rtklib`): `RtkConfig`, a typed, immutable set of `rnx2rtkp` options
+  (`from_file`, `updated`, `with_options`, `with_base_llh`, `write`); `run_rnx2rtkp` and `find_rnx2rtkp`;
+  `read_pos` (llh, xyz and enu `.pos` files).
+- **RINEX** (`gnsskit.rinex`): `rinex_span`, `header_llh`, `trim_rinex`; inspection with `obs_summary`
+  (span, sampling, gaps, satellites), `read_visibility` and `plot_visibility` (RTKPLOT-style satellite
+  visibility, needs the `plot` extra).
+- **Static** (`gnsskit.static`): `solve_static` (one solution over a time window), `process_baseline`
+  (static baselines with covariance), baseline IO and `loop_closures` (misclosure of every triangle of baselines); least-squares adjustment of a redundant baseline
+  network in `gnsskit.static.network` (needs the `network` extra).
+- **Kinematic** (`gnsskit.kinematic`): trajectory interpolation and averaging.
+- **Reference systems** (`gnsskit.refsys`): GPST/UTC, ellipsoids, ECEF/geodetic conversions and
+  `ENUFrame`, a local east-north-up frame at a point (points, vectors and covariances, both ways).
+
+## Install
+
+With [uv](https://docs.astral.sh/uv/) (recommended), in your project:
+
+```sh
+uv add gnsskit                  # library
+uv add "gnsskit[network]"       # + network adjustment (scipy, pyproj)
+uv add "gnsskit[network,plot]"  # + satellite visibility plots (matplotlib)
+uv add "gnsskit[all]"           # every extra
+uv add git+https://github.com/franioli/gnsskit   # development version
+```
+
+or in an existing environment, `uv pip install gnsskit` (same extras).
+
+With pip:
+
+```sh
+pip install gnsskit
+pip install "gnsskit[all]"   # with every extra
+```
+
+### RTKLIB (required separately)
+
+The processing functions (`run_rnx2rtkp`, `process_baseline`, `solve_static`) call the RTKLIB
+command-line program **`rnx2rtkp`**, which must be installed on your system and found on your
+`PATH` (or passed with `exe=`); `trim_rinex(use_convbin=True)` also needs RTKLIB `convbin`.
+The [demo5 fork](https://github.com/rtklibexplorer/RTKLIB) is
+recommended; gnsskit is developed with `rnx2rtkp ver.EX 2.5.1`.
+
+- **Windows**: download a [demo5 release](https://github.com/rtklibexplorer/RTKLIB/releases),
+  unzip it and add the folder with `rnx2rtkp.exe` to your `PATH`.
+- **Linux / macOS**: build it from source:
+  ```sh
+  git clone https://github.com/rtklibexplorer/RTKLIB
+  cd RTKLIB/app/consapp/rnx2rtkp/gcc && make && sudo make install
+  ```
+
+Check it with `rnx2rtkp -?`. If it is missing, `run_rnx2rtkp` raises an error with these
+instructions. The rest of gnsskit (RINEX tools, `read_pos`, loop closures, network adjustment,
+reference systems) is pure Python and works without RTKLIB, e.g. on baselines computed elsewhere.
+
+## Example
+
+```python
+from gnsskit import RtkConfig, read_pos, run_rnx2rtkp
+
+config = RtkConfig(posmode="static", navsys="GEC", solformat="llh").with_base_llh(46.2, 9.8, 2300.0)
+pos_file = run_rnx2rtkp(rover_obs, base_obs, [nav], config, "out.pos")
+pos = read_pos(pos_file)
+```
+
+See [example/](https://github.com/franioli/gnsskit/tree/main/example) for complete static, kinematic and network adjustment examples.
+
+## Contributing
+
+Issues are welcome on [GitHub](https://github.com/franioli/gnsskit/issues). To contribute code:
+
+1. Fork the repository on GitHub and clone your fork:
+   ```sh
+   git clone https://github.com/<your-username>/gnsskit && cd gnsskit
+   git checkout -b my-feature
+   ```
+2. Set up the environment, make your changes and check them:
+   ```sh
+   uv sync                      # environment with the dev dependencies (incl. ruff)
+   uv run pytest                # tests
+   uv run ruff format .         # format the code
+   uv run ruff check --fix .    # lint, fixing what can be fixed automatically
+   ```
+
+3. Push the branch to your fork and open a pull request against `main` of
+   `franioli/gnsskit`.
+
+## Releasing a new version
+
+For the current maintainers only (it needs write access to the repository and to the PyPI
+project).
+
+Publishing a GitHub release runs [`.github/workflows/publish.yml`](.github/workflows/publish.yml),
+which checks that the tag matches the version, runs the tests, builds and uploads to PyPI:
+
+```sh
+uv version --bump patch            # or minor / major: updates pyproject.toml
+uv run pytest
+git commit -am "Release $(uv version --short)" && git push
+gh release create "v$(uv version --short)" --generate-notes   # tag + release -> PyPI
+```
+
+`gh release create` creates the tag on the pushed commit; without the GitHub CLI, push a tag
+(`git tag -a vX.Y.Z -m "gnsskit X.Y.Z" && git push origin vX.Y.Z`) and create the release from it
+on GitHub. PyPI never accepts the same version twice.
+
+One-time setup of the automatic upload (PyPI Trusted Publishing, no token): on pypi.org, project
+gnsskit -> Settings -> Publishing -> add a GitHub publisher with owner `franioli`, repository
+`gnsskit`, workflow `publish.yml` and environment `pypi`.
+
+Manual upload, if needed, with a project-scoped token kept outside the repository:
+
+```sh
+rm -rf dist && uv build
+UV_PUBLISH_TOKEN=$(cat ~/.config/pypi/gnsskit.token) uv publish
+```

{gnsskit-0.4.0 → gnsskit-0.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gnsskit"
-version = "0.4.0"
+version = "0.4.2"
 description = "RTKLIB-based GNSS post-processing toolkit: RINEX tools, RTKLIB wrappers, static baselines and network adjustment, kinematic trajectories"
 readme = "README.md"
 license = "MIT"
@@ -40,6 +40,11 @@ network = [
     "pyproj",
 ]
 plot = ["matplotlib"]
+all = [
+    "scipy",
+    "pyproj",
+    "matplotlib",
+]
 
 [project.urls]
 Repository = "https://github.com/franioli/gnsskit"
@@ -48,6 +53,7 @@ Issues = "https://github.com/franioli/gnsskit/issues"
 [dependency-groups]
 dev = [
     "pytest",
+    "ruff",
     "scipy",
     "pyproj",
     "matplotlib",

{gnsskit-0.4.0 → gnsskit-0.4.2}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "gnsskit"
-version = "0.4.0"
+version = "0.4.2"
 description = "RTKLIB-based GNSS post-processing toolkit: RINEX tools, RTKLIB wrappers, static baselines and network adjustment, kinematic trajectories"
 readme = "README.md"
 license = "MIT"
@@ -24,13 +24,14 @@ dependencies = ["numpy", "pandas>=2"]
 [project.optional-dependencies]
 network = ["scipy", "pyproj"]
 plot = ["matplotlib"]
+all = ["scipy", "pyproj", "matplotlib"]  # every extra above
 
 [project.urls]
 Repository = "https://github.com/franioli/gnsskit"
 Issues = "https://github.com/franioli/gnsskit/issues"
 
 [dependency-groups]
-dev = ["pytest", "scipy", "pyproj", "matplotlib"]
+dev = ["pytest", "ruff", "scipy", "pyproj", "matplotlib"]
 
 [build-system]
 requires = ["uv_build>=0.12.23,<0.13.0"]

gnsskit-0.4.0/PKG-INFO

@@ -1,72 +0,0 @@
-Metadata-Version: 2.4
-Name: gnsskit
-Version: 0.4.0
-Summary: RTKLIB-based GNSS post-processing toolkit: RINEX tools, RTKLIB wrappers, static baselines and network adjustment, kinematic trajectories
-Keywords: gnss,gps,rtklib,ppk,surveying,least-squares
-Author: Francesco Ioli
-Author-email: Francesco Ioli <francesco.ioli@polimi.it>
-License-Expression: MIT
-License-File: LICENSE
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Science/Research
-Classifier: Topic :: Scientific/Engineering :: GIS
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Typing :: Typed
-Requires-Dist: numpy
-Requires-Dist: pandas>=2
-Requires-Dist: scipy ; extra == 'network'
-Requires-Dist: pyproj ; extra == 'network'
-Requires-Dist: matplotlib ; extra == 'plot'
-Requires-Python: >=3.10
-Project-URL: Repository, https://github.com/franioli/gnsskit
-Project-URL: Issues, https://github.com/franioli/gnsskit/issues
-Provides-Extra: network
-Provides-Extra: plot
-Description-Content-Type: text/markdown
-
-# gnsskit
-
-Shared tools for post-processing GNSS data with [RTKLIB](https://www.rtklib.com/) `rnx2rtkp`, used by
-[djippk](https://github.com/franioli/djippk) (drone PPK) and [stopgo](https://github.com/franioli/stopgo)
-(stop-and-go surveys).
-
-- **RTKLIB wrappers** (`gnsskit.rtklib`): `RtkConfig`, a typed, immutable set of `rnx2rtkp` options
-  (`from_file`, `updated`, `with_options`, `with_base_llh`, `write`); `run_rnx2rtkp` and `find_rnx2rtkp`;
-  `read_pos` (llh, xyz and enu `.pos` files).
-- **RINEX** (`gnsskit.rinex`): `rinex_span`, `header_llh`, `trim_rinex`; inspection with `obs_summary`
-  (span, sampling, gaps, satellites), `read_visibility` and `plot_visibility` (RTKPLOT-style satellite
-  visibility, needs the `plot` extra).
-- **Static** (`gnsskit.static`): `solve_static` (one solution over a time window), `process_baseline`
-  (static baselines with covariance), baseline IO and `loop_closures` (misclosure of every triangle of baselines); least-squares adjustment of a redundant baseline
-  network in `gnsskit.static.network` (needs the `network` extra).
-- **Kinematic** (`gnsskit.kinematic`): trajectory interpolation and averaging.
-- **Reference systems** (`gnsskit.refsys`): GPST/UTC, ellipsoids, ECEF/geodetic conversions and
-  `ENUFrame`, a local east-north-up frame at a point (points, vectors and covariances, both ways).
-
-## Install
-
-```sh
-pip install gnsskit                  # library
-pip install "gnsskit[network]"       # + network adjustment (scipy, pyproj)
-pip install "gnsskit[network,plot]"  # + satellite visibility plots (matplotlib)
-pip install git+https://github.com/franioli/gnsskit   # development version
-```
-
-`rnx2rtkp` is not installed by pip. Build the [demo5 fork](https://github.com/rtklibexplorer/RTKLIB) and put it on
-your `PATH`; if it is missing, `run_rnx2rtkp` raises an error with instructions. Developed with `rnx2rtkp ver.EX 2.5.1`.
-
-## Example
-
-```python
-from gnsskit import RtkConfig, read_pos, run_rnx2rtkp
-
-config = RtkConfig(posmode="static", navsys="GEC", solformat="llh").with_base_llh(46.2, 9.8, 2300.0)
-pos_file = run_rnx2rtkp(rover_obs, base_obs, [nav], config, "out.pos")
-pos = read_pos(pos_file)
-```
-
-See [example/](https://github.com/franioli/gnsskit/tree/main/example) for complete static, kinematic and network adjustment examples.

gnsskit-0.4.0/README.md

@@ -1,42 +0,0 @@
-# gnsskit
-
-Shared tools for post-processing GNSS data with [RTKLIB](https://www.rtklib.com/) `rnx2rtkp`, used by
-[djippk](https://github.com/franioli/djippk) (drone PPK) and [stopgo](https://github.com/franioli/stopgo)
-(stop-and-go surveys).
-
-- **RTKLIB wrappers** (`gnsskit.rtklib`): `RtkConfig`, a typed, immutable set of `rnx2rtkp` options
-  (`from_file`, `updated`, `with_options`, `with_base_llh`, `write`); `run_rnx2rtkp` and `find_rnx2rtkp`;
-  `read_pos` (llh, xyz and enu `.pos` files).
-- **RINEX** (`gnsskit.rinex`): `rinex_span`, `header_llh`, `trim_rinex`; inspection with `obs_summary`
-  (span, sampling, gaps, satellites), `read_visibility` and `plot_visibility` (RTKPLOT-style satellite
-  visibility, needs the `plot` extra).
-- **Static** (`gnsskit.static`): `solve_static` (one solution over a time window), `process_baseline`
-  (static baselines with covariance), baseline IO and `loop_closures` (misclosure of every triangle of baselines); least-squares adjustment of a redundant baseline
-  network in `gnsskit.static.network` (needs the `network` extra).
-- **Kinematic** (`gnsskit.kinematic`): trajectory interpolation and averaging.
-- **Reference systems** (`gnsskit.refsys`): GPST/UTC, ellipsoids, ECEF/geodetic conversions and
-  `ENUFrame`, a local east-north-up frame at a point (points, vectors and covariances, both ways).
-
-## Install
-
-```sh
-pip install gnsskit                  # library
-pip install "gnsskit[network]"       # + network adjustment (scipy, pyproj)
-pip install "gnsskit[network,plot]"  # + satellite visibility plots (matplotlib)
-pip install git+https://github.com/franioli/gnsskit   # development version
-```
-
-`rnx2rtkp` is not installed by pip. Build the [demo5 fork](https://github.com/rtklibexplorer/RTKLIB) and put it on
-your `PATH`; if it is missing, `run_rnx2rtkp` raises an error with instructions. Developed with `rnx2rtkp ver.EX 2.5.1`.
-
-## Example
-
-```python
-from gnsskit import RtkConfig, read_pos, run_rnx2rtkp
-
-config = RtkConfig(posmode="static", navsys="GEC", solformat="llh").with_base_llh(46.2, 9.8, 2300.0)
-pos_file = run_rnx2rtkp(rover_obs, base_obs, [nav], config, "out.pos")
-pos = read_pos(pos_file)
-```
-
-See [example/](https://github.com/franioli/gnsskit/tree/main/example) for complete static, kinematic and network adjustment examples.