mwio/jogging-dashboard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cleaned up the README.md file

Browse Source
This commit is contained in:
Marcel Weschke
2025-11-26 18:54:52 +01:00
parent e422abc1b2
commit cf76e96db6
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -86,7 +86,7 @@ pip install -r requirements.txt
python jogging_dashboard_browser_app.py python jogging_dashboard_browser_app.py
``` ```
Then open your browser and go to: Then open your browser and go to:
[http://127.0.0.1:8051](http://127.0.0.1:8051) [http://127.0.0.1:8051](http://127.0.0.1:8051)
Or as Gui-Version Or as Gui-Version
@@ -99,20 +99,20 @@ python jogging_dashboard_gui_app.py
## Uploading Your GPX File ## Uploading Your GPX File
1. Export your activity (e.g., from Strava, Garmin, etc.) as a `.gpx` or `.fit` file 1. Export your activity (e.g., from Strava, Garmin, etc.) as a `.gpx` or `.fit` file
2. Place the file into the `gpx_files/` or `fit_files/` directory 2. Place the file into the `gpx_files/` or `fit_files/` directory
3. Select it via the dropdown in the dashboard 3. Select it via the dropdown in the dashboard
--- ---
## Tech Stack ## Tech Stack
- **Dash** (by Plotly) for building the UI and graphs - **Dash** (by Plotly) for building the UI and graphs
- **Pandas** for data wrangling - **Pandas** for data wrangling
- **Plotly Graph Objects & Express** for advanced visuals - **Plotly Graph Objects & Express** for advanced visuals
- **Scipy** for smoothing the data lines - **Scipy** for smoothing the data lines
- **GPXPy** for parsing `.gpx` files - **GPXPy** for parsing `.gpx` files
- **Numpy** for vectorized math and smoothing - **Numpy** for vectorized math and smoothing
- **FitParse** for parsing `.fit` files - **FitParse** for parsing `.fit` files
--- ---
@@ -126,8 +126,8 @@ You can test the dashboard by either placing any valid `.gpx` file in the `gpx_f
## To Do / Ideas ## To Do / Ideas
- [X] Plotting heart rate data - **if** FIT file choosen. - [X] Plotting heart rate data - **if** FIT file choosen.
- [ ] Export as PDF report - [ ] Export as PDF report
- [ ] Multi-run comparison - [ ] Multi-run comparison
--- ---
@@ -139,5 +139,5 @@ This project is open source under the [MIT License](LICENSE).
## Feedback / Contributions ## Feedback / Contributions
Feel free to open issues or pull requests! Feel free to open issues or pull requests!
If you enjoy this project, a ⭐️ star is always appreciated. If you enjoy this project, a ⭐️ star is always appreciated.