freemocap

Free Motion Capture for Everyone 💀✨

https://github.com/freemocap/freemocap

Science Score: 67.0%

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

  • ✓
    CITATION.cff file
    Found 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: zenodo.org
  • â—‹
    Committers with academic emails
  • â—‹
    Institutional organization owner
  • â—‹
    JOSS paper metadata
  • â—‹
    Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Free Motion Capture for Everyone 💀✨

Basic Info
  • Host: GitHub
  • Owner: freemocap
  • License: agpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage: https://freemocap.org
  • Size: 271 MB
Statistics
  • Stars: 3,833
  • Watchers: 98
  • Forks: 301
  • Open Issues: 135
  • Releases: 10
Created almost 5 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Codeowners

README.md

Project Logo

The FreeMoCap Project

A free-and-open-source, hardware-and-software-agnostic, minimal-cost, research-grade, motion capture system and platform for decentralized scientific research, education, and training

DOI-via-Zenodo.org https://img.shields.io/badge/code%20style-black-000000.svg Latest Release AGPLv3 Contributions Welcome https://img.shields.io/badge/code%20style-black-000000.svg Discord Community Server

https://user-images.githubusercontent.com/15314521/192062522-2a8d9305-f181-4869-a4b9-1aa068e094c9.mp4

--

QUICKSTART

[!NOTE] For detailed installation instructions, see our official documentation's Installation page

0. Create a a Python 3.10 through 3.12 environment (python3.12 recommended)

1. Install software via pip:

pip install freemocap

2. Launch the GUI by entering the command:

freemocap

3. A GUI should pop up that looks like this:

image

4. Have fun! See the Beginner Tutorials on our official docs for detailed instructions.

5. Join the Discord and let us know how it went!


Install/run from source code (i.e. the code in this repo)

Open an Anaconda-enabled command prompt (or your preferred method of environmnet management) and enter the following commands:

1) Create a Python environment (Recommended version is python3.11)

bash conda create -n freemocap-env python=3.11

2) Activate that newly created environment

bash conda activate freemocap-env

3) Clone the repository

bash git clone https://github.com/freemocap/freemocap

4) Navigate into the newly cloned/downloaded freemocap folder

bash cd freemocap

5) Install the package via the pyproject.toml file

bash pip install -e .

6) Launch the GUI (via the freemocap.__main__.py entry point)

bash python -m freemocap

A GUI should pop up!


Documentation

Our documentation is hosted at: https://freemocap.github.io/documentation

That site is built using writerside from this repository: https://github.com/freemocap/documentation


Contribution Guidelines

Please read our contribution doc: CONTRIBUTING.md

Related

Maintainers

License

This project is licensed under the APGL License - see the LICENSE file for details.

If the AGPL does not work for your needs, we are happy to discuss terms to license this software to you with a different agreement at a price point that increases exponentially as you move spiritually away from the AGPL

Owner

  • Name: The FreeMoCap Project
  • Login: freemocap
  • Kind: organization
  • Email: info@freemocap.org
  • Location: United States of America

Free Motion Capture For Everyone

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Queen
    given-names: Philip
    orcid: https://orcid.org/0009-0009-9872-6697
  - family-names: Cherian
    given-names: Aaron
    orcid: https://orcid.org/0000-0003-4944-2814
  - family-names: Wirth
    given-names: Trenton
    orcid: https://orcid.org/0000-0002-2510-8603
  - family-names: Idehen
    given-names: Endurance
    orcid: https://orcid.org/0009-0007-8589-8436
  - family-names: Matthis
    given-names: Jonathan Samir
    orcid: https://orcid.org/my-orcid?orcid=0000-0003-3683-646X

title: "freemocap"
version: 1.0.0
doi: 10.5281/zenodo.7233713
date-released: 2024-09-30
url: "https://github.com/freemocap/freemocap"

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 953
  • Total Committers: 16
  • Avg Commits per committer: 59.563
  • Development Distribution Score (DDS): 0.547
Past Year
  • Commits: 66
  • Committers: 5
  • Avg Commits per committer: 13.2
  • Development Distribution Score (DDS): 0.515
Top Committers
Name Email Commits
jonmatthis j****s@g****m 432
Jon j****s@g****m 144
aaroncherian a****2@g****m 133
Endurance Idehen j****n@g****m 104
philipqueen q****p@g****m 99
trentwirth 6****h 11
Anatoli Babenia a****i@r****g 8
nikkirostollan n****n@g****m 8
Jakob Welner j****b@w****k 4
Jackie Allex j****x@g****m 3
kelly-phalen 5****n 2
Kiley Hartigan 4****n 1
Neil Okamoto n****o@g****m 1
Wade Croft 8****k 1
follower f****r@r****m 1
newturok n****k@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 177
  • Total pull requests: 243
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 17 days
  • Total issue authors: 83
  • Total pull request authors: 14
  • Average comments per issue: 1.95
  • Average comments per pull request: 0.94
  • Merged pull requests: 175
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 34
  • Pull requests: 69
  • Average time to close issues: 9 days
  • Average time to close pull requests: 11 days
  • Issue authors: 28
  • Pull request authors: 9
  • Average comments per issue: 1.47
  • Average comments per pull request: 0.68
  • Merged pull requests: 46
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • trentwirth (36)
  • jonmatthis (22)
  • philipqueen (15)
  • aaroncherian (12)
  • raphCode (3)
  • PooyaDeperson (3)
  • PKMpl (2)
  • ForestEco (2)
  • ariyan1403 (2)
  • jurassicjordan (2)
  • blackears (2)
  • skyace65 (2)
  • lllluy (2)
  • hhxiaohei (2)
  • noadanimation (1)
