π 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
Note: This will install the latest/last version from the pre-alpha
phase of this project, frozen at release tag v0.0.54
here
Open an Anaconda-enabled command prompt or powershell window and enter the following commands:
- Create a Python3.7 Anaconda environment
conda create -n freemocap-env python=3.7
- Activate that newly created environment
conda activate freemocap-env
- Install freemocap (version
0.0.54
) from PyPi usingpip
pip install freemocap==0.0.54
That should be it!
tl;dr- Activate the freemocap Python environment and run the following lines of code (either in a script or in a console)
import freemocap
freemocap.RunMe()
But COOL KIDS will install Blender (blender.org and generate an awesome .blend
file animation by setting useBlender=True
:
import freemocap
freemocap.RunMe(useBlender=True)
For additional, more detailed instructions (including methods to re-process recorded sessions), refer to the OLD_README.md
document)
- Python 3.9
- Git
- Blender
- At least 2 simple webcameras (but we recommend using at least 3 for better results)
- Any USB webcam should work here's an example of a camera we have used successfully
- Each Camera must have a clean, unobstructed view of a Charuco board during initialization.
- Install the Homebrew Package manager (Skip this step if you already have it)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
- Install Git (Skip this step if you already have it)
brew install git
- Get the source code.
git clone https://github.com/freemocap/freemocap.git
- Install the dependencies
brew install blender ffmpeg
- Skip to our Getting Started section of the README below.
- Install Chocolatey. Open Powershell, and run the below command
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
- Install Git
choco install git
- Get the source code.
git clone https://github.com/freemocap/freemocap.git
- Install the dependencies
choco install blender ffmpeg
- Skip to our Getting Started section of the README below.
Navigate into the newly cloned freemocap folder
cd freemocap
Install the Python Dependencies (into a virtual environment)
python3 -m venv env
/env/Scripts/activate
pip install -r requirements.txt
That's it! You're ready to run the freemocap application, and create your own digital skeletons.
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
Please read our contribution doc: CONTRIBUTING.md
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.
This project is licensed under the APGL License - see the LICENSE file for details.