Skip to main content

A free and open source markerless motion capture system for everyone 💀✨

Project description

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

0. Create a a Python 3.9 through 3.11 environment (python3.11 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! It might break! Work in Progress lol

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)
conda create -n freemocap-env python=3.11
  1. Activate that newly created environment
conda activate freemocap-env
  1. Clone the repository
git clone https://github.com/freemocap/freemocap
  1. Navigate into the newly cloned/downloaded freemocap folder
cd freemocap
  1. Install the package via the pyproject.toml file
pip install -e .
  1. Launch the GUI (via the freemocap.__main__.py entry point)
python -m freemocap

A GUI should pop up!


Documentation

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

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

freemocap-1.4.7.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

freemocap-1.4.7-py3-none-any.whl (688.9 kB view details)

Uploaded Python 3

File details

Details for the file freemocap-1.4.7.tar.gz.

File metadata

  • Download URL: freemocap-1.4.7.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for freemocap-1.4.7.tar.gz
Algorithm Hash digest
SHA256 b2e9acbaf5edd12e6dcbe52bb8f9fafb95fef04885ff8bf0e48b8401654dff8f
MD5 a54222a58f571d7e08b17f0771a2fcee
BLAKE2b-256 8fc09932bd87f74bc38c84010ff8edf3fdece40956f281ba17249cbb3e48e9be

See more details on using hashes here.

File details

Details for the file freemocap-1.4.7-py3-none-any.whl.

File metadata

  • Download URL: freemocap-1.4.7-py3-none-any.whl
  • Upload date:
  • Size: 688.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for freemocap-1.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9efe42e24c203860254e023caa2efa34f2a96c028671074623e39b21eb526d4a
MD5 11dacfac7cc0729928b5027025aa298d
BLAKE2b-256 6264491e4a115e642348341a1516425b9f72f2c0c7223b3d00b9ec44969b9108

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page