Skip to content

Commit f74f724

Browse files
committed
Updated README.md
1 parent 4c0be9e commit f74f724

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ This is a simple Python library for converting .FIT files to .GPX files. It also
66
- [GPX](https://docs.fileformat.com/gis/gpx/) is an XML based format for GPS tracks.
77

88
# When: Use Cases
9-
1. You need to convert .FIT files to pandas dataframe
9+
1. You need to convert .FIT files to pandas dataframe (e.g. for data analysis)
1010
2. You need to convert .FIT files to .GPX
11-
3. You need to fix files dowloaded from Strava by converting the raw .FIT files to their .GPX counterparts
11+
3. You need to fix files downloaded from Strava by converting the raw .FIT files to their .GPX counterparts
1212

1313
# Why
1414
#### Motivation
@@ -38,8 +38,9 @@ Step 2: Convert FIT file to 2 pd.DataFrame: fit_to_dataframes()
3838
```python
3939
df_lap, df_point = conv.fit_to_dataframes(fname='3323369944.fit')
4040
```
41-
- df_points: information per track point: longitude, latitude, altitude, timestamp, heart rate, cadence, speed
4241
- df_laps: information per lap: lap number, start time, total distance, total elapsed time, max speed, max heart rate, average heart rate
42+
- df_points: information per track point: longitude, latitude, altitude, timestamp, heart rate, cadence, speed, power, temperature
43+
- Note the 'enhanced_speed' and 'enhanced_altitude' are also extracted. Where overlap exists with their default counterparts, values are identical. However, the default or enhanced speed/altitude fields may be empty depending on the device used to record ([detailed information](https://pkg.go.dev/github.com/tormoder/fit#RecordMsg)).
4344

4445

4546
# Use Case 2: FIT to GPX
@@ -49,12 +50,12 @@ from fit2gpx import Converter
4950

5051
conv = Converter() # create standard converter object
5152
```
52-
Use case 2.1: convert a single fit file: fit_to_gpx()
53+
Use case 2.1: convert a single FIT file: fit_to_gpx()
5354
```python
5455
gpx = conv.fit_to_gpx(f_in='3323369944.fit', f_out='3323369944.gpx')
5556
```
5657

57-
Use case 2.2: convert many fit files to gpx files: fit_to_gpx_bulk()
58+
Use case 2.2: convert many FIT files to GPX files: fit_to_gpx_bulk()
5859
```python
5960
conv.fit_to_gpx_bulk(dir_in='./project/activities/', dir_out='./project/activities_convert/')
6061
```

0 commit comments

Comments
 (0)