Package: yeadon
yeadonThis package calculates the masses, center of mass positions, and inertia
tensors that correspond to the human inertia model developed by Yeadon in
(Yeadon, 1990). The package allows for the input of both measurements and
configuration variables (joint angles), and provides 3D visualization using the
MayaVi package. See the online documentation athttp://yeadon.readthedocs.org/.ReferencesM. R. Yeadon, 1990. The Simulation of Aerial Movement-ii. Mathematical Inertia
Model of the Human Body. Journal of Biomechanics, 23:67-74.Directoriesyeadon/contains the python source files for the yeadon package.doc/contains source documents for building sphinx documentation.misc/contains figures and template input files.misc/samplemeasurements/contains sample measurement input files.InstallingThis package was developed for Python 3.7+.Dependenciesyeadondepends on the following widely-used packages:setuptoolsfor installationNumPyfor computationsPyYAMLfor parsing input filesThe following packages are optional:MayaVifor visualization and GUI interactionnosefor testsSphinxto create documentationnumpydocSphinx extension for NumPy-style documentation formattingGetting the dependenciesOption 1: Scientific python distributionsMostscientific python distributionsprovide
all of these dependencies and it is often easiest to install one of them to get
started. Once you have a distribution, you can install the yeadon package. This
is the best solution for Windows users.Option 2: Operating system package managerIn some operating systems, the dependencies can also be obtained from the
operating system’s package manager. For example, in Debian systems, you should
be able to obtain all of these packages by opening a terminal window and
typing:$ # prepend sudo to each line below if you desire a system install
$ apt-get install python3-setuptools python3-numpy python3-yaml # required
$ apt-get install python3-nose python3-sphinx python3-numpydoc mayavi2 # optional packagesFor other operating systems (e.g. Windows or Mac), visit the websites for the
packages for installation instructions.Option 3: Building dependencies from sourceThis option is required if you want to useyeadonin a virtualenv. You can
build the dependencies from source and then install them by using a tool likepip:$ python -m pip install numpy PyYAML
$ python -m pip install nose sphinx mayavi
$ python -m pip install numpydocor you can obtain the source code, perhaps fromGitHub, and install the
packages manually.Getting yeadonOnce you’ve obtained the dependencies, you can installyeadon. The
easiest way to download and install theyeadonpackage is by using a tool
likepipto obtain the package from the Python Package Index (PyPi):$ python -m pip install yeadon # sudo if system installYou can also obtain an archive of the package at the Python Package Index
(https://pypi.python.org/pypi/yeadon), and then install the package on your
own by executing the following from the root directory of the package:$ python setup.py install # sudo if system installOn Unix, you can obtain the package source code and install it without leaving
your terminal:$ # change X.X.X to the desired version
$ wget https://pypi.python.org/packages/source/y/yeadon/yeadon-X.X.X.tar.gz
$ tar -zxfv yeadon-X.X.X.tar.gz
$ cd yeadon-X.X.X.tar.gz
$ python setup.py install # sudo if system installRun the tests with:$ python setup.py nosetestsBuilding the documentationYou can build the yeadon HTML documentation if you have Sphinx by typing the
following from the root directory of the yeadon source files:$ cd doc/
$ make htmlYou can open the documentation in your favorite web browser:$ firefox _build/html/index.htmlIf you have a LaTeX distribution installed you can build the LaTeX docs with:$ cd doc/
$ make latexpdfand view the document with your preferred PDF viewer:$ evince _build/latex/yeadon.pdfNote that to generate documentation, one also needs thenumpydocpackage.
Alternatively, one can just access the documentation through thePyPisite.UsageOnce the package is installed you can start the program with:$ yeadonIf you have MayaVi installed, the GUI will launch. If you don’t, the text based
UI will launch. You can explicitly specify whether you want to load the GUI or
the UI with command-line flags:$ yeadon --gui
$ yeadon --uiYou can also interact withyeadonin a Python interpreter session or Python
script/module via the API by importing the package. For example:$ python
>>> import yeadonNow you can create a human object with:>>> human = yeadon.Human(<measfilename>, <CFGfilename>)where<measfilename>and<CFGfilename>are replaced by strings that contain
a relative or absolute path to the appropriate input.txtfiles. For more
basics on how to use aHumanobject, you can go into a python command prompt
and type:>>> help(yeadon.Human)or see the documentation.You can also start the UI or the GUI from within a Python interpreter by
executing:>>> yeadon.start_ui()or:>>> yeadon.start_gui()See the documentation for more information.Cite us!If you make use of the yeadon software we would welcome a citation in your
publications. Please cite this software paper:Dembia C, Moore JK and Hubbard M. An object oriented implementation of the
Yeadon human inertia model, F1000Research 2014, 3:223 (doi:https://dx.doi.org/10.12688/f1000research.5292.1)ContactFeel free to contact Chris Dembia (chris530d, gmail) with any questions or
comments.All development is handled athttp://github.com/chrisdembia/yeadon, including
issue tracking.