gpx-player 0.1.0__tar.gz

gpx_player-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Yury Kirienko
+
+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.

gpx_player-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include schema *.xsd
+include *.html *.js

gpx_player-0.1.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: gpx-player
+Version: 0.1.0
+Summary: Visualise & animate GPX race tracks.
+Author: Yury Kirienko
+License: MIT License
+        
+        Copyright (c) 2023 Yury Kirienko
+        
+        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.
+        
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: folium
+Requires-Dist: jinja2
+Requires-Dist: matplotlib
+Requires-Dist: pytz
+Requires-Dist: lxml
+Requires-Dist: numpy
+Requires-Dist: gpxpy
+Dynamic: license-file
+
+# gpx-player
+## GPX Race Visualizer
+
+GPX Race Visualizer is a Python script to visualize the progression of multiple GPS tracks (e.g., from a race) on a 2D map. 
+It takes as input one or more GPX files and creates an animation showing the movement of each track over time. 
+This is a simple, open-source alternative to features like Strava's Flyby, which require an account and can have privacy issues.
+
+### Modes
+The player supports two modes:
+#### 1. "Video" mode
+Produce an `MP4` or a `GIF` file showing how the situation developed.
+For sailing races, it also calculates the distance covered after the 'start' signal and the current speed.
+##### Example:
+![Example output](example.gif "Example of the script output")
+
+#### 2. Map mode
+Displays the track on OpenSeaMap.
+You can see the full tracks with colour-coded speeds, 
+and you can 'play' the tracks and see the markers move around the map.
+
+#### Example:
+Since GitHub Markdown doesn't allow embedding HTML, 
+you can see an [interactive example](https://kirienko.github.io/static/GinSul-2024.html) here.
+
+Screenshot:
+[![OPS Example](./example_osm.png)](https://kirienko.github.io/static/GinSul-2024.html)
+## Installation
+
+Clone the repository and install the required dependencies with pip:
+
+```bash
+git clone https://github.com/kirienko/gpx-player.git
+cd gpx-player
+pip install -r requirements.txt
+```
+
+## Usage
+To run the script producing `mp4`, pass one or more GPX file paths as command-line arguments:
+```bash
+python main.py example-data/track1.gpx example-data/track2.gpx
+```
+To get a sea map, run the `openseamap.py`:
+```bash
+python openseamap.py --title 'Gin Sul Regatta 2024' --names Alex Yury Richard \
+     --files example-data/osm-demo-Alex.gpx example-data/osm-demo-Richard.gpx \
+             example-data/osm-demo-Yury.gpx
+```
+
+A more sophisticated example, that produced a video above:
+```bash
+python main.py example-data/track1.gpx example-data/track2.gpx example-data/track3.gpx \
+       --start 2023-07-01T10:53:00+0000 \
+       --names "Mr. Pommeroy" "Miss Sophie" "Sir Toby²" \
+       --title "Elbe-Damm Regatta (01.07.2023), Race 1" \
+       --race_start 2023-07-01T10:58:00+0000 --marks example-data/marks.txt -g
+```
+### Additional parameters:
+* `--title` or `-t`: The title of the video
+* `--start` or `-s`: start time in the format `2023-06-30T12:53:00+0200`, all points _before_ that will not be plotted
+* `--end` or `-e`: end time in the format `2023-06-30T13:53:00+0200`, all points _after_ that will not be plotted
+* `--names` or `-n`: names of the participants (otherwise the file names will be used in the legend)
+* `--race_start`, `-r`: Race start time in the format `YYYY-MM-DDTHH:MM:SS%z`, e.g. `2023-07-01T12:29:00+0200`
+* `--names` or `-n`: Names of the participants
+* `--marks`or`-m`: The file with the static marks to put onto the map. One pair of coordinates per line, see below.
+* `--gif` or `-g`: Save as GIF moving picture instead of MP4
+* `--timezone` or `-tz`: Local timezone to use for processing timestamps, e.g. `America/Los_Angeles`, see [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (default: `Europe/Berlin`).
+
+## Marks
+The script also supports visualizing predefined marks on the map, which can be useful for events like sailing regattas.
+The marks are defined as a list of (latitude, longitude) tuples in a separate text file and can be added to the script as follows:
+```
+53.542484632728, 9.801163896918299
+53.542997846049374, 9.80611324310303
+53.54823800356785, 9.812614917755129
+53.54921647691311, 9.807373881340029
+53.54508251196638, 9.80433225631714
+```
+
+## Getting GPX Files
+
+GPX files can be obtained from several GPS-tracking services:
+* Strava: Go to the activity page and click on the wrench icon. Then select "Export GPX".
+* Garmin Connect: Open the activity, go to the gear icon and select "Export to GPX".
+* Endomondo: From the workout page, click the three-dot menu icon and select "Export". Then choose "GPX".
+
+## GPX Validation
+
+For the `gpx-player` to work properly, it needs the correct GPX files.
+You can verify that you are inputting the correct file by using the special validator 
+included in this package.
+
+The `validator.py` script is a command-line utility and module for validating GPX files. 
+It checks for XML schema conformance and timestamp consistency, 
+supporting both strict and lenient modes. 
+Errors are raised as `GPXValidationError` which can be caught in Python code. 
+To run as a CLI tool, use:
+```bash
+python validator.py path/to/yourfile.gpx --strict
+```
+
+The `--strict` parameter is optional. In most cases you do not need it, 
+because files that strictly correspond to the GPX schema are rare. 
+For example, almost all modern files contain coordinates, elevations and time stamps 
+with more decimal places than originally planned.
+
+Also, to better understand your GPX file, you can use the `gpxinfo` console command 
+that comes with `gpxpy`. If you are already using the player, you have it:
+
+```bash
+$ gpxinfo example-data/osm_track1.gpx 
+File: example-data/osm_track1.gpx
+    Waypoints: 0
+    Routes: 0
+    Length 2D: 9.621km
+    Length 3D: 9.648km
+    Moving time: 01:05:22
+    Stopped time: n/a
+    Max speed: 3.12m/s = 11.22km/h
+    Avg speed: 2.46m/s = 8.85km/h
+    Total uphill: 97.20m
+    Total downhill: 98.40m
+    Started: 2024-07-24 15:59:05+00:00
+    Ended: 2024-07-24 17:04:27+00:00
+    Points: 776
+    Avg distance between points: 12.40m
+
+```
+
+## Support
+Now you can buy me a coffee to encourage further development!
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/kirienko)

gpx_player-0.1.0/README.md

@@ -0,0 +1,132 @@
+# gpx-player
+## GPX Race Visualizer
+
+GPX Race Visualizer is a Python script to visualize the progression of multiple GPS tracks (e.g., from a race) on a 2D map. 
+It takes as input one or more GPX files and creates an animation showing the movement of each track over time. 
+This is a simple, open-source alternative to features like Strava's Flyby, which require an account and can have privacy issues.
+
+### Modes
+The player supports two modes:
+#### 1. "Video" mode
+Produce an `MP4` or a `GIF` file showing how the situation developed.
+For sailing races, it also calculates the distance covered after the 'start' signal and the current speed.
+##### Example:
+![Example output](example.gif "Example of the script output")
+
+#### 2. Map mode
+Displays the track on OpenSeaMap.
+You can see the full tracks with colour-coded speeds, 
+and you can 'play' the tracks and see the markers move around the map.
+
+#### Example:
+Since GitHub Markdown doesn't allow embedding HTML, 
+you can see an [interactive example](https://kirienko.github.io/static/GinSul-2024.html) here.
+
+Screenshot:
+[![OPS Example](./example_osm.png)](https://kirienko.github.io/static/GinSul-2024.html)
+## Installation
+
+Clone the repository and install the required dependencies with pip:
+
+```bash
+git clone https://github.com/kirienko/gpx-player.git
+cd gpx-player
+pip install -r requirements.txt
+```
+
+## Usage
+To run the script producing `mp4`, pass one or more GPX file paths as command-line arguments:
+```bash
+python main.py example-data/track1.gpx example-data/track2.gpx
+```
+To get a sea map, run the `openseamap.py`:
+```bash
+python openseamap.py --title 'Gin Sul Regatta 2024' --names Alex Yury Richard \
+     --files example-data/osm-demo-Alex.gpx example-data/osm-demo-Richard.gpx \
+             example-data/osm-demo-Yury.gpx
+```
+
+A more sophisticated example, that produced a video above:
+```bash
+python main.py example-data/track1.gpx example-data/track2.gpx example-data/track3.gpx \
+       --start 2023-07-01T10:53:00+0000 \
+       --names "Mr. Pommeroy" "Miss Sophie" "Sir Toby²" \
+       --title "Elbe-Damm Regatta (01.07.2023), Race 1" \
+       --race_start 2023-07-01T10:58:00+0000 --marks example-data/marks.txt -g
+```
+### Additional parameters:
+* `--title` or `-t`: The title of the video
+* `--start` or `-s`: start time in the format `2023-06-30T12:53:00+0200`, all points _before_ that will not be plotted
+* `--end` or `-e`: end time in the format `2023-06-30T13:53:00+0200`, all points _after_ that will not be plotted
+* `--names` or `-n`: names of the participants (otherwise the file names will be used in the legend)
+* `--race_start`, `-r`: Race start time in the format `YYYY-MM-DDTHH:MM:SS%z`, e.g. `2023-07-01T12:29:00+0200`
+* `--names` or `-n`: Names of the participants
+* `--marks`or`-m`: The file with the static marks to put onto the map. One pair of coordinates per line, see below.
+* `--gif` or `-g`: Save as GIF moving picture instead of MP4
+* `--timezone` or `-tz`: Local timezone to use for processing timestamps, e.g. `America/Los_Angeles`, see [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (default: `Europe/Berlin`).
+
+## Marks
+The script also supports visualizing predefined marks on the map, which can be useful for events like sailing regattas.
+The marks are defined as a list of (latitude, longitude) tuples in a separate text file and can be added to the script as follows:
+```
+53.542484632728, 9.801163896918299
+53.542997846049374, 9.80611324310303
+53.54823800356785, 9.812614917755129
+53.54921647691311, 9.807373881340029
+53.54508251196638, 9.80433225631714
+```
+
+## Getting GPX Files
+
+GPX files can be obtained from several GPS-tracking services:
+* Strava: Go to the activity page and click on the wrench icon. Then select "Export GPX".
+* Garmin Connect: Open the activity, go to the gear icon and select "Export to GPX".
+* Endomondo: From the workout page, click the three-dot menu icon and select "Export". Then choose "GPX".
+
+## GPX Validation
+
+For the `gpx-player` to work properly, it needs the correct GPX files.
+You can verify that you are inputting the correct file by using the special validator 
+included in this package.
+
+The `validator.py` script is a command-line utility and module for validating GPX files. 
+It checks for XML schema conformance and timestamp consistency, 
+supporting both strict and lenient modes. 
+Errors are raised as `GPXValidationError` which can be caught in Python code. 
+To run as a CLI tool, use:
+```bash
+python validator.py path/to/yourfile.gpx --strict
+```
+
+The `--strict` parameter is optional. In most cases you do not need it, 
+because files that strictly correspond to the GPX schema are rare. 
+For example, almost all modern files contain coordinates, elevations and time stamps 
+with more decimal places than originally planned.
+
+Also, to better understand your GPX file, you can use the `gpxinfo` console command 
+that comes with `gpxpy`. If you are already using the player, you have it:
+
+```bash
+$ gpxinfo example-data/osm_track1.gpx 
+File: example-data/osm_track1.gpx
+    Waypoints: 0
+    Routes: 0
+    Length 2D: 9.621km
+    Length 3D: 9.648km
+    Moving time: 01:05:22
+    Stopped time: n/a
+    Max speed: 3.12m/s = 11.22km/h
+    Avg speed: 2.46m/s = 8.85km/h
+    Total uphill: 97.20m
+    Total downhill: 98.40m
+    Started: 2024-07-24 15:59:05+00:00
+    Ended: 2024-07-24 17:04:27+00:00
+    Points: 776
+    Avg distance between points: 12.40m
+
+```
+
+## Support
+Now you can buy me a coffee to encourage further development!
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/kirienko)

gpx_player-0.1.0/animate_tracks.js

@@ -0,0 +1,145 @@
+// Global variables to track play/pause state and the interval ID
+let isPlaying = false;
+let playbackInterval;
+
+document.addEventListener('DOMContentLoaded', () => {
+    const slider = createSlider();
+    const timeLegend = createTimeLegend(slider);
+
+    document.body.appendChild(slider);
+    document.body.appendChild(timeLegend);
+
+    // Access the Folium-initialized map using the dynamically generated map_id
+    const map = window[map_id];
+
+    const trackMarkers = initializeTrackMarkers(map);
+
+    slider.addEventListener('input', () => {
+        updateTrackMarkers(slider, trackMarkers);
+        updateTimeDisplay(slider, timeLegend);
+    });
+
+    // Initialize with the first timestamp
+    slider.dispatchEvent(new Event('input'));
+});
+
+function createSlider() {
+    const slider = document.createElement('input');
+    slider.type = 'range';
+    slider.min = 0;
+    slider.max = 1000;
+    slider.value = 0;
+    Object.assign(slider.style, {
+        position: 'fixed',
+        bottom: '20px',
+        left: '50%',
+        transform: 'translateX(-50%)',
+        width: '80%',
+        zIndex: 1000,
+    });
+    return slider;
+}
+
+function createTimeLegend(slider) {
+    const timeLegend = document.createElement('div');
+    Object.assign(timeLegend.style, {
+        position: 'fixed',
+        bottom: '50px',
+        right: '10px',
+        backgroundColor: 'rgba(0, 0, 0, 0.5)',
+        padding: '5px',
+        border: '1px solid white',
+        borderRadius: '5px',
+        zIndex: 1000,
+        color: 'white',
+        display: 'flex',
+        flexDirection: 'column',
+        alignItems: 'center',
+    });
+
+    const timeDisplay = document.createElement('div');
+    timeDisplay.style.marginBottom = '2px';
+    timeLegend.appendChild(timeDisplay);
+
+    const playPauseButton = document.createElement('button');
+    playPauseButton.innerHTML = '⏯️'; // Play/Pause icon
+    playPauseButton.style.marginTop = '5px';
+    playPauseButton.addEventListener('click', () => togglePlayPause(slider, playPauseButton));
+
+    timeLegend.appendChild(playPauseButton);
+
+    timeLegend.timeDisplay = timeDisplay;
+
+    return timeLegend;
+}
+
+function initializeTrackMarkers(map) {
+    const colors = ['red', 'green', 'blue', 'orange', 'purple', 'brown', 'pink', 'yellow', 'cyan', 'magenta'];
+    return gpx_points_data.map((track, index) => {
+        const color = colors[index % colors.length];
+        const marker = L.circleMarker([track[0].lat, track[0].lon], {
+            radius: 4,
+            color: color,
+            fillColor: color,
+            fillOpacity: 0.5
+        }).addTo(map);
+        return marker;
+    });
+}
+
+function updateTrackMarkers(slider, trackMarkers) {
+    const timeIndex = Math.floor(slider.value / 1000 * (gpx_timestamps.length - 1));
+    const currentTime = new Date(gpx_timestamps[timeIndex]).getTime();
+
+    trackMarkers.forEach((marker, trackIndex) => {
+        const track = gpx_points_data[trackIndex];
+        let closestPoint = track[0];
+        for (let i = 1; i < track.length; i++) {
+            const pointTime = new Date(track[i].time).getTime();
+            if (pointTime <= currentTime) {
+                closestPoint = track[i];
+            } else {
+                break;
+            }
+        }
+        marker.setLatLng([closestPoint.lat, closestPoint.lon]);
+    });
+}
+
+function updateTimeDisplay(slider, timeLegend) {
+    const timeIndex = Math.floor(slider.value / 1000 * (gpx_timestamps.length - 1));
+    const currentTime = new Date(gpx_timestamps[timeIndex]).getTime();
+    timeLegend.timeDisplay.innerHTML = `${new Date(currentTime).toUTCString()}`;
+}
+
+function updateSlider(slider) {
+    if (parseInt(slider.value) < parseInt(slider.max)) {
+        slider.value = parseInt(slider.value) + 1;
+        slider.dispatchEvent(new Event('input'));
+    } else {
+        // Slider has reached the maximum value
+        clearInterval(playbackInterval);
+        isPlaying = false;
+        resetPlayPauseButton();
+    }
+}
+
+function togglePlayPause(slider, playPauseButton) {
+    if (isPlaying) {
+        clearInterval(playbackInterval);
+        resetPlayPauseButton();
+        isPlaying = false;  // Ensure isPlaying is set to false when paused
+    } else {
+        playbackInterval = setInterval(() => updateSlider(slider), 100);
+        playPauseButton.style.backgroundColor = 'gray';
+        playPauseButton.innerHTML = '⏸️';
+        isPlaying = true;  // Set isPlaying to true when playback starts
+    }
+}
+
+function resetPlayPauseButton() {
+    const playPauseButton = document.querySelector('button');
+    playPauseButton.style.backgroundColor = '';
+    playPauseButton.innerHTML = '⏯️';
+}
+

gpx_player-0.1.0/gpx_player.egg-info/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: gpx-player
+Version: 0.1.0
+Summary: Visualise & animate GPX race tracks.
+Author: Yury Kirienko
+License: MIT License
+        
+        Copyright (c) 2023 Yury Kirienko
+        
+        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.
+        
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: folium
+Requires-Dist: jinja2
+Requires-Dist: matplotlib
+Requires-Dist: pytz
+Requires-Dist: lxml
+Requires-Dist: numpy
+Requires-Dist: gpxpy
+Dynamic: license-file
+
+# gpx-player
+## GPX Race Visualizer
+
+GPX Race Visualizer is a Python script to visualize the progression of multiple GPS tracks (e.g., from a race) on a 2D map. 
+It takes as input one or more GPX files and creates an animation showing the movement of each track over time. 
+This is a simple, open-source alternative to features like Strava's Flyby, which require an account and can have privacy issues.
+
+### Modes
+The player supports two modes:
+#### 1. "Video" mode
+Produce an `MP4` or a `GIF` file showing how the situation developed.
+For sailing races, it also calculates the distance covered after the 'start' signal and the current speed.
+##### Example:
+![Example output](example.gif "Example of the script output")
+
+#### 2. Map mode
+Displays the track on OpenSeaMap.
+You can see the full tracks with colour-coded speeds, 
+and you can 'play' the tracks and see the markers move around the map.
+
+#### Example:
+Since GitHub Markdown doesn't allow embedding HTML, 
+you can see an [interactive example](https://kirienko.github.io/static/GinSul-2024.html) here.
+
+Screenshot:
+[![OPS Example](./example_osm.png)](https://kirienko.github.io/static/GinSul-2024.html)
+## Installation
+
+Clone the repository and install the required dependencies with pip:
+
+```bash
+git clone https://github.com/kirienko/gpx-player.git
+cd gpx-player
+pip install -r requirements.txt
+```
+
+## Usage
+To run the script producing `mp4`, pass one or more GPX file paths as command-line arguments:
+```bash
+python main.py example-data/track1.gpx example-data/track2.gpx
+```
+To get a sea map, run the `openseamap.py`:
+```bash
+python openseamap.py --title 'Gin Sul Regatta 2024' --names Alex Yury Richard \
+     --files example-data/osm-demo-Alex.gpx example-data/osm-demo-Richard.gpx \
+             example-data/osm-demo-Yury.gpx
+```
+
+A more sophisticated example, that produced a video above:
+```bash
+python main.py example-data/track1.gpx example-data/track2.gpx example-data/track3.gpx \
+       --start 2023-07-01T10:53:00+0000 \
+       --names "Mr. Pommeroy" "Miss Sophie" "Sir Toby²" \
+       --title "Elbe-Damm Regatta (01.07.2023), Race 1" \
+       --race_start 2023-07-01T10:58:00+0000 --marks example-data/marks.txt -g
+```
+### Additional parameters:
+* `--title` or `-t`: The title of the video
+* `--start` or `-s`: start time in the format `2023-06-30T12:53:00+0200`, all points _before_ that will not be plotted
+* `--end` or `-e`: end time in the format `2023-06-30T13:53:00+0200`, all points _after_ that will not be plotted
+* `--names` or `-n`: names of the participants (otherwise the file names will be used in the legend)
+* `--race_start`, `-r`: Race start time in the format `YYYY-MM-DDTHH:MM:SS%z`, e.g. `2023-07-01T12:29:00+0200`
+* `--names` or `-n`: Names of the participants
+* `--marks`or`-m`: The file with the static marks to put onto the map. One pair of coordinates per line, see below.
+* `--gif` or `-g`: Save as GIF moving picture instead of MP4
+* `--timezone` or `-tz`: Local timezone to use for processing timestamps, e.g. `America/Los_Angeles`, see [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (default: `Europe/Berlin`).
+
+## Marks
+The script also supports visualizing predefined marks on the map, which can be useful for events like sailing regattas.
+The marks are defined as a list of (latitude, longitude) tuples in a separate text file and can be added to the script as follows:
+```
+53.542484632728, 9.801163896918299
+53.542997846049374, 9.80611324310303
+53.54823800356785, 9.812614917755129
+53.54921647691311, 9.807373881340029
+53.54508251196638, 9.80433225631714
+```
+
+## Getting GPX Files
+
+GPX files can be obtained from several GPS-tracking services:
+* Strava: Go to the activity page and click on the wrench icon. Then select "Export GPX".
+* Garmin Connect: Open the activity, go to the gear icon and select "Export to GPX".
+* Endomondo: From the workout page, click the three-dot menu icon and select "Export". Then choose "GPX".
+
+## GPX Validation
+
+For the `gpx-player` to work properly, it needs the correct GPX files.
+You can verify that you are inputting the correct file by using the special validator 
+included in this package.
+
+The `validator.py` script is a command-line utility and module for validating GPX files. 
+It checks for XML schema conformance and timestamp consistency, 
+supporting both strict and lenient modes. 
+Errors are raised as `GPXValidationError` which can be caught in Python code. 
+To run as a CLI tool, use:
+```bash
+python validator.py path/to/yourfile.gpx --strict
+```
+
+The `--strict` parameter is optional. In most cases you do not need it, 
+because files that strictly correspond to the GPX schema are rare. 
+For example, almost all modern files contain coordinates, elevations and time stamps 
+with more decimal places than originally planned.
+
+Also, to better understand your GPX file, you can use the `gpxinfo` console command 
+that comes with `gpxpy`. If you are already using the player, you have it:
+
+```bash
+$ gpxinfo example-data/osm_track1.gpx 
+File: example-data/osm_track1.gpx
+    Waypoints: 0
+    Routes: 0
+    Length 2D: 9.621km
+    Length 3D: 9.648km
+    Moving time: 01:05:22
+    Stopped time: n/a
+    Max speed: 3.12m/s = 11.22km/h
+    Avg speed: 2.46m/s = 8.85km/h
+    Total uphill: 97.20m
+    Total downhill: 98.40m
+    Started: 2024-07-24 15:59:05+00:00
+    Ended: 2024-07-24 17:04:27+00:00
+    Points: 776
+    Avg distance between points: 12.40m
+
+```
+
+## Support
+Now you can buy me a coffee to encourage further development!
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/kirienko)

gpx_player-0.1.0/gpx_player.egg-info/SOURCES.txt

@@ -0,0 +1,24 @@
+LICENSE
+MANIFEST.in
+README.md
+animate_tracks.js
+gpx_utils.py
+header_template.html
+legend.js
+main.py
+openseamap.py
+pyproject.toml
+speed_legend_template.html
+utils.py
+validator.py
+gpx_player.egg-info/PKG-INFO
+gpx_player.egg-info/SOURCES.txt
+gpx_player.egg-info/dependency_links.txt
+gpx_player.egg-info/entry_points.txt
+gpx_player.egg-info/requires.txt
+gpx_player.egg-info/top_level.txt
+schema/gpx_1.0.xsd
+schema/gpx_1.1.xsd
+tests/test_openseamap.py
+tests/test_utils.py
+tests/test_validation.py

gpx_player-0.1.0/gpx_player.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gpx_player-0.1.0/gpx_player.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+gpx-player = main:main
+gpx-validate = validator:main

gpx_player-0.1.0/gpx_player.egg-info/requires.txt

@@ -0,0 +1,7 @@
+folium
+jinja2
+matplotlib
+pytz
+lxml
+numpy
+gpxpy