Kinematics-vis

Kinematics-vis: A Visualization Tool for the Mathematics of Human Motion - Published in JOSS (2021)

https://github.com/klevis-a/kinematics-vis

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

JavaScript application for visualizing and analyzing shoulder joint kinematics

Basic Info
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 2
Created almost 5 years ago · Last pushed over 4 years ago
Metadata Files
Readme Contributing License Code of conduct

README.md

Kinematics-Vis

This JavaScript application enables biomechanics researchers to visualize and analyze shoulder joint kinematics. It is built on top of three.js, a JavaScript 3D library. Although presently this application is specialized for analyzing and visualizing the shoulder joint, it should be easy to extend its functionality to other joints.

Kinematics-Vis has been peer-reviewed and accepted into the Journal of Open Source Software. Checkout the associated paper: DOI

Also, checkout the live code demo currently hosted at the University of Utah Center for High Performance Computing.

Installation

This repository depends on Yarn as a package manager. Please install Yarn before proceeding.

Clone repository

git clone https://github.com/klevis-a/kinematics-vis.git cd kinematics-vis

Install dependencies and build

yarn install yarn build

Download sample dataset

yarn fetch_data

Start webpack development server

yarn webpack serve

Access web application

http://localhost:9000/main.html

Usage

Instructions for interacting with the UI are provided within the web application. Once you access the web app click the question mark that appears at the top of the upper right quadrant. A simple way to provide an input dataset for the web app is to utilize the sample dataset (yarn fetch_data). Once the sample dataset has been downloaded, click the folder icon (top of the upper left quadrant), and select a trial to analyze.

Help

Analyzing your own datasets

To analyze your own data see INPUT_FILES.md for creating file formats compatible with this web app. To specify your own dataset directory edit the DATA_DIR variable within webpack.config.js.

Manual Testing of the User Interface

See MANUAL_TESTING.md for a list of test cases that cover the basic functionality of the user interface.

Contributing

See the CONTRIBUTING document for details on contributing to the project by reporting a bug, submitting a fix, or proposing new features.

Owner

  • Name: Klevis Aliaj
  • Login: klevis-a
  • Kind: user

GitHub Events

Total
Last Year

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 187
  • Total Committers: 1
  • Avg Commits per committer: 187.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Klevis k****j@u****u 187
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 18
  • Total pull requests: 2
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 1 day
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 2.11
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • engnadeau (12)
  • destogl (6)
Pull Request Authors
  • engnadeau (1)
  • klevis-a (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

package.json npm
  • copy-webpack-plugin ^9.0.1 development
  • gulp ^4.0.2 development
  • gulp-download ^0.0.1 development
  • gulp-unzip ^1.1.0 development
  • html-webpack-plugin ^5.3.2 development
  • webpack ^5.53.0 development
  • webpack-cli ^4.8.0 development
  • webpack-dev-server ^4.2.1 development
  • papaparse 5.3.0
  • plotly.js-dist-min 1.57.0
  • svd-js 1.1.1
  • three 0.116.0
yarn.lock npm
  • 708 dependencies