Pull Request Authors
  • philipqueen (169)
  • aaroncherian (45)
  • jonmatthis (40)
  • trentwirth (14)
  • newturok (4)
  • gonewest818 (2)
  • ksm2264 (2)
  • endurance (1)
  • mprib (1)
  • FangSen9000 (1)
  • PooyaDeperson (1)
  • paulmatthis (1)
  • emmanuel-ferdman (1)
  • hxriharan (1)
Top Labels
Issue Labels
bug (32) feature (14) enhancement (4) good first issue (3) Minor (3) community (3) Data-Output (2) Major (2) quality of life (2) question (1) UX/UI/GUI (1) documentation (1) external software (1)
Pull Request Labels
ready for review (80) Minor (19) bug (12) documentation (2) feature (2) data output (2) UX/UI/GUI (1)

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-testing.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/linting-flake8.yml actions
  • actions/checkout v3 composite
  • wntrblm/nox 2022.8.7 composite
.github/workflows/version-testing.yml actions
  • actions/checkout v3 composite
  • wntrblm/nox 2022.8.7 composite
experimental/freemocap-ui/package.json npm
  • @testing-library/jest-dom ^5.16.1 development
  • @testing-library/react ^12.1.2 development
  • @testing-library/user-event ^13.5.0 development
  • @types/axios ^0.14.0 development
  • @types/debounce ^1.2.1 development
  • @types/jest ^27.4.0 development
  • @types/lodash ^4.14.165 development
  • @types/node ^16.11.21 development
  • @types/react ^17.0.38 development
  • @types/react-dom ^17.0.11 development
  • @types/react-redux ^7.1.11 development
  • @types/react-router-dom ^5.1.6 development
  • assert ^2.0.0 development
  • buffer ^6.0.3 development
  • crypto-browserify ^3.12.0 development
  • https-browserify ^1.0.0 development
  • os-browserify ^0.3.0 development
  • process ^0.11.10 development
  • react-app-rewired ^2.2.1 development
  • stream-browserify ^3.0.0 development
  • stream-http ^3.2.0 development
  • url ^0.11.0 development
  • @emotion/react ^11.7.1
  • @emotion/styled ^11.6.0
  • @mui/icons-material ^5.2.5
  • @mui/material ^5.2.8
  • @mui/styled-engine ^5.2.6
  • @mui/system ^5.2.8
  • @reduxjs/toolkit ^1.7.1
  • @shopify/react-web-worker ^5.0.1
  • @techstark/opencv-js ^4.5.5-release.2
  • @types/dom-mediacapture-record ^1.0.11
  • @types/w3c-image-capture ^1.0.6
  • @wmik/use-media-recorder ^1.6.3-beta.0
  • axios ^0.25.0
  • class-transformer 0.5.1
  • react ^17.0.2
  • react-dom ^17.0.2
  • react-media-recorder ^1.6.6
  • react-number-format ^4.9.3
  • react-redux ^7.2.6
  • react-router ^6.2.1
  • react-router-dom ^6.2.1
  • react-scripts 5.0.0
  • react-step-wizard ^5.3.11
  • react-use ^17.3.2
  • react-use-websocket ^3.0.0
  • react-use-wizard ^2.2.0
  • react-webcam ^6.0.0
  • reflect-metadata ^0.1.13
  • three.js ^0.77.1
  • typescript 4.5.5
pyproject.toml pypi
  • aniposelib ==0.4.3
  • ipykernel ==6.23.1
  • libsass ==0.21.0
  • mediapipe *
  • opencv-contrib-python ==4.8.*
  • packaging *
  • plotly ==5.14.1
  • pydantic ==1.*
  • skelly_synchronize >=2023.9.1026
  • skelly_viewer *
  • skellycam *
  • skellyforge *
  • toml ==0.10.2
setup.py pypi
.github/workflows/flit_publish_to_pypi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
.github/workflows/publish_to_pypi.yml actions
  • actions/cache v2 composite
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/coverage-testing.yml actions
  • actions/checkout v3 composite
  • jlumbroso/free-disk-space main composite
  • wntrblm/nox 2022.8.7 composite
.github/workflows/linux_installer.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/mac_installer.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/windows_installer.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
experimental/freemocap-ui/package-lock.json npm
  • 1430 dependencies
freemocap-ui/package-lock.json npm
  • 1319 dependencies