trajectopy 5.0.0__tar.gz → 5.0.2__tar.gz

{trajectopy-5.0.0 → trajectopy-5.0.2}/.github/workflows/ci.yml

@@ -1,46 +1,47 @@
-name: CI
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v6
-      - run: uv sync --group dev --extra gui  # GUI packages provide the type information for trajectopy.gui
-      - run: uv run ruff check trajectopy test example_scripts
-      - run: uv run ruff format --check trajectopy test example_scripts
-      - run: uv run mypy
-
-  test:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest]
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
-    env:
-      # plots and the GUI are tested without a display
-      QT_QPA_PLATFORM: offscreen
-    steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v6
-        with:
-          python-version: ${{ matrix.python-version }}
-      - if: runner.os == 'Linux'
-        run: sudo apt-get update && sudo apt-get install -y libegl1 libgl1 libxkbcommon0 libfontconfig1 libdbus-1-3
-      - run: uv sync --group dev --extra gui
-      - run: uv run pytest -q --cov=trajectopy --cov-report=term
-
-  core-only:
-    # the package must work without the optional plotting/GUI dependencies
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v6
-      - run: uv sync --group dev
-      - run: uv run pytest -q
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - run: uv sync --group dev --extra gui  # GUI packages provide the type information for trajectopy.gui
+      - run: uv run ruff check trajectopy test example_scripts
+      - run: uv run ruff format --check trajectopy test example_scripts
+      - run: uv run mypy
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    env:
+      # plots and the GUI are tested without a display
+      QT_QPA_PLATFORM: offscreen
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y libegl1 libgl1 libxkbcommon0 libfontconfig1 libdbus-1-3
+      # with the optional pyarrow reader; the core-only job covers reading without it
+      - run: uv sync --group dev --extra gui --extra fast
+      - run: uv run pytest -q --cov=trajectopy --cov-report=term
+
+  core-only:
+    # the package must work without the optional plotting/GUI dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - run: uv sync --group dev
+      - run: uv run pytest -q

trajectopy-5.0.2/.github/workflows/release.yml

@@ -0,0 +1,61 @@
+name: Release
+
+# Pushing a version tag (e.g. v5.1.0, matching trajectopy/__version__.py) builds the Windows installer and
+# attaches it to the GitHub release of that tag (created with generated notes if it does not exist yet).
+# The update check of installed apps then finds the new version.
+# Running the workflow manually only builds the installer and keeps it as a workflow artifact.
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  windows-installer:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.13"
+      - run: uv sync --group dev --extra gui
+
+      - name: Read version
+        id: version
+        shell: bash
+        run: |
+          version=$(uv run python -c "from trajectopy.__version__ import __version__; print(__version__)")
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+          if [[ "$GITHUB_REF_TYPE" == "tag" && "$GITHUB_REF_NAME" != "v$version" ]]; then
+            echo "::error::Tag $GITHUB_REF_NAME does not match the package version $version"
+            exit 1
+          fi
+
+      - name: Build the app
+        run: uv run pyinstaller --noconfirm trajectopy.spec
+
+      - name: Check that the app starts
+        run: dist\Trajectopy\Trajectopy.exe --version
+
+      - name: Build the installer
+        shell: pwsh
+        run: |
+          $iscc = "${env:ProgramFiles(x86)}\Inno Setup 6\ISCC.exe"
+          if (-not (Test-Path $iscc)) { choco install innosetup --no-progress -y }
+          & $iscc "/DAppVersion=${{ steps.version.outputs.version }}" installer\trajectopy.iss
+          if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Trajectopy-${{ steps.version.outputs.version }}-setup
+          path: dist/Trajectopy-${{ steps.version.outputs.version }}-setup.exe
+
+      - name: Attach the installer to the release
+        if: github.ref_type == 'tag'
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/Trajectopy-${{ steps.version.outputs.version }}-setup.exe
+          generate_release_notes: true

