Metadata-Version: 1.1
Name: vmpy
Version: 0.1.6
Summary: Performance Velo Metrics Toolbox
Home-page: https://github.com/sladkovm/vmpy
Author: Maksym Sladkov
Author-email: sladkovm@gmail.com
License: MIT
Description: 
        =======================================
        VMPY - Performance Velo Metrics Toolbox
        =======================================
        
        **VMPY** is a toolbox for evaluating *typical*
        *Cycling Performance Metrics* from the ride data e.g. power, heart-rate, velocity,
        gradient, cadence streams.
        
        All functions within the package do follow the convention, where input/output
        formats are either traditional *Python* built-in data structures
        or are the *nd-arrays*. This design choice favors easy integration into other projects,
        e.g. `velometria.com <http://velometria.com>`_
        
        To help you getting started VMPY also provides a very thin wrapper around the
        `Strava API <https://strava.github.io/api/>`_.
        
        
        Installation
        ============
        
        Official release:
        
        ``pip install vmpy``
        
        The bleeding edge work in progress:
        
        ``pip install git+git://github.com/sladkovm/vmpy.git@development``
        
        
        Scope
        =====
        
        The *VMPY* package provides the following functionality:
        
        ``streams.py``: Streams shape preserving calculations e.g. masking, filtering, zone conversions
        
        ``metrics.py``: Cycling Performance Metrics
        
        ``strava.py``: Python wrapper around the Strava API v3 for fetching Athletes, Activities and Stream data
        
        
        Usage
        =====
        
        >>> from vmpy import strava
        >>> stream = strava.retrieve_streams(activity_id=1282167861, access_token=STRAVA_ACCESS_TOKEN)
        
        
        >>> from vmpy import streams
        >>> power_zones = streams.compute_zones(stream['watts'], ftp=270)
        >>> hr_zones = streams.compute_zones(stream['heartrate'], lthr=160)
        >>> watts_3sec = streams.rolling_mean(stream['watts'], window=3, mask=stream['moving'])
        >>> gradient_wo_outliers = streams.median_filter(stream['grade_smooth'], window=31, threshold=1)
        
        
        >>> from vmpy import metrics
        >>> normalizes_power = metrics.normalized_power(stream['watts'])
        >>> time_in_power_zones = metrics.time_in_zones(stream['watts'], ftp=260)
        
        
        Quick Start
        ===========
        
        **Register Strava App**
        
        In order to be able to use Strava API the user App must be registered at the `<link
        http://www.strava.com/developers>`_:
        
        *Application Name:* ex.: *My Awesome App*
        
        *Website:* ex.: *myawesomeapp.com* (can be anything, even your FB or Strava page will do)
        
        *Application Description* ex.: *Just fooling around with some Strava data*
        
        *Authorization Callback Domain* *127.0.0.1* (unless you are building a serious App)
        
        **Access Token**
        
        The *Access Token* will be found at the `users profile page <https://www.strava.com/settings/api>`_
        It will look like this: *83ebeabdec09f6670863766f792ead24d61fe3f9*
        
        Access Token must be passed explicitly as an argument
        to the functions found in ``strava.py`` module
        
        
        Contribution guidelines
        =======================
        
        This project is absolutely open for contributions. No strong guidelines yet, except for:
        
        1. Don't push on master branch
        2. Test
        3. Write docstrings in NumPy style
        
        
        Useful links
        ============
        
        - Strava API v3 documentation - https://strava.github.io/api/
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
