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

This version

1.6.3

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

Uploaded Source

Built Distribution

freemocap-1.6.3-py3-none-any.whl (843.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for freemocap-1.6.3.tar.gz
Algorithm Hash digest
SHA256 50534a9d473c6c0af921bcefe3b4da5c00515bcebf0613c20384653a261b9457
MD5 a0e5d8e30143fa55613341679d3cb00a
BLAKE2b-256 c623757259299ba1b92ac49a28e6f786882b4fe501114e39ccecba20f25fc3bc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: freemocap-1.6.3-py3-none-any.whl
  • Upload date:
  • Size: 843.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for freemocap-1.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 52add32575dd69879bb8332a05ed830035d7b408e8597762fa7bc27f674a0e61
MD5 167c60686eebafc60ec23d1c5723f025
BLAKE2b-256 27fb5284cd70a26d238f80b21c1187a974652d18c4ace12cd7ca5207c7ee0624

See more details on using hashes here.

Supported by

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