{trajectopy-5.0.0 → trajectopy-5.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: trajectopy
-Version: 5.0.0
+Version: 5.0.2
 Summary: Trajectory Evaluation in Python
 Project-URL: Homepage, https://gereon-t.github.io/trajectopy/
 Project-URL: Documentation, https://gereon-t.github.io/trajectopy/
@@ -27,6 +27,8 @@ Requires-Dist: pandas>=2.2.3
 Requires-Dist: pyproj>=3.6.1
 Requires-Dist: rosbags>=0.9.23
 Requires-Dist: scipy>=1.13.1
+Provides-Extra: fast
+Requires-Dist: pyarrow>=25.0.1; extra == 'fast'
 Provides-Extra: gui
 Requires-Dist: pyopengl>=3.1.7; extra == 'gui'
 Requires-Dist: pyqtgraph>=0.13.7; extra == 'gui'
@@ -60,6 +62,8 @@ Description-Content-Type: text/markdown
 
 ## Installation
 
+Windows app: download `Trajectopy-<version>-setup.exe` from the [latest release](https://github.com/gereon-t/trajectopy/releases/latest) and run it. No Python installation or administrator rights are needed; `.traj` files can then be opened by double-click, and the app reports new versions (Help → Check for Updates).
+
 Full version (with GUI):
 
 ```bash
@@ -78,6 +82,12 @@ Python package only:
 pip install trajectopy
 ```
 
+Loading large trajectory files (millions of poses) is several times faster with the `fast` extra, which can be combined with the others:
+
+```bash
+pip install "trajectopy[gui,fast]"
+```
+
 ## Documentation
 
 <a href="https://gereon-t.github.io/trajectopy/" target="_blank">https://gereon-t.github.io/trajectopy/</a>

{trajectopy-5.0.0 → trajectopy-5.0.2}/README.md

@@ -1,75 +1,83 @@
-<div align="center">
-    <h1>Trajectopy - Trajectory Evaluation in Python</h1>
-    <a href="https://github.com/gereon-t/trajectopy/releases"><img src="https://img.shields.io/github/v/release/gereon-t/trajectopy?label=version" /></a>
-    <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.10+-blue.svg" /></a>
-    <a href="https://github.com/gereon-t/trajectopy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/gereon-t/trajectopy" /></a>
-    <a href="https://github.com/astral-sh/ruff"><img alt="Code style: ruff" src="https://img.shields.io/badge/code%20style-ruff-000000.svg"></a>
-    <br />
-    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/Windows-0078D6?st&logo=windows&logoColor=white" /></a>
-    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black" /></a>
-    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/mac%20os-000000?&logo=apple&logoColor=white" /></a>
-    <div>
-      <img src=".images/uni_bonn.svg" height="50" />
-      <img src=".images/igg.gif" height="50" />
-    </div>
-<h4>Trajectopy is a Python package with an optional graphical user interface for empirical trajectory evaluation. </h4>
-
-<p align="center">
-  <img style="border-radius: 10px;" src="https://raw.githubusercontent.com/gereon-t/trajectopy/main/.images/trajectopy_gif_low_quality.gif">
-</p>
-
-</div>
-
-## Installation
-
-Full version (with GUI):
-
-```bash
-pip install "trajectopy[gui]"
-```
-
-Python package with plotting (no GUI):
-
-```bash
-pip install "trajectopy[plot]"
-```
-
-Python package only:
-
-```bash
-pip install trajectopy
-```
-
-## Documentation
-
-<a href="https://gereon-t.github.io/trajectopy/" target="_blank">https://gereon-t.github.io/trajectopy/</a>
-
-## Key Features
-
-Trajectopy offers a range of features, including:
-
-- __Interactive GUI__: A user-friendly interface that enables seamless interaction with your trajectory data, making it easy to visualize, align, and compare trajectories.
-- __Alignment__: An advanced trajectory alignment algorithm that can be tailored to the specific application and supports a similarity transformation, a leverarm and a time shift estimation.
-- __Comparison__: Absolute and relative trajectory comparison metrics (__ATE and RPE__) that can be computed using various pose-matching methods.
-- __Data Import/Export__: Support for importing and exporting data, ensuring compatibility with your existing workflows.
-- __Fast, Interactive Visualization__: Powered by [pyqtgraph](https://www.pyqtgraph.org/), the same plots are available in the GUI and in Python scripts, stay fluid for large trajectories, and can be exported to PNG, JPG or SVG. Georeferenced trajectories and ATE results can be exported to Google Earth, colored by speed, height or deviations, on the terrain or at their own heights, with playback.
-
-## Web Application (Docker)
-
-A simple web application is available at [gereon-t/trajectopy-web](https://github.com/gereon-t/trajectopy-web) that allows you to use the core functionality of Trajectopy using Docker.
-
-## Citation
-
-If you use this library for any academic work, please cite our original [paper](https://www.degruyter.com/document/doi/10.1515/jag-2024-0040/html).
-
-```bibtex
-@article{Tombrink2024,
-url = {https://doi.org/10.1515/jag-2024-0040},
-title = {Spatio-temporal trajectory alignment for trajectory evaluation},
-author = {Gereon Tombrink and Ansgar Dreier and Lasse Klingbeil and Heiner Kuhlmann},
-journal = {Journal of Applied Geodesy},
-doi = {doi:10.1515/jag-2024-0040},
-year = {2024},
-codeurl = {https://github.com/gereon-t/trajectopy},
-}
-```
+<div align="center">
+    <h1>Trajectopy - Trajectory Evaluation in Python</h1>
+    <a href="https://github.com/gereon-t/trajectopy/releases"><img src="https://img.shields.io/github/v/release/gereon-t/trajectopy?label=version" /></a>
+    <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.10+-blue.svg" /></a>
+    <a href="https://github.com/gereon-t/trajectopy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/gereon-t/trajectopy" /></a>
+    <a href="https://github.com/astral-sh/ruff"><img alt="Code style: ruff" src="https://img.shields.io/badge/code%20style-ruff-000000.svg"></a>
+    <br />
+    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/Windows-0078D6?st&logo=windows&logoColor=white" /></a>
+    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black" /></a>
+    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/mac%20os-000000?&logo=apple&logoColor=white" /></a>
+    <div>
+      <img src=".images/uni_bonn.svg" height="50" />
+      <img src=".images/igg.gif" height="50" />
+    </div>
+<h4>Trajectopy is a Python package with an optional graphical user interface for empirical trajectory evaluation. </h4>
+
+<p align="center">
+  <img style="border-radius: 10px;" src="https://raw.githubusercontent.com/gereon-t/trajectopy/main/.images/trajectopy_gif_low_quality.gif">
+</p>
+
+</div>
+
+## Installation
+
+Windows app: download `Trajectopy-<version>-setup.exe` from the [latest release](https://github.com/gereon-t/trajectopy/releases/latest) and run it. No Python installation or administrator rights are needed; `.traj` files can then be opened by double-click, and the app reports new versions (Help → Check for Updates).
+
+Full version (with GUI):
+
+```bash
+pip install "trajectopy[gui]"
+```
+
+Python package with plotting (no GUI):
+
+```bash
+pip install "trajectopy[plot]"
+```
+
+Python package only:
+
+```bash
+pip install trajectopy
+```
+
+Loading large trajectory files (millions of poses) is several times faster with the `fast` extra, which can be combined with the others:
+
+```bash
+pip install "trajectopy[gui,fast]"
+```
+
+## Documentation
+
+<a href="https://gereon-t.github.io/trajectopy/" target="_blank">https://gereon-t.github.io/trajectopy/</a>
+
+## Key Features
+
+Trajectopy offers a range of features, including:
+
+- __Interactive GUI__: A user-friendly interface that enables seamless interaction with your trajectory data, making it easy to visualize, align, and compare trajectories.
+- __Alignment__: An advanced trajectory alignment algorithm that can be tailored to the specific application and supports a similarity transformation, a leverarm and a time shift estimation.
+- __Comparison__: Absolute and relative trajectory comparison metrics (__ATE and RPE__) that can be computed using various pose-matching methods.
+- __Data Import/Export__: Support for importing and exporting data, ensuring compatibility with your existing workflows.
+- __Fast, Interactive Visualization__: Powered by [pyqtgraph](https://www.pyqtgraph.org/), the same plots are available in the GUI and in Python scripts, stay fluid for large trajectories, and can be exported to PNG, JPG or SVG. Georeferenced trajectories and ATE results can be exported to Google Earth, colored by speed, height or deviations, on the terrain or at their own heights, with playback.
+
+## Web Application (Docker)
+
+A simple web application is available at [gereon-t/trajectopy-web](https://github.com/gereon-t/trajectopy-web) that allows you to use the core functionality of Trajectopy using Docker.
+
+## Citation
+
+If you use this library for any academic work, please cite our original [paper](https://www.degruyter.com/document/doi/10.1515/jag-2024-0040/html).
+
+```bibtex
+@article{Tombrink2024,
+url = {https://doi.org/10.1515/jag-2024-0040},
+title = {Spatio-temporal trajectory alignment for trajectory evaluation},
+author = {Gereon Tombrink and Ansgar Dreier and Lasse Klingbeil and Heiner Kuhlmann},
+journal = {Journal of Applied Geodesy},
+doi = {doi:10.1515/jag-2024-0040},
+year = {2024},
+codeurl = {https://github.com/gereon-t/trajectopy},
+}
+```

trajectopy-5.0.2/installer/trajectopy.iss

@@ -0,0 +1,77 @@
+; Windows installer for Trajectopy (Inno Setup 6, https://jrsoftware.org/isinfo.php).
+;
+; Packages the one-folder PyInstaller build. Build it first, then compile this script:
+;   uv run pyinstaller --noconfirm trajectopy.spec
+;   iscc /DAppVersion=5.0.1 installer\trajectopy.iss
+; The installer is written to dist\Trajectopy-<version>-setup.exe.
+;
+; It installs for the current user without administrator rights (or for all users, if chosen in the
+; dialog), adds a Start menu entry and, optionally, a desktop icon and the .traj file association.
+; Installing a newer version over an existing one updates it in place.
+
+#define AppName "Trajectopy"
+#define AppExe "Trajectopy.exe"
+#ifndef AppVersion
+  #define AppVersion "0.0.0"
+#endif
+
+[Setup]
+; never change the AppId: Windows identifies the installed application (and its updates) by it
+AppId={{D3DF14CF-47F5-45DB-9C26-6F16E0A3170D}
+AppName={#AppName}
+AppVersion={#AppVersion}
+AppVerName={#AppName} {#AppVersion}
+AppPublisher=Gereon Tombrink
+AppPublisherURL=https://github.com/gereon-t/trajectopy
+AppSupportURL=https://github.com/gereon-t/trajectopy/issues
+AppUpdatesURL=https://github.com/gereon-t/trajectopy/releases
+DefaultDirName={autopf}\{#AppName}
+DefaultGroupName={#AppName}
+DisableProgramGroupPage=yes
+PrivilegesRequired=lowest
+PrivilegesRequiredOverridesAllowed=dialog
+ArchitecturesAllowed=x64compatible
+ArchitecturesInstallIn64BitMode=x64compatible
+OutputDir=..\dist
+OutputBaseFilename={#AppName}-{#AppVersion}-setup
+SetupIconFile=..\trajectopy\gui\resources\icon-bg.ico
+UninstallDisplayIcon={app}\{#AppExe}
+UninstallDisplayName={#AppName}
+LicenseFile=..\LICENSE
+Compression=lzma2
+SolidCompression=yes
+WizardStyle=modern
+ChangesAssociations=yes
+; close a running Trajectopy before updating it
+CloseApplications=yes
+
+[Languages]
+Name: "english"; MessagesFile: "compiler:Default.isl"
+
+[Tasks]
+Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}"; Flags: unchecked
+Name: "associate"; Description: "Open .traj files with {#AppName}"; GroupDescription: "File associations:"
+
+[InstallDelete]
+; an update replaces the bundled libraries completely, so that no files of the previous version remain
+Type: filesandordirs; Name: "{app}\_internal"
+
+[Files]
+Source: "..\dist\Trajectopy\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs createallsubdirs
+
+[Icons]
+Name: "{autoprograms}\{#AppName}"; Filename: "{app}\{#AppExe}"
+Name: "{autodesktop}\{#AppName}"; Filename: "{app}\{#AppExe}"; Tasks: desktopicon
+
+[Registry]
+; .traj files: Trajectopy is the default program unless the user chose another one, and is always listed
+; under "Open with". HKA is HKCU for a per-user and HKLM for an all-users installation.
+Root: HKA; Subkey: "Software\Classes\.traj"; ValueType: string; ValueName: ""; ValueData: "Trajectopy.traj"; Flags: uninsdeletevalue; Tasks: associate
+Root: HKA; Subkey: "Software\Classes\.traj\OpenWithProgids"; ValueType: string; ValueName: "Trajectopy.traj"; ValueData: ""; Flags: uninsdeletevalue; Tasks: associate
+Root: HKA; Subkey: "Software\Classes\Trajectopy.traj"; ValueType: string; ValueName: ""; ValueData: "Trajectory File"; Flags: uninsdeletekey; Tasks: associate
+Root: HKA; Subkey: "Software\Classes\Trajectopy.traj\DefaultIcon"; ValueType: string; ValueName: ""; ValueData: """{app}\{#AppExe}"",0"; Tasks: associate
+Root: HKA; Subkey: "Software\Classes\Trajectopy.traj\shell\open\command"; ValueType: string; ValueName: ""; ValueData: """{app}\{#AppExe}"" ""%1"""; Tasks: associate
+Root: HKA; Subkey: "Software\Classes\Applications\{#AppExe}\SupportedTypes"; ValueType: string; ValueName: ".traj"; ValueData: ""; Flags: uninsdeletekey; Tasks: associate
+
+[Run]
+Filename: "{app}\{#AppExe}"; Description: "{cm:LaunchProgram,{#AppName}}"; Flags: nowait postinstall skipifsilent

{trajectopy-5.0.0 → trajectopy-5.0.2}/pyproject.toml

@@ -60,6 +60,8 @@ dependencies = [
 plot = ["PySide6-Essentials>=6.8", "pyqtgraph>=0.13.7"]
 # The GUI additionally renders the 3D playback with OpenGL.
 gui = ["trajectopy[plot]", "PyOpenGL>=3.1.7"]
+# Several times faster reading of large trajectory files (multithreaded CSV parser).
+fast = ["pyarrow>=25.0.1"]
 
 [project.urls]
 Homepage = "https://gereon-t.github.io/trajectopy/"