yeadon

This 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 at https://yeadon.readthedocs.org/.

References

M. R. Yeadon, 1990. The Simulation of Aerial Movement-ii. Mathematical Inertia Model of the Human Body. Journal of Biomechanics, 23:67-74.

Directories

• yeadon/ 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.

Installing

This package works with Python 3.10+.

conda create -n yeadon-env -c conda-forge yeadon

conda create -n yeadon-env -c conda-forge yeadon mayavi

conda create -n yeadon-env -c conda-forge yeadon mayavi=*=pyside6_*

$ python -m pip install yeadon

conda create -n yeadon-env -c conda-forge numpy pyyaml mayavi pytest sphinx numpydoc pip setuptools

conda create -n yeadon-env -c conda-forge numpy pyyaml pytest sphinx numpydoc pip setuptools mayavi=*=pyside6_*

$ # 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 mayavi2 # optional packages
$ apt-get install python3-pytest python3-sphinx python3-numpydoc # development tools

$ python -m pip install numpy PyYAML  # required
$ python -m pip install mayavi  # optional
$ python -m pip install pytest sphinx numpydoc  # development tools

$ python -m pip install .

$ # 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 -m pip install .

$ pytest

Building the documentation

You 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 html

You can open the documentation in your favorite web browser:

$ firefox _build/html/index.html

If you have a LaTeX distribution installed you can build the LaTeX docs with:

$ cd doc/
$ make latexpdf

and view the document with your preferred PDF viewer:

$ evince _build/latex/yeadon.pdf

Note that to generate documentation, one also needs the numpydoc package. Alternatively, one can just access the documentation through the PyPi site.

Usage

Once the package is installed you can start the program with:

$ yeadon

If 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 --ui

You can also interact with yeadon in a Python interpreter session or Python script/module via the API by importing the package. For example:

$ python
>>> import yeadon

Now 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 .txt files. For more basics on how to use a Human object, 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)

Contact

Feel free to contact Chris Dembia (chris530d, gmail) with any questions or comments.

All development is handled at https://github.com/chrisdembia/yeadon, including issue tracking.