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

This version

1.7.4

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.7.4.tar.gz (3.1 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.7.4-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freemocap-1.7.4.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for freemocap-1.7.4.tar.gz
Algorithm Hash digest
SHA256 84fb80eff78854f0d90b8dec0a0ec43e45d348ada9c4a134382e1485e6ce9745
MD5 a28fdffcc1c41a937f1574b6ad54e3e3
BLAKE2b-256 a0685c3c2b71714de1c1f80bee72ef38f6105091ac58de8cc3d97df22280c4f3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: freemocap-1.7.4-py3-none-any.whl
  • Upload date:
  • Size: 2.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for freemocap-1.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 af736e2531439ecc67d8ab30d44269f2b8608e314fadd828afde43d9c4fbc9ab
MD5 70fa33acd93bee963ef6ca010b84161a
BLAKE2b-256 292d25c23cee6f37529c74a545e046d61b7dd850d9bb1ea4783ba924a225ce4e

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