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

[!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 environment 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 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

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.8.2.tar.gz (3.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

freemocap-1.8.2-py3-none-any.whl (3.5 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freemocap-1.8.2.tar.gz
  • Upload date:
  • Size: 3.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for freemocap-1.8.2.tar.gz
Algorithm Hash digest
SHA256 3c7c71dc81bb7a92b6e4b034274443a2d97a459f2d707b6843356f432ed1badb
MD5 74cd90e071aeb095084c4f9a04912d86
BLAKE2b-256 8cbd097b452e0c662bfa81c4af9e2c3746b8e541b8cd0307c2867f9f89fec087

See more details on using hashes here.

File details

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

File metadata

  • Download URL: freemocap-1.8.2-py3-none-any.whl
  • Upload date:
  • Size: 3.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for freemocap-1.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e2efde8b4533ad99cbf33fa08c7571e5f46ac5a7a842c974bd1b2ca4dc593f7b
MD5 fc0357ff82ba7032b8ad2aa21f7a29b6
BLAKE2b-256 3c74067bc9f9cf27d34b590b2b7262859c35b10ab58bfb5ced8ce03ecda555a1

See more details on using hashes here.

Supported by

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