https://github.com/raybellwaves/cfanalytics

Downloading, analyzing and visualizing CrossFit data
https://github.com/raybellwaves/cfanalytics

crossfit crossfit-games data-frames data-science python

Last synced: about 1 month ago
JSON representation

Downloading, analyzing and visualizing CrossFit data

• Host: GitHub
• URL: https://github.com/raybellwaves/cfanalytics
• Owner: raybellwaves
• License: bsd-3-clause
• Created: 2018-02-17T01:26:49.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-17T14:35:28.000Z (over 6 years ago)
• Last Synced: 2024-11-01T05:32:55.334Z (about 2 months ago)
• Topics: crossfit, crossfit-games, data-frames, data-science, python
• Language: Python
• Homepage: http://cfanalytics.readthedocs.io
• Size: 323 MB
• Stars: 27
• Watchers: 8
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
cfanalytics: Downloading, analyzing and visualizing CrossFit data

=================================================================

.. image:: https://travis-ci.org/raybellwaves/cfanalytics.svg?branch=master

   :target: https://travis-ci.org/raybellwaves/cfanalytics

.. .. image:: https://ci.appveyor.com/api/projects/status/github/raybellwaves/cfanalytics?svg=true&passingText=passing&failingText=failing&pendingText=pending

.. ..  :target: https://ci.appveyor.com/project/raybellwaves/cfanalytics

.. .. image:: https://coveralls.io/repos/github/raybellwaves/cfanalytics/badge.svg?branch=master

.. ..  :target: https://coveralls.io/github/raybellwaves/cfanalytics?branch=master

.. image:: https://img.shields.io/pypi/v/cfanalytics.svg

   :target: https://pypi.python.org/pypi/cfanalytics

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1208106.svg

   :target: https://doi.org/10.5281/zenodo.1208106

   

**cfanalytics** is an open source project and Python package that aims to provide analyzes to 

CrossFit® workouts. The goal is to enhance data-driven performance of athletes.

.. image:: https://github.com/raybellwaves/cfanalytics/blob/master/Plots/Men_Rx_2018_Overall_rank_P0.1.png

.. image:: https://github.com/raybellwaves/cfanalytics/blob/master/Plots/Women_Rx_2018_Miami_Overall_rankP0.png

Installing

----------

The version numbers 0.1.X are all development versions as I chip away at the project on here in my spare time. I occasionally build the package if i've finished something large. But you can grab the least-buggy version of this package by typing:

``pip install git+https://github.com/raybellwaves/cfanalytics``

Make sure you have the optional dependencies installed below for this to work.

The psudo-stable packages are here.

``conda install -c conda-forge cfanalytics``

``pip install cfanalytics``

As a precautionary note, it has been developed entirely on Mac OSX using Python installed with `anaconda `__. Therefore, use in Windows and Linux at your 

own peril.

As good practice, I recommend installing with anaconda/miniconda and in a new enviroment:

.. parsed-literal:: 

 

    $ conda create -n cfa python=3.6

    $ source activate cfa

    $ conda install -c matplotlib cartopy joblib netcdf4

    $ pip install motionless

    $ pip install git+https://github.com/fmaussion/salem.git

    $ pip install git+https://github.com/raybellwaves/cfanalytics

    $ # eventually: conda install -c conda-forge cfanalytics matplotlib cartopy

You can type ``source deactivate`` when finished. You can also check which environments you have created by typing ``conda info --envs``. 

To remove an environment type ``conda remove --name cfa --all``.

Optional dependencies (for plotting)

------------------------------------

- `matplotlib `__

- `cartopy `__

- `salem `__ and its dependencies

Examples

--------

See examples `here `__.

Documentation

-------------

The documentation is hosted at http://cfanalytics.readthedocs.io/

Projects using this data

------------------------

- `Unofficial 2018 Open Results `__

- `View a map of the results `__

Contributing

------------

See my TODO list `here `__.

Acknowledgements

----------------

- Thanks to posts on `r/crossfit `__. e.g. `here `__, I worked out how to download data from the `CrossFit® open `__. 

- ``Cfopendata`` is a very minor adaptation from `captamericadevs/CFOpenData `__. Who smartly developed code to download CrossFit® open data using `aiohttp `__. 

- ``Affliatelist`` used this `answer `__ as well as this `answer `__ on SO. 

- ``Cfplot().regionplot()`` was made possible by the work of the `cartopy `__ developers and developers of `Natural Earth `__.

- ``Cfplot().cityplot()`` was made possible by the work by `fmaussion `__ in `salem `__

- `xarray `__ developers. Whose package template I used for this package as well as the package itself.

Disclaimer

----------

This project is not affiliated with CrossFit, Inc.