A free and open source markerless motion capture system for everyone 💀✨
Project description
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
QUICKSTART
- Install software via pip:
pip install freemocap
- Launch the GUI by entering the command:
freemocap
- A GUI should pop up that looks like this
-
Have fun! It might break! Work in Progress lol
Install/run from source code (i.e. the code in this repo)
NOTE - these are super bare-bones install instructions just to show the new entry point - these instructions will be overhauled very soon (written 2023-03-14)
Open an Anaconda-enabled command prompt (or equivalent) and enter the following commands:
- Create a
Python3.8+
environment
conda create -n freemocap-env python=3.9
- Activate that newly created environment
conda activate freemocap-env
- Clone the repository (pip install coming very soon!)
git clone https://github.com/freemocap/freemocap
- Navigate into the newly cloned/downloaded
freemocap
folder
cd freemocap
- Install the package via the
pyproject.toml
file
pip install -e .
- Launch the GUI (via the
freemocap.__main__.py
entry point)
python -m freemocap
A GUI should pop up!
Documentation and Knowledge Base (NOTE - no docs exist for the version of the GUI on the main
branch yet - these docs refer to the Alpha
release
Documentation for this software is currently pretty thin... but we're woking on it!
Here's a YouTube video that covers a lot of relevant material (check the chapters
for specific topics) - https://youtu.be/GxKmyKdnTy0
Our documentation lives here (for now) - https://freemocap.github.io/documentation
For Developers
Dev Setup
After you've done the easy install instructions, you'll be able to run our repo commands
- Run the "setup" command to set up your environment
task setup
- Run the tests to ensure that everything works appropriate
task test
Contribution Guidelines
Please read our contribution doc: CONTRIBUTING.md
Creating a new binary (may or may not work lol)
Create a new binary on your local system by running the below comand
task installer
Navigate to the /dist/
directory and you'll see the new FreeMoCap Binary there.
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
Built Distribution
Hashes for freemocap-1.0.28-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | becf53484a2a378fda106a01d3aa6c8e970597b473d290a55cf88630e8d3141a |
|
MD5 | fe46bc8bca102a5cd20f61972739731d |
|
BLAKE2b-256 | aa3d5de584f21670ef569bb063844ac5663bbd204e8ea3f6d90d42dd000d97ce |