nmelone/GoldenCheetah
1
0
Fork 0
mirror of https://github.com/GoldenCheetah/GoldenCheetah.git synced 2026-02-13 08:08:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Indentation and Item Lists

Browse Source 
.. minor tidy up
This commit is contained in:
Mark Liversedge
2013-03-25 14:09:18 +00:00
parent 8fb7ef5246
commit 405e7eee58
8 changed files with 227 additions and 227 deletions
Download Patch File Download Diff File Expand all files Collapse all files

272
doc/user/GC3-FAQ.info
View File

@@ -3,7 +3,7 @@ GC3-FAQ.texinfo.
This manual is for Golden Cheetah, version 3.0.
Copyright (C) 2013 Mark Liversedge
Copyright (C) 2013 Mark Liversedge

File: GC3-FAQ.info, Node: Top, Next: Top, Prev: Top
@@ -38,9 +38,8 @@ on the metrics tab. By default the most common metrics are listed,
including average HR, distance and so on. From v3.0 the default setup
will also include TSS as a metric you can override here.
If the metric is not there you will need to configure GoldenCheetah
to allow it to be shown. This is simple to do and described in 3.9
below.
If the metric is not there you will need to configure GoldenCheetah to
allow it to be shown. This is simple to do and described in 3.9 below.
1.2 How do I add or remove a chart?
===================================
@@ -49,12 +48,11 @@ To add a new chart to the view you can select from the + menu on the
right hand side of the scope bar (the scope bar is underneath the
toolbar and lets you select from Home, Analysis, Train etc).
Depending upon which view you are on the charts available will
differ. For example realtime plots only appear on the Train view,
whilst charts that work with individual rides will only appear on the
analysis view.
Depending upon which view you are on the charts available will differ.
For example realtime plots only appear on the Train view, whilst charts
that work with individual rides will only appear on the analysis view.
To remove a chart, when you mouse over a chart (in tabbed or tiled
To remove a chart, when you mouse over a chart (in tabbed or tiled
mode) a small triangle will appear in the top left of the chart. This
is a menu drop down, if you click on it you will see a `Close' option.
This is the option to remove (close) the chart.
@@ -64,24 +62,24 @@ This is the option to remove (close) the chart.
Weight can be maintained in 3 ways;
i. Every athlete is setup with a weight value - this is the fallback
value should no other weight measure be available. It can be found
under preferences and athlete.
* Every athlete is setup with a weight value - this is the fallback
value should no other weight measure be available. It can be
found under preferences and athlete.
ii. The 'Weight' field can be maintained in the details screen. This
is found on the 'Workout' tab in the details screen by default. Any
entry here will be used for this ride ONLY.
* The 'Weight' field can be maintained in the details screen. This
is found on the 'Workout' tab in the details screen by
default. Any entry here will be used for this ride ONLY.
iii. You can download weight from a withings scale. This is
performed manually via the menu option Tools->Get Withings Data.
This is then used to update the local measures database.
* You can download weight from a withings scale. This is performed
manually via the menu option Tools->Get Withings Data. This is
then used to update the local measures database.
When calculating W/KG the Activity value is used if present, if not
we then fall back to the last Withing measure that was collected, and
if that is not available we then fall back to the default value for the
When calculating W/KG the Activity value is used if present, if not we
then fall back to the last Withing measure that was collected, and if
that is not available we then fall back to the default value for the
athlete.
The weight from withings and weight from the activity can both be
The weight from withings and weight from the activity can both be
plotted separately in the LTM plots.
1.4 How do I plot x sec power best?
@@ -99,9 +97,9 @@ By default we do not add these charts to the layout. Aerolab can be
added to the Analysis view via the '+' menu found to the right hand
side of the GoldenCheetah scope bar.
Similarly, the Performance manager can be added to the Home layout
via the '+' menu. We may deprecate this chart in the near future since
the LTM charts can be used to plot a PMC and we expect to implement an
Similarly, the Performance manager can be added to the Home layout via
the '+' menu. We may deprecate this chart in the near future since the
LTM charts can be used to plot a PMC and we expect to implement an
interactive PMC for planning in v3.1.
1.6 What happened to weekly summary?
@@ -113,7 +111,7 @@ selection. As the weekly summary was fixed on specific charts and did
not handle other selections (e.g. monthly) it has been deprecated in
view of the diary view.
At present you can treat the Diary view as you would have the weekly
At present you can treat the Diary view as you would have the weekly
summary - they offer the same functionality. We expect the diary view
to extend to planned workouts when we implement planning functionality
in v3.1.
@@ -125,8 +123,8 @@ All chart settings can be found under the drop down menu that appears
in the top left hand corner of a chart when you mouse over it. They
will appear as a popup dialog box.
Additionally, when you move the cursor towards the title of a chart
in a view that is tabbed (not tiled) then a small selection of the most
Additionally, when you move the cursor towards the title of a chart in
a view that is tabbed (not tiled) then a small selection of the most
important settings for the chart will appear for convenience.
1.8 Where is the preferences / options panel?
@@ -136,7 +134,7 @@ On a Mac the configurations page can be found under 'GoldenCheetah ->
Preferences' on the main menu. Whilst on all other platforms it is
found via 'Tools -> Options'.
We do this to match the general guidelines for the operating system.
We do this to match the general guidelines for the operating system.
1.9 How do I change the colour of the rides on the calendar/list?
=================================================================
@@ -148,10 +146,10 @@ via the 'Data Fields' toolbar option then select Notes Processing. The
keywords and related words are scanned for to determine if the
associated colour should be used for this ride.
They are processed in the order they are defined with the first
match being returned. Take care when using values such as 'TT' and
'race' since these can also be part of an English word (e.g. ATTEMPT
contains 'TT' and graceful contains 'race'.
They are processed in the order they are defined with the first match
being returned. Take care when using values such as 'TT' and 'race'
since these can also be part of an English word (e.g. ATTEMPT contains
'TT' and graceful contains 'race'.

File: GC3-FAQ.info, Node: GENERAL, Next: METRICS, Prev: MOST COMMON QUESTIONS OF ALL, Up: Top
@@ -167,7 +165,7 @@ meter. It allows them to record, track and review their performance
against recorded data. It also allows you to ride your turbo and
collect data as you ride.
If you do not have a power meter then some of the functionality will
If you do not have a power meter then some of the functionality will
not be of use to you as a cyclist. But you can still record and track
progress. We support HR based TRIMP metrics for a HR based PMC for
example.
@@ -232,7 +230,7 @@ testing fixes. We also desperately need volunteers to translate into
non-English languages and help with writing documentation including the
maintenance of this FAQ.
If you want to help, post a note on the golden-cheetah-users mailing
If you want to help, post a note on the golden-cheetah-users mailing
list.
2.9 Can I donate to the project?
@@ -258,7 +256,7 @@ have generated over a given period of time as a single value. This is
so you can quantify the intensity of the ride and therefore the
training stress of the ride.
In practice, NP and xPower are largely the same, whilst Daniels EqP
In practice, NP and xPower are largely the same, whilst Daniels EqP
place much higher emphasise on upper intensity work. For more info on
xPower see Dr Skiba's paper on BikeScore
http://www.physfarm.com/bikescore.pdf
@@ -271,12 +269,12 @@ Scherer/Monod protocol using 3 and 20 minutes. Functional Threshold
Power (FTP) is an actual measure of the power an athlete sustains for
60 minutes.
Since it is very difficult for an athlete to maintain the desired
Since it is very difficult for an athlete to maintain the desired
intensity FTP 'reality' tends to result in a number that is much lower
than CP 'theory'. Often users will consider the two as the same.
In GC we compute TSS and BikeScore using your 'CP' value. If you set
it to your FTP value TSS will be accurate, BikeScore is likely to be
In GC we compute TSS and BikeScore using your 'CP' value. If you set it
to your FTP value TSS will be accurate, BikeScore is likely to be
lower. And if you set it to your CP value BikeScore will be accurate,
but TSS will be overstated.
@@ -300,10 +298,9 @@ We do not have a concept of 'separate' Cps for different purposes - you
will need to specify the CP when the data is imported into GC. But this
allows you to make manual adjustments.
We provide this functionality at user request - we do not endorse
the concept of multiple CP values. But we do recognise the ongoing
debate regarding physiological stress from working on a trainer vs on
the road.
We provide this functionality at user request - we do not endorse the
concept of multiple CP values. But we do recognise the ongoing debate
regarding physiological stress from working on a trainer vs on the road.
3.5 How do I seed the CTL for my PMC?
=====================================
@@ -319,7 +316,7 @@ and can set the Starting LTS.
Different programs will use different hysteresis values to smooth the
small changes in altitude. In GC we use a hysteresis value of 3m.
If this is of great concern you can adjust the hysteresis value in
If this is of great concern you can adjust the hysteresis value in
preferences under the general tab.
3.7 Why is a metric e.g. TSS or average power different in GoldenCheetah to Garmin Connect?
@@ -330,17 +327,17 @@ implemented exactly the same way in GoldenCheetah, Garmin Connect,
TrainingPeaks etc. The algorithms are extremely simple and not prone to
difficulty in implementation.
However, how each application treats pauses and stops or loss of
data accounts for most differences. In GoldenCheetah we always
calculate AP,TSS etc including stop time. Other applications choose to
ignore or smooth segments of short duration.
However, how each application treats pauses and stops or loss of data
accounts for most differences. In GoldenCheetah we always calculate
AP,TSS etc including stop time. Other applications choose to ignore or
smooth segments of short duration.
In addition, if there are anomalies in your data, with large gaps or
In addition, if there are anomalies in your data, with large gaps or
even time going backwards, this will drastically affect GoldenCheetah's
calculations.
We NEVER attempt to interpret data anomalies - if the results are
not as you would expect you will need to correct the data. We do not
We NEVER attempt to interpret data anomalies - if the results are not
as you would expect you will need to correct the data. We do not
'silently' fix the data for you. There is no secret sauce in
GoldenCheetah, we are open and transparent with your data.
@@ -360,20 +357,20 @@ add it via the GoldenCheetah preferences pane. On Mac this is from the
menu option GoldenCheetah->Preferences whilst on Windows and Linux it
is under Tools->Options.
You will need to select 'Data Fields' option from preferences
toolbar and then the 'fields' tab. You will see a list of fields that
are associated with a particular screen tab. If you scroll down you
should find entries for the 'Metrics' screen tab, you can insert a new
entry here with the '+' button. You should make sure the new entry is
called exactly the same thing as the metric in question.
You will need to select 'Data Fields' option from preferences toolbar
and then the 'fields' tab. You will see a list of fields that are
associated with a particular screen tab. If you scroll down you should
find entries for the 'Metrics' screen tab, you can insert a new entry
here with the '+' button. You should make sure the new entry is called
exactly the same thing as the metric in question.
For 'TSS' this is relatively straight forward. For others, e.g.
For 'TSS' this is relatively straight forward. For others, e.g.
'Average Heart Rate' you must make sure that the name includes spaces
etc. Once your metric has been added to the configuration you should
save that and return to the details screen where you can now maintain
it.
If you are creating a manual entry then there is no 'details' tab in
If you are creating a manual entry then there is no 'details' tab in
the dialog. Once you have created the entry (and again in this case TSS
can be entered in the dialog) you should go to the details tab to
maintain any other specific fields. The manual entry dialog is designed
@@ -391,7 +388,7 @@ The metrics are stored within a Sqlite 3 Database called 'metricDBv3'
that can be found in the athlete directory. You can use any Sqlite 3
tools to query and work with the db.
Alternatively you can export the db in its entirety using the
Alternatively you can export the db in its entirety using the
Activity->Export Metrics as CSV to export to a format you can use in a
spreadsheet program.
@@ -407,11 +404,11 @@ File: GC3-FAQ.info, Node: DATA, Next: UPLOADING AND DOWNLOADING, Prev: METRIC
You can split a file by time using the activity->split ride menu item
(or toolbar button).
To join two rides together (making one longer ride from two rides)
you can copy rows in the activity editor and paste special in the ride
To join two rides together (making one longer ride from two rides) you
can copy rows in the activity editor and paste special in the ride
editor (right click) and then select append mode.
If you wish to merge rides, that is much harder and would need to be
If you wish to merge rides, that is much harder and would need to be
performed outside of GC or by cutting and pasting columns in the
activity editor.
@@ -422,13 +419,13 @@ The activity editor has a function to find data on its toolbar. You can
specify a range or upper or lower limit and find values less than,
greater than or between a range of values.
Additionally, the editor will scan the file looking for anomalies -
Additionally, the editor will scan the file looking for anomalies -
where the data appears to be out of normal ranges. These are shown with
a wiggly red line in the editor and can also be listed by clicking on
the anomalies icon on the editor toolbar.
If the anomalies icon is not enabled on the toolbar then there are
no anomalies in the currently selected ride.
If the anomalies icon is not enabled on the toolbar then there are no
anomalies in the currently selected ride.
4.3 How can I fix 'spikes' or 'anomalies' in activity data?
===========================================================
@@ -438,7 +435,7 @@ is full undo and redo in the editor). Or you can use the fix tools that
are listed under the tool menu option (fix power spikes, fix gaps in
recording, fix gps errors, fix torque.
Each of the fix tools opens a dialog that displays texts to explain
Each of the fix tools opens a dialog that displays texts to explain
what the fix tool does.
4.4 How can I add/remove a field to edit on the details screen?
@@ -448,10 +445,10 @@ The fields (metadata) that is editable can be configured in the
preferences pane under the data fields tab. Where no screen is
specified (its left blank) it will not be made available.
GoldenCheetah ships with a number of fields defined in the config
but with no screen set. If you wish to use them simply set the screen
tab to the tab you would like it to be shown on. To remove a field set
the field tab to blank.
GoldenCheetah ships with a number of fields defined in the config but
with no screen set. If you wish to use them simply set the screen tab
to the tab you would like it to be shown on. To remove a field set the
field tab to blank.
4.5 What are 'special fields' ?
===============================
@@ -460,15 +457,15 @@ There are a number of fields that when maintained in the details screen
will be used elsewhere in the code to calculate metrics or for other
purposes.
Some examples include;
Some examples include;
Weight - used in W/KG calculations, Sport and Workout code are
used when exporting to other file formats, Identifier is used to
assign a UUID to the activity when it is uploaded to online
services and so on.
Weight - used in W/KG calculations, Sport and Workout code are used
when exporting to other file formats, Identifier is used to assign a
UUID to the activity when it is uploaded to online services and so
on.
There is a full list of special fields and their meaning in the
Golden Cheetah user guide appendices.
There is a full list of special fields and their meaning in the Golden
Cheetah user guide appendices.
4.6 How do I find/add/sort/delete/edit intervals ?
==================================================
@@ -477,8 +474,8 @@ The context menu (on the right hand side of the splitter handle) for
the interval sidebar in Analysis view contains a number of options for
working with intervals.
Additionally, you can click and drag on the performance (aka ride)
plot to visually define an interval.
Additionally, you can click and drag on the performance (aka ride) plot
to visually define an interval.
4.7 How can I export to a specific file format?
===============================================
@@ -525,8 +522,8 @@ GPS data then Strava is not likely to play nice. In addition many of
the other data series will be ignored. This is related to Strava data
processing in V2.0 of their API.
We always upload as TCX since the JSON flavour of their API appears
to have less functionality.
We always upload as TCX since the JSON flavour of their API appears to
have less functionality.
5.4 What settings do I need to get GoldenCheetah to upload to my Google Calendar?
=================================================================================
@@ -536,10 +533,10 @@ to specify a collection. This means when entering the details in the
passwords pane of preferences you should use the following for the
caldav url:
https://www.google.com/calendar/dav/xxxx@gmail.com/events/
https://www.google.com/calendar/dav/xxxx@gmail.com/events/
Where xxxx is your username. The username will need to be repeated
in the username field and obviously set the password too.
Where xxxx is your username. The username will need to be repeated in
the username field and obviously set the password too.

File: GC3-FAQ.info, Node: SEASONS AND EVENTS, Next: CHARTS, Prev: UPLOADING AND DOWNLOADING, Up: Top
@@ -578,7 +575,7 @@ Assuming the chart allows you to specify a date range you can select
similarly 'This' 'month' and prior '2' is a month 2 months ago, whilst
'This' 'month' and prior '1' is last month.
'This' 'month' prior and 0 is just this month.
'This' 'month' prior and 0 is just this month.
7.2 How does the mean max chart calculate CP when showing power?
================================================================
@@ -587,7 +584,7 @@ The CP algorithm searches your best power for two durations; for
anaerobic efforts it looks between 15s and 1min, for aerobic it looks
for best efforts between 10mins and an hour.
Once it has found these two best values it will curve fit the two to
Once it has found these two best values it will curve fit the two to
enable the 60min value to be extracted. Bear in mind this is a
theoretical number and as described above is applicable to the
BikeScore algorithm. The value for FTP that the TSS algorithm requires
@@ -600,7 +597,7 @@ you have performed a 60minute test recently.
The following is a brief piece of advice from Robert Chung, from a
discussion on the Golden Cheetah Users mailing list:
Ideally, you'll want calm conditions (both in terms of wind and
Ideally, you'll want calm conditions (both in terms of wind and
traffic) but here's a quickie test you can do just to get a handle
on what to do. Try to find a loop without stop signs, or an
out-and-back with maybe a little dip or something in the middle. Make
@@ -609,24 +606,24 @@ around my block a few times. Do a loop in the drops, then another
loop faster, then a loop slower; then repeat with your hands on the
hoods.
Weigh yourself and the bike and ballpark the air density.
Weigh yourself and the bike and ballpark the air density.
See whether you can come close to modeling the "true" elevation
profile by sliding the CdA slider around. Even with this informal
test, as long as the wind isn't blowing too hard, you ought to be
able to see a difference between the loops where you were in the
drops and the loops where you on the hoods, and to spot little bumps
and dips in the road.
See whether you can come close to modeling the "true" elevation profile
by sliding the CdA slider around. Even with this informal test, as
long as the wind isn't blowing too hard, you ought to be able to
see a difference between the loops where you were in the drops and
the loops where you on the hoods, and to spot little bumps and dips in
the road.
There is also an overview of Virtual Elevation to measure
aerodynamics in this YouTube video from the power seminar at Interbike
2011 given by Jim Meyer the founder of Quarq:
There is also an overview of Virtual Elevation to measure aerodynamics
in this YouTube video from the power seminar at Interbike 2011 given by
Jim Meyer the founder of Quarq:
http://www.youtube.com/watch?v=b8tJnFE_BFg&feature=youtu.be&t=27m58s
http://www.youtube.com/watch?v=b8tJnFE_BFg&feature=youtu.be&t=27m58s
Finally, Robert Chung's original paper is included in the docs
section of the GoldenCheetah repository, you can it up here (click on
'View Raw' to download):
Finally, Robert Chung's original paper is included in the docs section
of the GoldenCheetah repository, you can it up here (click on 'View
Raw' to download):
https://github.com/GoldenCheetah/GoldenCheetah/blob/master/doc/contrib/ChungVE.pdf
@@ -651,10 +648,10 @@ maintain details for each ride e.g. workout code, sport et al.
With the exception of the Long Term Metric plots the colours on the
charts are configured in the GoldenCheetah preferences pane.
We want to use the same colours to plot each data series across the
We want to use the same colours to plot each data series across the
charts, so you can change them globally.
The only colours you cannot change are the colours assigned to
The only colours you cannot change are the colours assigned to
intervals when plotting them on scatterplot or PfPv. These colours are
assigned according to their sequence.
@@ -664,11 +661,10 @@ assigned according to their sequence.
You can zoom in on the distribution, scatterplot and PfPv charts by
selecting the zoom area with the left click of the mouse.
On the performance (ride) plot you can zoom with the span slider at
the bottom of the chart (if you select the full plot in the chart
settings).
On the performance (ride) plot you can zoom with the span slider at the
bottom of the chart (if you select the full plot in the chart settings).
There are no other zoom options for the other charts.
There are no other zoom options for the other charts.
7.8 I zoomed in but can't zoom out?
===================================
@@ -693,69 +689,69 @@ Index
* Menu:
* add: MOST COMMON QUESTIONS OF ALL.
(line 21)
(line 20)
* adhoc: SEASONS AND EVENTS. (line 9)
* Aerolab <1>: MOST COMMON QUESTIONS OF ALL.
(line 71)
(line 69)
* Aerolab: CHARTS. (line 33)
* algorithm: CHARTS. (line 19)
* anomalies: DATA. (line 38)
* AP: METRICS. (line 81)
* AP: METRICS. (line 80)
* best: MOST COMMON QUESTIONS OF ALL.
(line 63)
(line 61)
* bug: GENERAL. (line 66)
* Chung: CHARTS. (line 33)
* clone: GENERAL. (line 40)
* colour <1>: CHARTS. (line 84)
* colour: MOST COMMON QUESTIONS OF ALL.
(line 117)
(line 115)
* contribute: GENERAL. (line 73)
* CP <1>: METRICS. (line 22)
* CP <2>: CHARTS. (line 19)
* CP: METRICS. (line 50)
* CSV: DATA. (line 88)
* CTL: METRICS. (line 64)
* CTL: METRICS. (line 63)
* cycle: SEASONS AND EVENTS. (line 9)
* Daniels: METRICS. (line 9)
* donate: GENERAL. (line 85)
* download <1>: GENERAL. (line 31)
* download: UPLOADING AND DOWNLOADING.
(line 16)
* elevation: METRICS. (line 72)
* elevation: METRICS. (line 71)
* EqP: METRICS. (line 9)
* event: SEASONS AND EVENTS. (line 18)
* feature: GENERAL. (line 66)
* FITLOG: DATA. (line 88)
* FTP: METRICS. (line 50)
* Garmin Connect: METRICS. (line 81)
* Garmin Connect: METRICS. (line 80)
* github: GENERAL. (line 40)
* Google: UPLOADING AND DOWNLOADING.
(line 33)
* install: GENERAL. (line 31)
* join: DATA. (line 9)
* JSON: DATA. (line 88)
* LTS: METRICS. (line 64)
* LTS: METRICS. (line 63)
* mail: GENERAL. (line 56)
* map: CHARTS. (line 69)
* merge: DATA. (line 9)
* month: CHARTS. (line 9)
* NP: METRICS. (line 9)
* options: MOST COMMON QUESTIONS OF ALL.
(line 108)
* override: METRICS. (line 111)
* PMC <1>: METRICS. (line 64)
(line 106)
* override: METRICS. (line 110)
* PMC <1>: METRICS. (line 63)
* PMC: MOST COMMON QUESTIONS OF ALL.
(line 71)
(line 69)
* preferences: MOST COMMON QUESTIONS OF ALL.
(line 108)
(line 106)
* prior: CHARTS. (line 9)
* PWX: DATA. (line 88)
* remove: MOST COMMON QUESTIONS OF ALL.
(line 21)
(line 20)
* report: GENERAL. (line 66)
* season: SEASONS AND EVENTS. (line 9)
* settings: MOST COMMON QUESTIONS OF ALL.
(line 97)
(line 95)
* source: GENERAL. (line 40)
* spikes: DATA. (line 23)
* split: DATA. (line 9)
@@ -767,31 +763,31 @@ Index
(line 16)
* treemap: CHARTS. (line 77)
* triathlete: GENERAL. (line 47)
* TSS <1>: METRICS. (line 81)
* TSS <1>: METRICS. (line 80)
* TSS: MOST COMMON QUESTIONS OF ALL.
(line 9)
* unzoom: CHARTS. (line 109)
* unzoom: CHARTS. (line 108)
* upload: UPLOADING AND DOWNLOADING.
(line 9)
* VE: CHARTS. (line 33)
* weekly summary: MOST COMMON QUESTIONS OF ALL.
(line 83)
(line 81)
* weight: MOST COMMON QUESTIONS OF ALL.
(line 38)
(line 36)
* xPower: METRICS. (line 9)
* zoom: CHARTS. (line 109)
* zoom: CHARTS. (line 108)

Tag Table:
Node: Top167
Node: MOST COMMON QUESTIONS OF ALL612
Node: GENERAL6071
Node: METRICS9718
Node: DATA16744
Node: UPLOADING AND DOWNLOADING20701
Node: SEASONS AND EVENTS22473
Node: CHARTS23332
Node: INDEX28161
Node: Top164
Node: MOST COMMON QUESTIONS OF ALL609
Node: GENERAL6062
Node: METRICS9703
Node: DATA16693
Node: UPLOADING AND DOWNLOADING20623
Node: SEASONS AND EVENTS22386
Node: CHARTS23245
Node: INDEX28042

End Tag Table

BIN
doc/user/GC3-FAQ.pdf
View File

Binary file not shown.

10
doc/user/GC3-FAQ.texinfo
View File

@@ -3,6 +3,7 @@
@setfilename FAQ.texinfo
@settitle Golden Cheetah FAQ
@c %**end of header
@paragraphindent 0
@copying
This manual is for Golden Cheetah, version 3.0.
@@ -80,16 +81,19 @@ you will see a `Close' option. This is the option to remove (close) the chart.
Weight can be maintained in 3 ways;
i. Every athlete is setup with a weight value -- this is the fallback value should no
@itemize @bullet
@item Every athlete is setup with a weight value -- this is the fallback value should no
other weight measure be available. It can be found under preferences and athlete.
ii. The 'Weight' field can be maintained in the details screen. This is found on the
@item The 'Weight' field can be maintained in the details screen. This is found on the
'Workout' tab in the details screen by default. Any entry here will be used for this ride
ONLY.
iii. You can download weight from a withings scale. This is performed manually via the
@item You can download weight from a withings scale. This is performed manually via the
menu option Tools->Get Withings Data. This is then used to update the local measures
database.
@end itemize
When calculating W/KG the Activity value is used if present, if not we then fall back to
the last Withing measure that was collected, and if that is not available we then fall

BIN
doc/user/GC3-Manual.pdf
View File

Binary file not shown.

1
doc/user/GC3-Manual.texinfo
View File

@@ -3,6 +3,7 @@
@setfilename GC3-Manual.texinfo
@settitle Golden Cheetah User Manual
@c %**end of header
@paragraphindent 0
@copying
This manual is for Golden Cheetah, version 3.0.

170
doc/user/GC3-Release.info
View File

@@ -26,24 +26,24 @@ Over the last 3 years the performance and stability of GoldenCheetah
has been improved considerably. One of the major criticisms of the
software was it crashing.
We have fixed 46 serious issues and over 400 bugs in over 1,500
We have fixed 46 serious issues and over 400 bugs in over 1,500
different commits. GoldenCheetah is now over 100,000 lines of code and
is used by 1000s of users around the world, from Santiago to Singapore
and Auckland to Aberdeen.
In addition to addressing stability issues we have also looked
closely at performance. Whilst the new metric functionality and
database means that a modern PC is recommended, the code is still
efficient enough to run on a netbook.
In addition to addressing stability issues we have also looked closely
at performance. Whilst the new metric functionality and database means
that a modern PC is recommended, the code is still efficient enough to
run on a netbook.
We have introduced pre-computed metrics alongside a cache of ride
bests across all the main data series to ensure that analysis of long
term data is as quick and responsive as possible. We also introduced
our own file format using JSON as an open file format, with a custom
parser. We can now read a 1hr ride 20x faster using our native format
than using an equivalent and very popular XML format.
We have introduced pre-computed metrics alongside a cache of ride bests
across all the main data series to ensure that analysis of long term
data is as quick and responsive as possible. We also introduced our own
file format using JSON as an open file format, with a custom parser. We
can now read a 1hr ride 20x faster using our native format than using
an equivalent and very popular XML format.
In short, we've squashed the big bugs and made it run much faster.
In short, we've squashed the big bugs and made it run much faster.
1.2 Redesigned UI and UX
========================
@@ -53,28 +53,28 @@ major changes to the user experience and user interface. From the
initial help screens for new users through to the redesigned preferences
pane for advanced users, it is slicker and more professional.
We wanted an elegant and clean user interface that was intuitive to
use and revealed complexity when it was required. We think we've come
We wanted an elegant and clean user interface that was intuitive to use
and revealed complexity when it was required. We think we've come
pretty close.
There are 4 views available with specific and detailed sidebars for
There are 4 views available with specific and detailed sidebars for
peformancee tracking (home), short term tracking (diary) as well as the
well known analysis and training views from earlier releases.
We now allow you to view charts tabbed and tiled, you can resize and
We now allow you to view charts tabbed and tiled, you can resize and
move charts around and customise them using roll-over controls. The
activity list is fully configurable and can be configured to show any
number of columns. We have overhauled and introduced friendly wizards
for adding devices and athletes through to manual activity entry.
The UI is largely native on a Mac and the same UI and UX has been
The UI is largely native on a Mac and the same UI and UX has been
replicated on Linux and Windows. We also support full screen including
Lion fullscreen support on a Mac.
We have been through many, many iterations to get to this UX and it
has been widely tested and critiqued by a large community of GC users.
We have been through many, many iterations to get to this UX and it has
been widely tested and critiqued by a large community of GC users.
We think this is the best looking and most intuitive version of
We think this is the best looking and most intuitive version of
GoldenCheetah ever released.
1.3 Support for the latest bike computers
@@ -84,8 +84,8 @@ We have added direct download support for the Cyclops Joule and Joule
GPS as well as the latest SRM Powercontrol 6 and 7. We also added
support for the O-sync Macro and Macro X.
In addition to this we also fixed a few issues related to importing
from newer Garmin devices since the file format changed.
In addition to this we also fixed a few issues related to importing from
newer Garmin devices since the file format changed.
1.4 Support for more telemetry
==============================
@@ -102,9 +102,9 @@ formats. We believe it is your data and it should not be locked into any
sotfware. We support open formats such as TCX, PWX, JSON and XML as well
as FITLOG and GPX.
We have also added support for reading files from SportTracks, GPX,
Tacx CAF and the SLF/SMF file formats. We have also added legacy WKO+
file format support (CP 1.0 and 1.1) as well as import of Wattbike TXT
We have also added support for reading files from SportTracks, GPX, Tacx
CAF and the SLF/SMF file formats. We have also added legacy WKO+ file
format support (CP 1.0 and 1.1) as well as import of Wattbike TXT
exports.
1.6 Support for a wide selection of Cloud services
@@ -129,16 +129,15 @@ is built in using VLC/QTKit. We manage a media library to make sure you
can re-use any content you may have from Tacx Ergvideos through
Sufferfest.
We support Virtual Power for popular devices from KK, LeMond and
many other trainers. We have added support for the amazing new Wahoo
We support Virtual Power for popular devices from KK, LeMond and many
other trainers. We have added support for the amazing new Wahoo
Fitness Kickr trainer as well as the old Tacx Fortius.
In the train view we have added lots of new ways to ride on the
trainer including; Streetview, SpinScan (on Computrainer) and an
enhanced Workout Plot that plots telemetry against the workout as you
ride.
In the train view we have added lots of new ways to ride on the trainer
including; Streetview, SpinScan (on Computrainer) and an enhanced
Workout Plot that plots telemetry against the workout as you ride.
Finally we've added Computrainer calibration, a workout wizard and
Finally we've added Computrainer calibration, a workout wizard and
download from ErgDB as well as Multi-device Support allowing you to
ride with with your ANT+ powermeter on your Computrainer, Kickr or
Fortius.
@@ -151,17 +150,17 @@ enabling lightning quick searches for past activities. We use a well
proven and lightning fast indexing tool (CLucene) to index all the
details of your activities seamlessly.
Additionally we have introduced a data filter (using the same search
Additionally we have introduced a data filter (using the same search
box) to allow you to filter activities for specific properties, for
example for all rides with a TSS > 300 or perhaps those with an IF >0.9
and a duration of > 1hr.
Both the search and filter functions can be applied to the charts -
Both the search and filter functions can be applied to the charts -
which means that you can plot a PMC only where sport is "Bike" or
perhaps power distribution but only where the workout code is FTPTEST.
We are still discovering how powerful these tools are when applied
to long term performance tracking.
We are still discovering how powerful these tools are when applied to
long term performance tracking.
1.10 Lots of new charts
=======================
@@ -169,17 +168,17 @@ to long term performance tracking.
It wouldn't be a new release of GoldenCheeth if we didn't introduce
some new charts for detailed forensic data analysis.
We've added a new HR to Power analysis as well as a more utilitarian
2d scatter plot. We've added Bing as map provider for the Map chart.
We've added a new HR to Power analysis as well as a more utilitarian 2d
scatter plot. We've added Bing as map provider for the Map chart.
But the single most asked for feature, and one that has been on the
GC wish list since it was first released is the ability to plot a
But the single most asked for feature, and one that has been on the GC
wish list since it was first released is the ability to plot a
distribution for a date range. We can now do that - allowing you to
plot power distribution for a season or month or any number of
sophisticated date ranges (we also added lots of advance ways to
express date ranges).
Lastly, we have also extended the CP curve to plot more than just
Lastly, we have also extended the CP curve to plot more than just
power. It will now plot a mean max curve for HR, Power, Speed, Cadence,
xPower, NP et al. And we even added VAM too, for you mountain goats.
@@ -190,15 +189,15 @@ Yes, we've been granted permission by our friends at TrainingPeaks to
use their cylcing metrics in the latest version of GoldenCheetah. We
know that it is one of the most popular additions.
Not only have we added them as metrics to plot and track, we've also
Not only have we added them as metrics to plot and track, we've also
added them to the realtime training so you can target an intensity of
stress for a workout and monitor and adjust the intensity of the
workout as you ride.
We have also added a whole host of new metrics, there are now over
100 different metrics and measures you can work with including things
like; Pace, Maximums, Gradient, VAM, wpk, time in HR Zones and many,
many more.
We have also added a whole host of new metrics, there are now over 100
different metrics and measures you can work with including things like;
Pace, Maximums, Gradient, VAM, wpk, time in HR Zones and many, many
more.
1.12 Build and Platform support
===============================
@@ -208,7 +207,7 @@ Dependency, which means you can build GC with nothing more than QT4.8
installed (we will support QT5 in v3.1). We now support OpenBSD and
have moved to using version 6.1 of the QWT library.
On a related note, you can see all the versions used, contributors
On a related note, you can see all the versions used, contributors
involved and build settigs as we have improved the about box to give
much more useful information to developers.
@@ -219,8 +218,8 @@ Shock. We now have an FAQ covering over 50 of the most commonly asked
questions about GoldenCheetah. And a full user manual to compliment the
existing wiki for user generated content.
One of the other criticisms we often heard about GoldenCheetah was
how hard it was to use, and how you needed to be a cycling nerd to
One of the other criticisms we often heard about GoldenCheetah was how
hard it was to use, and how you needed to be a cycling nerd to
understand it. We feel that the new UI and User Experience coupled with
much better documentation and help mean this should make this version
of GoldenCheetah the easiest to use yet.
@@ -237,7 +236,7 @@ File: GC3-Release.info, Node: CONTRIBUTORS, Next: WHATS NEW, Prev: WHATS NEW,
Literally thousands of people regularly download, install, develop,
critique and discuss GoldenCheetah and its features and functions.
Back in 2006 a stupendously gifted guy (and Cat 1 racer) called Sean
Back in 2006 a stupendously gifted guy (and Cat 1 racer) called Sean
Rhea bought a Powertap. Frustrated with the software that was available
he set about writing some utilities to plot the data. But first he had
to reverse engineer the protocol to talk to it. Back then, and to a
@@ -246,67 +245,66 @@ their product and you're stuck with their software. Sean did something
amazing - he open sourced his code. By doing that he changed power
analysis completely.
Here in 2013 with ANT+, BTLE, Wahoo, TrainerRoad, PerfPro and of
course GoldenCheetah things look very different. The cycling world has
gone open. Sean can take some of the credit for that.
Here in 2013 with ANT+, BTLE, Wahoo, TrainerRoad, PerfPro and of course
GoldenCheetah things look very different. The cycling world has gone
open. Sean can take some of the credit for that.
We stand on his shoulders.
We stand on his shoulders.
Here in 2013 by far and away the biggest contributors to this
project are Damien Grauser and Mark Liversedge. Between the two of
them they have committed almost 90% of all code to GoldenCheetah in the
last 3 years. Often working on stuff for others they are the reason this
Here in 2013 by far and away the biggest contributors to this project
are Damien Grauser and Mark Liversedge. Between the two of them they
have committed almost 90% of all code to GoldenCheetah in the last 3
years. Often working on stuff for others they are the reason this
release is written for you the cyclist .. and not us the developers.
Of equal importance is Gareth Coco our devops guru. With
unfathomable patience he has built countless release candidates and
development builds for the last 3 years. He has worked with an ever
changing and hideous array of wacky dependencies across Windows, Mac
and Linux. He is pretty much the only reason you can download and
install our software. Big, big thanks to Gareth.
Of equal importance is Gareth Coco our devops guru. With unfathomable
patience he has built countless release candidates and development
builds for the last 3 years. He has worked with an ever changing and
hideous array of wacky dependencies across Windows, Mac and Linux. He
is pretty much the only reason you can download and install our
software. Big, big thanks to Gareth.
Thats not to say that there aren't many other significant
contributions too; Ale Martinez has masterminded and developed
multi-language support in V3. Translations have been undertaken by Ale
himself, but also by Til Schmiedeberg, Keisuke Yamaguchi, Marco
Piccirilli, Sergei Chekhovskii and Rafael Oliveira Ribeiro.
Thats not to say that there aren't many other significant contributions
too; Ale Martinez has masterminded and developed multi-language support
in V3. Translations have been undertaken by Ale himself, but also by
Til Schmiedeberg, Keisuke Yamaguchi, Marco Piccirilli, Sergei
Chekhovskii and Rafael Oliveira Ribeiro.
A large number of developers have contributed small and large bits
of code, and many clever coaches and athletes have donated their ideas
and best practices. I must shout out to Dr Andrea Morelli the
professional coach, for his encouragement and insight over the last 3
years and Greg Steele for some of the most interesting and inspriring
thoughts.
A large number of developers have contributed small and large bits of
code, and many clever coaches and athletes have donated their ideas and
best practices. I must shout out to Dr Andrea Morelli the professional
coach, for his encouragement and insight over the last 3 years and Greg
Steele for some of the most interesting and inspriring thoughts.
Here are all the contributors, all of them have made this version of
Here are all the contributors, all of them have made this version of
GoldenCheetah the best yet;
Alejandro Martinez, Andrew Bryson, Andy Froncioni, Austin Roach,
Berend De Schouwer, Bruno Assis, Chris Cleeland, Claus Assmann, Dag
Gruneau, Damien Grauser, Darren Hague, Dean Junk, Eric Brandt, Eric
Murray, Frank Zschockelt, Gareth Coco, Greg Lonnon, Ilja Booij, Jaime
Jofre, Jamie Kimberley, Jim Ley, John Ehrlinger, Josef Gebel, Julian
Alejandro Martinez, Andrew Bryson, Andy Froncioni, Austin Roach, Berend
De Schouwer, Bruno Assis, Chris Cleeland, Claus Assmann, Dag Gruneau,
Damien Grauser, Darren Hague, Dean Junk, Eric Brandt, Eric Murray,
Frank Zschockelt, Gareth Coco, Greg Lonnon, Ilja Booij, Jaime Jofre,
Jamie Kimberley, Jim Ley, John Ehrlinger, Josef Gebel, Julian
Baumgartner, Julian Simioni, Justin Knotzke, Keisuke Yamaguchi, Ken
Sallot, Luke NRG, Magnus Gille, Marc Boudreau, Mark Liversedge, Mark
Rages, Mitsukuni Sato, Ned Harding, Patrick McNerthney, Rainer Clasen,
Robb Romans, Robert Carlsen, Roberto Massa, Ron Alford, Sean Rhea,
Steven Gribble, Thomas Weichmann, Walter Burki.
Finally a big shout out to three amazing people; Jamie Kimberley who
Finally a big shout out to three amazing people; Jamie Kimberley who
has been the glue that held the GoldenCheetah community together,
Robert Carlsen who has always been the cool guy in the glasses that
does the cool stuff. And last but not least, my friend Justin Knotzke
who demands and gets the best from all of us.
Jamie, Robert and Justin have stepped away from regular involvement
in GoldenCheetah, but their contributions have set the standard and
will not be forgotten. Cheers Guys.
Jamie, Robert and Justin have stepped away from regular involvement in
GoldenCheetah, but their contributions have set the standard and will
not be forgotten. Cheers Guys.

Tag Table:
Node: Top0
Node: WHATS NEW310
Node: CONTRIBUTORS9362
Node: CONTRIBUTORS9287

End Tag Table

BIN
doc/user/GC3-Release.pdf
View File

Binary file not shown.

1
doc/user/GC3-Release.texinfo
View File

@@ -3,6 +3,7 @@
@setfilename Release Notes.texinfo
@settitle Golden Cheetah v3.0 Release Notes
@c %**end of header
@paragraphindent 0
@titlepage
@title Golden Cheetah v3.0 Release Notes