{ "info": { "author": "Jason K. Moore", "author_email": "moorepants@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Science/Research", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Topic :: Scientific/Engineering :: Physics" ], "description": "Introduction\n============\n\nThis is a collection of tools that are helpful for gait analysis. Some are\nspecific to the needs of the Human Motion and Control Lab at Cleveland State\nUniversity but other portions may have potential for general use. It is\nrelatively modular so you can use what you want. It is primarily structured as\na Python distribution but the Octave files are also accessible independently.\n\n.. image:: https://travis-ci.org/csu-hmc/GaitAnalysisToolKit.png?branch=master\n :target: http://travis-ci.org/csu-hmc/GaitAnalysisToolKit\n\nPython Packages\n===============\n\nThe main Python package is ``gaitanalysis`` and it contains five modules listed\nbelow. ``oct2py`` is used to call Octave routines in the Python code where\nneeded.\n\n``gait.py``\n General tools for working with gait data such as gait landmark\n identification and 2D inverse dynamics. The main class is ``GaitData``.\n``controlid.py``\n Tools for identifying control mechanisms in human locomotion.\n``markers.py``\n Routines for processing marker data.\n``motek.py``\n Tools for processing and cleaning data from `Motek Medical`_'s products,\n e.g. the D-Flow software outputs.\n``utils.py``\n Helper functions for the other modules.\n\n.. _Motek Medical: http://www.motekmedical.com\n\nEach module has a corresponding test module in ``gaitanalysis/tests``\nsub-package which contain unit tests for the classes and functions in the\nrespective module.\n\nOctave Libraries\n================\n\nSeveral Octave routines are included in the ``gaitanalysis/octave`` directory.\n\n``2d_inverse_dynamics``\n Implements joint angle and moment computations of a 2D lower body human.\n``inertial_compensation``\n Compensates force plate forces and moments for inertial effects and\n re-expresses the forces and moments in the camera reference frame.\n``mmat``\n Fast matrix multiplication.\n``soder``\n Computes the rigid body orientation and location of a group of markers.\n``time_delay``\n Deals with the analog signal time delays.\n\nInstallation\n============\n\nYou will need Python 2.7 and setuptools to install the packages. Its best to\ninstall the dependencies first (NumPy, SciPy, matplotlib, Pandas, PyTables).\nThe SciPy Stack instructions are helpful for this:\nhttp://www.scipy.org/stackspec.html.\n\nSupported versions:\n\n- python >= 2.7\n- numpy >= 1.6.1\n- scipy >= 0.9.0\n- matplotlib >= 1.1.0\n- tables >= 2.3.1\n- pandas >= 0.12.0\n- pyyaml >= 3.10\n- DynamicistToolKit >= 0.3.5\n- oct2py >= 1.2.0\n- octave >= 3.8.1\n\nWe recommend installing Anaconda_ for users in our lab to get all of the\ndependencies.\n\n.. _Anaconda: http://docs.continuum.io/anaconda/\n\nWe also utilize Octave code, so an install of Octave with is also required. See\nhttp://octave.sourceforge.net/index.html for installation instructions.\n\nYou can install using pip (or easy_install). Pip will theoretically [#]_ get\nthe dependencies for you (or at least check if you have them)::\n\n $ pip install https://github.com/csu-hmc/GaitAnalysisToolKit/zipball/master\n\nOr download the source with your preferred method and install manually.\n\nUsing Git::\n\n $ git clone git@github.com:csu-hmc/GaitAnalysisToolKit.git\n $ cd GaitAnalysisToolKit\n\nOr wget::\n\n $ wget https://github.com/csu-hmc/GaitAnalysisToolKit/archive/master.zip\n $ unzip master.zip\n $ cd GaitAnalysisToolKit-master\n\nThen for basic installation::\n\n $ python setup.py install\n\nOr install for development purposes::\n\n $ python setup.py develop\n\n.. [#] You will need all build dependencies and also note that matplotlib\n doesn't play nice with pip.\n\nDependencies\n------------\n\nIt is recommended to install the software dependencies as follows:\n\nOctave can be installed from your package manager or from a downloadable\nbinary, for example on Debian based Linux::\n\n $ sudo apt-get install octave\n\nFor oct2py to work, calling Octave from the command line should work after\nOctave is installed. For example,\n\n::\n\n $ octave\n GNU Octave, version 3.8.1\n Copyright (C) 2014 John W. Eaton and others.\n This is free software; see the source code for copying conditions.\n There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or\n FITNESS FOR A PARTICULAR PURPOSE. For details, type 'warranty'.\n\n Octave was configured for \"x86_64-pc-linux-gnu\".\n\n Additional information about Octave is available at http://www.octave.org.\n\n Please contribute if you find this software useful.\n For more information, visit http://www.octave.org/get-involved.html\n\n Read http://www.octave.org/bugs.html to learn how to submit bug reports.\n For information about changes from previous versions, type 'news'.\n\n octave:1>\n\nThe core dependencies can be installed with conda in a conda environment::\n\n $ conda create -n gait python=2.7 pip numpy scipy matplotlib pytables pandas pyyaml nose sphinx\n $ source activate gait\n\nAnd the dependencies which do not have conda packages can be installed into the\nenvironment with pip::\n\n (gait)$ pip install DynamicistToolKit oct2py\n\nTests\n=====\n\nWhen in the repository directory, run the tests with nose::\n\n $ nosetests\n\nVagrant\n=======\n\nA vagrant file and provisioning script are included to test the code on both a\nUbuntu 12.04 and Ubuntu 13.10 box. To load the box and run the tests simply\ntype::\n\n $ cd vagrant\n $ vagrant up\n\nSee ``VagrantFile`` and the ``*bootstrap.sh`` files to see what's going on.\n\nDocumentation\n=============\n\nThe documentation is hosted at ReadTheDocs:\n\nhttp://gait-analysis-toolkit.readthedocs.org\n\nYou can build the documentation (currently sparse) if you have Sphinx and\nnumpydoc::\n\n $ cd docs\n $ make html\n $ firefox _build/html/index.html\n\nContributing\n============\n\nThe recommended procedure for contributing code to this repository is detailed\nhere. It is the standard method of contributing to Github based repositories\n(https://help.github.com/articles/fork-a-repo).\n\nIf you have don't have access rights to this repository then you should fork\nthe repository on Github using the Github UI and clone the fork that you just\nmade to your machine::\n\n git clone git@github.com:/GaitAnalysisToolKit.git\n\nChange into the directory::\n\n cd GaitAnalysisToolKit\n\nNow, setup a remote called ``upstream`` that points to the main repository so\nthat you can keep your local repository up-to-date::\n\n git remote add upstream git@github.com:csu-hmc/GaitAnalysisToolKit.git\n\nNow you have a remote called ``origin`` (the default) which points to **your**\nGithub account's copy and a remote called ``upstream`` that points to the main\nrepository on the csu-hmc organization Github account.\n\nIt's best to keep your local master branch up-to-date with the upstream master\nbranch and then branch locally to create new features. To update your local\nmaster branch simply::\n\n git checkout master\n git pull upstream master\n\nIf you have access rights to the main repository simply, clone it and don't\nworry about making a fork on your Github account::\n\n git clone git@github.com:csu-hmc/GaitAnalysisToolKit.git\n\nChange into the directory::\n\n cd GaitAnalysisToolKit\n\nNow, to contribute a change to the repository you should create a new branch\noff of the local master branch::\n\n git checkout -b my-branch\n\nNow make changes to the software and be sure to always include tests! Make sure\nall tests pass on your machine with::\n\n nosetests\n\nOnce tests pass, add any new files you created::\n\n git add my_new_file.py\n\nNow commit your changes::\n\n git commit -am \"Added an amazing new feature.\"\n\nPush your commits to a mirrored branch on the Github repository that you\ncloned::\n\n git push origin my-branch\n\nNow visit the repository on Github (either yours or the main one) and you\nshould see a \"compare and pull button\" to make a pull request against the main\nrepository. Github and Travis-CI will check for merge conflicts and run the\ntests again on a cloud machine. You can ask others to review your code at this\npoint and if all is well, press the \"merge\" button on the pull request.\nFinally, delete the branches on your local machine and on your Github repo::\n\n git branch -d my-branch && git push origin :my-branch\n\nGit Notes\n---------\n\n- The master branch on main repository on Github should always pass all tests\n and we should strive to keep it in a stable state. It is best to not merge\n contributions into master unless tests are passing, and preferably if\n someone else approved your code.\n- In general, do not commit changes to your local master branch, always pull in\n the latest changes from the master branch with ``git pull upstream master``\n then checkout a new branch for your changes. This way you keep your local\n master branch up-to-date with the main master branch on Github.\n- In general, do not push changes to the main repo master branch directly, use\n branches and push the branches up with a pull request.\n- In general, do not commit binary files, files generated from source, or large\n data files to the repository. See\n https://help.github.com/articles/working-with-large-files for some reasons.\n\nRelease Notes\n=============\n\n0.1.2\n-----\n\n- Fixed bug preventing GaitData.plot_grf_landmarks from working.\n- Removed inverse_data.mat from the source distribution.\n\n0.1.1\n-----\n\n- Fixed installation issue where the octave and data files were not included in\n the installation directory.\n\n0.1.0\n-----\n\n- Initial release\n- Copied the walk module from DynamicistToolKit @ eecaebd31940179fe25e99a68c91b75d8b8f191f", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/csu-hmc/GaitAnalysisToolKit", "keywords": null, "license": "LICENSE.txt", "maintainer": null, "maintainer_email": null, "name": "GaitAnalysisToolKit", "package_url": "https://pypi.org/project/GaitAnalysisToolKit/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/GaitAnalysisToolKit/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/csu-hmc/GaitAnalysisToolKit" }, "release_url": "https://pypi.org/project/GaitAnalysisToolKit/0.1.2/", "requires_dist": null, "requires_python": null, "summary": "Various tools for gait analysis used at the Cleveland State\nUniversity Human Motion and Control Lab.", "version": "0.1.2" }, "last_serial": 1336280, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "d774eb475ab5b18dbe7db20ba7d859f5", "sha256": "821ea4dca3ef69a1ea687b0f510c77b5ad7a0b1afb94b90f212333e4a8a67137" }, "downloads": -1, "filename": "GaitAnalysisToolKit-0.1.0.tar.gz", "has_sig": false, "md5_digest": "d774eb475ab5b18dbe7db20ba7d859f5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1526504, "upload_time": "2014-12-01T20:19:13", "url": "https://files.pythonhosted.org/packages/90/87/73094f4176c1cef48623e6385b59d32bdfcd5375469343de3cbdb8ec89e0/GaitAnalysisToolKit-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "f37414501bc5afa9eb04f4f686be0d87", "sha256": "83411b5ab862d1790a5a2b05c67b95d8bf2655fc2860add98b47b6162eaa457c" }, "downloads": -1, "filename": "GaitAnalysisToolKit-0.1.1.tar.gz", "has_sig": false, "md5_digest": "f37414501bc5afa9eb04f4f686be0d87", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3958162, "upload_time": "2014-12-08T19:32:21", "url": "https://files.pythonhosted.org/packages/84/c4/c6b7ba0136c6fdd24e34c81002dbce246ef8b2bca8b4d2fc2175e0d1dd5c/GaitAnalysisToolKit-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "16a30b1d2ba9a3ed0a425c95ada6ad15", "sha256": "7801d564daf385d86569db354a025c9e12567145f1e2b9527b01dff2dfba12da" }, "downloads": -1, "filename": "GaitAnalysisToolKit-0.1.2.tar.gz", "has_sig": false, "md5_digest": "16a30b1d2ba9a3ed0a425c95ada6ad15", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1564317, "upload_time": "2014-12-08T22:14:31", "url": "https://files.pythonhosted.org/packages/3d/5b/c3f6a5f08543391c956961fecf0dad8f4dbbf4d38ccd9270d379fdaf162c/GaitAnalysisToolKit-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "16a30b1d2ba9a3ed0a425c95ada6ad15", "sha256": "7801d564daf385d86569db354a025c9e12567145f1e2b9527b01dff2dfba12da" }, "downloads": -1, "filename": "GaitAnalysisToolKit-0.1.2.tar.gz", "has_sig": false, "md5_digest": "16a30b1d2ba9a3ed0a425c95ada6ad15", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1564317, "upload_time": "2014-12-08T22:14:31", "url": "https://files.pythonhosted.org/packages/3d/5b/c3f6a5f08543391c956961fecf0dad8f4dbbf4d38ccd9270d379fdaf162c/GaitAnalysisToolKit-0.1.2.tar.gz" } ] }