**************
Rowingdata
**************

Based on python code by Greg Smith (https://quantifiedrowing.wordpress.com/) 
and inspired by the RowPro Dan Burpee spreadsheet (http://www.sub7irc.com/RP_Split_Template.zip)

.. image:: C:\python\rowingdata\screenshots\image001.png


===============
To install 
===============

::

	$ easy_install rowingdata

Or ::

	$ pip install rowingdata


To upgrade: ::

$ pip install --upgrade rowingdata

or ::

$ easy_install --upgrade rowingdata

======================
Command Line Tools
======================

Beta. Use with caution.

The easiest way to use rowingdata is from the command line. 

First, create a rower data file (if you don't have one yet). Just run the 
following command and answer a few questions about yourself. If you don't 
know what heart rate bands are, check here http://www.freespiritsrowing.com/content/utilities/hr-bands/ : ::

	$ roweredit yourfilename.txt

You can omit the file name. This will create a file defaultrower.txt. 
You can always run the same command to change parameters (for example 
if you lost or gained weight, change the user name or password, etc.

.. image:: C:\python\rowingdata\screenshots\editrower.JPG

Now you need the data files for your row. (The install comes with a few test 
files.) Get a TCX file (and a CSV summary file) from CrewNerd. TCX files from 
other tools should also work (not tested), as long as the TCX is valid.

Or get a CSV export from painsled. 


TCX files
-----------

Generic TCX
....................

If you have a generic TCX file (from a SpeedCoach, from a Garmin), the 
following will create plots and spit out some summary text ::

	$ tcxplot tcxfile.tcx yourrower.txt

.. image:: C:\python\rowingdata\screenshots\greghoc.png

If you prefer a time based plot: ::

	$ tcxplottime tcxfile.tcx yourrower.txt

Some TCX files do not have GPS position data. For example SpeedCoach with impeller. 
In that case: ::

	$ tcxplot_nogeo tcxfile.tcx yourrower.txt
	$ tcxplottime_nogeo tcxfile.tcx yourrower.txt

The following will upload your row to the Concept2 logbook, and create a 
file crewnerddata.tcx_o.csv that looks like a painsled csv, for future use ::

	$ tcxtoc2 tcxfile.tcx yourrower.txt

Again, yourrower.txt is optional.


.. image:: C:\python\rowingdata\screenshots\otwscreenshot.JPG

Here is the row on the Concept2 logbook:

.. image:: C:\python\rowingdata\screenshots\otwlogbook.JPG



CrewNerd with summary
.......................

Having a crewnerddata.csv (summary csv) and a crewnerddata.tcx, the following 
will create plots and spit out some summary text ::

	$ crewnerdplot crewnerddata yourrower.txt

The yourrower.txt argument is the file where you keep your rower data. 
This is optional. If you don't provide it, the tool will look for 
defaultrower.txt. If it doesn't find that, it will use some default values. 

The script will also spit out some statistics from the summary csv.

.. image:: C:\python\rowingdata\screenshots\woensdag.png


If you prefer a time based plot: ::

	$ crewnerdplottime crewnerddata yourrower.txt



Painsled
------------

Having painsled data in testdata.csv, the following will create plots and
spit out some summary text ::

	$ painsledplot testdata.csv yourrower.txt

or ::

	$ painsledplottime testdata.csv yourrower.txt

The yourrower.txt argument is the file where you keep your rower data. 
This is optional. If you don't provide it, the tool will look for 
defaultrower.txt. If it doesn't find that, it will use some default values. 

.. image:: C:\python\rowingdata\screenshots\2x20min.png



The following will upload your row to the Concept2 logbook: ::

	$ painsledtoc2 testdata.csv yourrower.txt

Again, yourrower.txt is optional.

.. image:: C:\python\rowingdata\screenshots\screenshot.JPG

Here is the row on the Concept2 logbook

.. image:: C:\python\rowingdata\screenshots\screenshotlogbook.JPG


SpeedCoach
---------------------

Having SpeedCoach data in testdata.csv, the following will create plots and
spit out some summary text ::

	$ speedcoachplot testdata.csv yourrower.txt

or ::

	$ speedcoachplottime testdata.csv yourrower.txt

The yourrower.txt argument is the file where you keep your rower data. 
This is optional. If you don't provide it, the tool will look for 
defaultrower.txt. If it doesn't find that, it will use some default values. 

The following will upload your row to the Concept2 logbook: ::

	$ speedcoachtoc2 testdata.csv yourrower.txt '2015-11-05T13:15:30-05:00'

Again, yourrower.txt and date string are optional. 
Because the SpeedCoach CSV file content doesn't have the row date, 
you may provide a date string. The tool should be quite forgiving regarding 
the exact format in which you write your date/time string. However, if
you input something ambiguous (time zone), the tool will guess 
and your row may end up on the wrong date. 
If nothing is provided, today's date will be taken.

RowPro
---------------------

Having RowPro exported data in testdata.csv, 
the following will create plots and
spit out some summary text ::

	$ rowproplot testdata.csv yourrower.txt

or ::

	$ rowproplottime testdata.csv yourrower.txt

The yourrower.txt argument is the file where you keep your rower data. 
This is optional. If you don't provide it, the tool will look for 
defaultrower.txt. If it doesn't find that, it will use some default values. 

For RowPro CSV files, upload to C2 logbook is not available on the command 
line. You can upload to C2 directly from the RowPro application.

ErgData
---------------------

If you use ErgData, you can download a CSV file from your Concept2 log. 
Here is how you use those data in this tool: ::

	$ ergdataplot testdata.csv yourrower.txt

or ::

	$ ergdataplottime testdata.csv yourrower.txt

The yourrower.txt argument is the file where you keep your rower data. 
This is optional. If you don't provide it, the tool will look for 
defaultrower.txt. If it doesn't find that, it will use some default values. 

As your data are already on the Concept2 logbook, it doesn't make sense to 
have a script to upload them once more.

Copying to clipboard
---------------------

From the command-line, this only works on windows: ::

	$ copystats testdata.csv yourrower.txt



==============================
Directly in Python
==============================

Beta. Use with caution. 


Import
---------

Import the package

>>> import rowingdata

Your personal data
-----------------------

The old and difficult way
.............................

If you're not me (or have identical heart rate thresholds), 
you will have to change the default values for the rower. For example:

>>> john = rowingdata.rower(hrut2=100,hrut1=120,hrat=140,hrtr=150,hran=170,hrmax=180,c2username="johntherower",c2password="caughtacrab")

You can store this locally like this

>>> john.write("johnsdata.txt")

Then you can load this like this

>>> john = rowingdata.read_obj("johnsdata.txt")

The new and easy way
.............................

Since version 0.65 there are easier ways.

Create a new rower through some interactive Q&A:

>>> rowingdata.roweredit("johnsdata.txt")

If you omit the file name, it will default to "defaultrower.txt"

>>> john = rowingdata.getrower("johnsdata.txt")

If you want to change John's data, again just type:

>>> rowingdata.roweredit("johnsdata.txt")

Painsled
----------------

To use with Painsled CSV data, simply do

>>> row = rowingdata.rowingdata("testdata.csv",rower=myrower)
>>> row.plotmeters_erg()
>>> print row.allstats()

RowPro
-----------------

To use with RowPro CSV data, simply do

>>> rp = rowingdata.RowProParser("RP_testdata.csv")
>>> rp.write_csv("example_data.csv")
>>> row = rowingdata.rowingdata("example_data.csv")
>>> row.plotmeters_erg()
>>> row.plottime_erg()
>>> print row.summary()

SpeedCoach
-----------------

To use with SpeedCoach CSV data, simply do

>>> sc = rowingdata.speedcoachParser("RP_testdata.csv")
>>> sc.write_csv("example_data.csv")
>>> row = rowingdata.rowingdata("example_data.csv")
>>> row.plotmeters_erg()
>>> row.plottime_erg()
>>> print row.summary()

CrewNerd (and other TCX)
---------------------------

To use with CrewNerd TCX data, simply do

>>> tcx = rowingdata.TCXParser("2016-03-25-0758.tcx")
>>> tcx.write_csv("example_data.csv")
>>> row = rowingdata.rowingdata("example_data.csv",rower=myrower)
>>> row.plotmeters_otw()
>>> row.plottime_otw()
>>> print row.summary()

Other useful stuff
----------------------------

To get any data column as a numpy array, use (for example for HR data - 
see list below for other accessible data fields).

>>> row.getvalues[' HRCur (bpm)']

Of course you have access to the entire data frame as well:

>>> df = row.df
>>> df.describe

To create the colorful plots,
assuming you have a summary file from CrewNerd called 2016-03-25-0758.CSV and 
a TCX file called 2016-03-25-0758.TCX

>>> rowingdata.dorowall("2016-03-25-0758")

Plots and statistics

>>> row.uploadtoc2()

This will upload your row to Concept2 logbook. It just simply fill the online 
form for you. So nothing more than total distance and duration, date, weight 
category and row type.

With the package at your full disposal, the sky is the limit. You can do any 
plot you like or do other statistics, like calculate your average stroke length
including error margin, etc.

==============
Data Fields
==============

The available data fields are

* 'Timestamp (sec)'
* ' Horizontal (meters)'
* ' Cadence (stokes/min'
* ' HRCur (bpm)'
* ' Stroke500mPace (sec/500m)'
* ' Power (watts)'
* ' DriveLength (meters)'
* ' StrokeDistance (meters)'
* ' DriveTime (ms)'
* ' StrokeRecoveryTime (ms)'
* ' AverageDriveForce (lbs)'
* ' PeakDriveForce (lbs)'
* 'cum_dist'

If imported from TCX, Rowpro, or other tools, some data fields may not contain
useful information. 

================
Release Notes:
================

0.75.x
-------

- Added plotting for ErgData CSV files (exported from Concept2 log)
- Improved the colorful HR bar charts (with width parameter)

0.74.x
--------

- Added command-line scripts to plot data from RowPro
- Added Pie Chart as extra plot to time based plot


0.73.x
--------

- Added parser for speedcoach CSV files
- Fixed bugs in RowProParser


0.72.x
--------

- added command line tools for generic TCX files (should work with RIM)

0.71.x
--------

- painsledDesktopParser now removes the "00 waiting to row": Statistics for Painsled Desktop work
- Command line scripts should now install well 
- Moved test data to testdata folder
- replaced * operator for the bool dtype with &
- tested on Linux (Ubuntu), Mac OS X (thx Greg), Windows 7 & Windows 10
- fixed bug related to clipboard copying on Mac and Linux. I have temporarily disabled clipboard copying of summary strings for all platforms except windows. 
- using elapsed time where possible instead of time stamps

0.65
------

- Expanded command line scripts with time plots
- Command line scripts now take a rower file as an optional second argument
- Command line script to change rower parameters easily

0.63
------

- Fixed a bug that caused unwanted forgetting of Concept2 username and password

0.62
-------

- Fixed the time plot bug which also led to errors in the Concept2 upload (needed to sort the painsled data by time)

0.6
-------

- Added command-line tools and some test data

0.52
-------

- Adding weight and row type to Concept2 upload
- Adding options to locally save concept2 username and password
- Added row type (e.g. "Indoor Rower" or "On-water") to rowingdata


0.51
-------

- Corrected some dependencies errors

0.5
-------

- Upload to Concept2 logbook is working!

0.45
--------

- Added saving and loading of rower data (so you can store your password and HR data)

0.43
--------

- Attempting to remove the dubious DataFrame copy errors using df.loc

0.42
--------
- Added RowPro CSV Parser
- Added summary statistics and interval statistics (also copies the output to clipboard)
- Interval statistics now (sort of) works for Desktop Painsled data



======================
Known bugs
======================

* Copy to clipboard doesn't work from command-line on Linux, OS X
* The summary statistics don't work well when you use the TCX from Rowing in Motion (RIM). 
* RowProParser doesn't read the header information. Total row time reported by the tool is shorter by about half a stroke. Also there are a few meters missing. As RowPro has its own upload to C2 log, I didn't fix this bug. I guess RowPro users would use the tool mainly for plotting.


=======================
Future functionality
=======================



* Add support for other erg software tools (just need the csv/tcx and it will be easy) 
  * Done for generic TCX
  * Done for CSV from SpeedCoach
  * In progress for RowPro (the parser is there but the command-line tools are missing)
  * To be Done for ergdata

* Make y axes on plots flexible (around the max and min value)

* Come up with a way to add Watts to the rowing plots 

