-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
version bump & new description referencing opendata
- Loading branch information
1 parent
840dd0e
commit 58cd180
Showing
3 changed files
with
9 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,11 @@ | ||
# CheetahPy | ||
This module is used to access the locally hosted API provided by within [Golden Cheetah](https://github.com/GoldenCheetah/GoldenCheetah). | ||
This module is used to access [Golden Cheetah](https://github.com/GoldenCheetah/GoldenCheetah) based data. | ||
**CheetahPy_API** enables pythonic access to the GC API, allowing for programmatic access to GC rendered data. | ||
**opendata_dataset** enables similar access and summary/activity functions for locally stored opendata project files that have been pre-compiled by GC. | ||
|
||
Documentation specifically for the API can be found [here](https://github.com/GoldenCheetah/GoldenCheetah/wiki/UG_Special-Topics_REST-API-documentation). However, the basic hierarchy can be referenced below and knowledge of the API is unnecessary for using this module. Broadly the API provides no compute functionality and instead is purely desgined as a raw data retrieval pipeline. | ||
|
||
Golden Cheetah has five key object classes: Athletes, Activities, Zones, Measures, and Meanmax. | ||
Athlete is the node from which all others are referenced. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters