<p align="center">
<img src="https://github.com/freemocap/freemocap/assets/15314521/da1af7fe-f808-43dc-8f59-c579715d6593" height="240" alt="Project Logo">
</p>
<h3 align="center">The FreeMoCap Project</h3>
<h4 align="center"> 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</h2>
<p align="center">
<a href="https://doi.org/10.5281/zenodo.7233714">
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.7233714.svg" alt=DOI-via-Zenodo.org>
</a>
<a href="https://github.com/psf/black">
<img alt="https://img.shields.io/badge/code%20style-black-000000.svg" src="https://img.shields.io/badge/code%20style-black-000000.svg">
</a>
<a href="https://github.com/freemocap/freemocap/releases/latest">
<img src="https://img.shields.io/github/release/freemocap/freemocap.svg" alt="Latest Release">
</a>
<a href="https://github.com/freemocap/freemocap/blob/main/LICENSE">
<img src="https://img.shields.io/badge/license-AGPL-blue.svg" alt="AGPLv3">
</a>
<a href="https://github.com/freemocap/freemocap/issues">
<img src="https://img.shields.io/badge/contributions-welcome-ff69b4.svg" alt="Contributions Welcome">
</a>
<a href="https://github.com/psf/black">
<img alt="https://img.shields.io/badge/code%20style-black-000000.svg" src="https://img.shields.io/badge/code%20style-black-000000.svg">
</a>
<a href="https://discord.gg/SgdnzbHDTG">
<img alt="Discord Community Server" src="https://dcbadge.vercel.app/api/server/SgdnzbHDTG?style=flat">
</a>
</p>
https://user-images.githubusercontent.com/15314521/192062522-2a8d9305-f181-4869-a4b9-1aa068e094c9.mp4
--
## QUICKSTART
#### 0. Create a a Python 3.10 through 3.12 environment (python3.11 recommended)¶
#### 1. Install software via [pip](https://pypi.org/project/freemocap/#description):
```
pip install freemocap
```
#### 2. Launch the GUI by entering the command:
```
freemocap
```
#### 3. A GUI should pop up that looks like this:
<img width="1457" alt="image" src="https://github.com/freemocap/freemocap/assets/15314521/90ef7e7b-48f3-4f46-8d4a-5b5bcc3254b3">
#### 4. Have fun! It might break! Work in Progress lol
#### 5. [Join the Discord and let us know how it went!](https://discord.gg/nxv5dNTfKT)
___
## Install/run from source code (i.e. the code in this repo)
Open an [Anaconda-enabled command prompt](https://www.anaconda.org) (or your preferred method of environmnet management) and enter the following commands:
1) Create a `Python` environment (Recommended version is `python3.11`)
```bash
conda create -n freemocap-env python=3.11
```
2) Activate that newly created environment
```bash
conda activate freemocap-env
```
3) Clone the repository
```bash
git clone https://github.com/freemocap/freemocap
```
4) Navigate into the newly cloned/downloaded `freemocap` folder
```bash
cd freemocap
```
5) Install the package via the `pyproject.toml` file
```bash
pip install -e .
```
6) Launch the GUI (via the `freemocap.__main__.py` entry point)
```bash
python -m freemocap
```
A GUI should pop up!
___
## Documentation
Our documenation is hosted at: https://freemocap.github.io/documentation/index_md.html
That site is built using `writerside` from this repository: https://github.com/freemocap/documentation
___
### Contribution Guidelines
Please read our contribution doc: [CONTRIBUTING.md](CONTRIBUTING.md)
## Related
[//]: # (* [project-name](#) - Project description)
## Maintainers
* [Jon Matthis](https://github.com/jonmatthis)
* [Endurance Idehen](https://github.com/endurance)
## License
This project is licensed under the APGL License - see the [LICENSE](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](https://www.gnu.org/philosophy/open-source-misses-the-point.en.html) away from the `AGPL`
Raw data
{
"_id": null,
"home_page": null,
"name": "freemocap",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "camera, stream, video, image, opencv, skelly, freemocap, motion capture, markerless motion capture, mocap, markerless mocap, markerless, kinematic, animation, 3d animation, Blender, Blender3d, synchronization, computer vision",
"author": "Endurance Idehen, Aaron Cherian, Jonathan Samir Matthis",
"author_email": "Skelly FreeMoCap <info@freemocap.org>",
"download_url": "https://files.pythonhosted.org/packages/a7/5c/d29384becf7d99f681c261b37ded977c8fa825fdb80853ef425d014a4240/freemocap-1.5.2.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://github.com/freemocap/freemocap/assets/15314521/da1af7fe-f808-43dc-8f59-c579715d6593\" height=\"240\" alt=\"Project Logo\">\n</p> \n\n\n<h3 align=\"center\">The FreeMoCap Project</h3>\n<h4 align=\"center\"> A free-and-open-source, hardware-and-software-agnostic, minimal-cost, research-grade, motion capture\nsystem and platform for decentralized scientific research, education, and training</h2>\n\n\n<p align=\"center\">\n\n<a href=\"https://doi.org/10.5281/zenodo.7233714\">\n <img src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.7233714.svg\" alt=DOI-via-Zenodo.org>\n </a>\n\n<a href=\"https://github.com/psf/black\">\n <img alt=\"https://img.shields.io/badge/code%20style-black-000000.svg\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\">\n </a>\n\n<a href=\"https://github.com/freemocap/freemocap/releases/latest\">\n <img src=\"https://img.shields.io/github/release/freemocap/freemocap.svg\" alt=\"Latest Release\">\n </a>\n\n<a href=\"https://github.com/freemocap/freemocap/blob/main/LICENSE\">\n <img src=\"https://img.shields.io/badge/license-AGPL-blue.svg\" alt=\"AGPLv3\">\n </a>\n\n<a href=\"https://github.com/freemocap/freemocap/issues\">\n <img src=\"https://img.shields.io/badge/contributions-welcome-ff69b4.svg\" alt=\"Contributions Welcome\">\n </a>\n\n<a href=\"https://github.com/psf/black\">\n <img alt=\"https://img.shields.io/badge/code%20style-black-000000.svg\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\">\n </a>\n\n<a href=\"https://discord.gg/SgdnzbHDTG\">\n <img alt=\"Discord Community Server\" src=\"https://dcbadge.vercel.app/api/server/SgdnzbHDTG?style=flat\">\n </a>\n\n\n</p>\n\n\nhttps://user-images.githubusercontent.com/15314521/192062522-2a8d9305-f181-4869-a4b9-1aa068e094c9.mp4\n\n\n\n\n\n--\n## QUICKSTART\n\n#### 0. Create a a Python 3.10 through 3.12 environment (python3.11 recommended)\u00b6\n#### 1. Install software via [pip](https://pypi.org/project/freemocap/#description):\n\n```\npip install freemocap\n```\n\n#### 2. Launch the GUI by entering the command:\n\n```\nfreemocap\n``` \n\n#### 3. A GUI should pop up that looks like this: \n\n <img width=\"1457\" alt=\"image\" src=\"https://github.com/freemocap/freemocap/assets/15314521/90ef7e7b-48f3-4f46-8d4a-5b5bcc3254b3\">\n\n#### 4. Have fun! It might break! Work in Progress lol\n\n#### 5. [Join the Discord and let us know how it went!](https://discord.gg/nxv5dNTfKT)\n\n\n\n___\n## Install/run from source code (i.e. the code in this repo)\n\nOpen an [Anaconda-enabled command prompt](https://www.anaconda.org) (or your preferred method of environmnet management) and enter the following commands:\n\n1) Create a `Python` environment (Recommended version is `python3.11`)\n\n```bash\nconda create -n freemocap-env python=3.11\n```\n\n2) Activate that newly created environment\n\n```bash\nconda activate freemocap-env\n```\n\n3) Clone the repository\n\n```bash\ngit clone https://github.com/freemocap/freemocap\n```\n\n4) Navigate into the newly cloned/downloaded `freemocap` folder\n\n```bash\ncd freemocap\n```\n\n5) Install the package via the `pyproject.toml` file\n\n```bash\npip install -e .\n```\n\n6) Launch the GUI (via the `freemocap.__main__.py` entry point)\n\n```bash\npython -m freemocap\n```\n\nA GUI should pop up!\n\n___\n\n## Documentation \n\nOur documenation is hosted at: https://freemocap.github.io/documentation/index_md.html\n\nThat site is built using `writerside` from this repository: https://github.com/freemocap/documentation\n\n___\n\n\n\n### Contribution Guidelines\n\nPlease read our contribution doc: [CONTRIBUTING.md](CONTRIBUTING.md)\n\n\n## Related\n\n[//]: # (* [project-name](#) - Project description)\n\n## Maintainers\n\n* [Jon Matthis](https://github.com/jonmatthis)\n* [Endurance Idehen](https://github.com/endurance)\n\n## License\n\nThis project is licensed under the APGL License - see the [LICENSE](LICENSE) file for details.\n\nIf the AGPL does not work for your needs, we are happy to discuss terms to license this software to you with a different\nagreement at a price point that increases exponentially as you\nmove [spiritually](https://www.gnu.org/philosophy/open-source-misses-the-point.en.html) away from the `AGPL`\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A free and open source markerless motion capture system for everyone \ud83d\udc80\u2728",
"version": "1.5.2",
"project_urls": {
"Documentation": "https://freemocap.github.io/documentation/",
"Github": "https://github.com/freemocap/freemocap",
"Homepage": "https://freemocap.org"
},
"split_keywords": [
"camera",
" stream",
" video",
" image",
" opencv",
" skelly",
" freemocap",
" motion capture",
" markerless motion capture",
" mocap",
" markerless mocap",
" markerless",
" kinematic",
" animation",
" 3d animation",
" blender",
" blender3d",
" synchronization",
" computer vision"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ab34dd5e3623355b806e019ff22594e20124fd7deacca6e7e889b65a437ee05",
"md5": "f386c4671978024ed94802ff79132c7c",
"sha256": "c01b4fbe37a5ee3da081a4f664f820924bc71a6cf7faa166a8df1608f7320f3a"
},
"downloads": -1,
"filename": "freemocap-1.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f386c4671978024ed94802ff79132c7c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 689338,
"upload_time": "2025-01-15T15:13:55",
"upload_time_iso_8601": "2025-01-15T15:13:55.953412Z",
"url": "https://files.pythonhosted.org/packages/3a/b3/4dd5e3623355b806e019ff22594e20124fd7deacca6e7e889b65a437ee05/freemocap-1.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a75cd29384becf7d99f681c261b37ded977c8fa825fdb80853ef425d014a4240",
"md5": "6d3abf02efbbbc463ff51864757dd1d9",
"sha256": "09801a55b1f9c87aea168e4ccdc5aea8bfd546803bf5baa1ea59b1ef5c1a6fc2"
},
"downloads": -1,
"filename": "freemocap-1.5.2.tar.gz",
"has_sig": false,
"md5_digest": "6d3abf02efbbbc463ff51864757dd1d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 1050331,
"upload_time": "2025-01-15T15:13:57",
"upload_time_iso_8601": "2025-01-15T15:13:57.984873Z",
"url": "https://files.pythonhosted.org/packages/a7/5c/d29384becf7d99f681c261b37ded977c8fa825fdb80853ef425d014a4240/freemocap-1.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-15 15:13:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "freemocap",
"github_project": "freemocap",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "freemocap"
}
JSON
