pyCGM2

| Type | Status | |------------------------|--------| | License | | | Continuous integration | |

pyCGM2 is an open-source Python library for gait analysis based on the Conventional Gait Model (CGM).
It is designed for both research and clinical use, with a particular focus on compatibility with Vicon Nexus, OpenSim, and IMU-based workflows.

---

🔗 Project Links

• 🌐 Main website: pycgm2.netlify.app
• 📚 API Documentation: pyCGM2 GitHub Pages
• 📥 Installation guide: Installation instructions

---

📦 Installation

Clone or download the repository and open an Anaconda Prompt.
Navigate to the local folder where pyCGM2 was extracted:

cd path/to/my/pycgm2/folder

Create the conda environment and install the package:

conda env create -f environment.yml
conda activate pycgm310
pip install -e .

---

⚙️ Integration with Vicon Nexus

If you are using Vicon Nexus and want to run pyCGM2 directly from Nexus pipelines, run the following two commands:

pyCGM2-setup_NexusPackages.exe
pyCGM2-generate_pyCGM2_Nexus.exe

• The first command installs the Vicon-distributed Python packages into Nexus’s internal SDK folder.
• The second command creates a ready-to-use CGM2.3 pipeline that can be imported into Nexus.
  It is configured to activate your pyCGM2 environment using a script located in C:/Users/YourName/AppData/pycgm2.

---

📣 Contributions & Issues

We welcome contributions, bug reports, and feature suggestions!
Please use the GitHub Issue Tracker for any feedback or questions.

---

📜 License

This project is licensed under the Creative Commons BY-SA 4.0 license.

📜 Release

See full release notes