Firmware and Software Documentation for OpenExo: An Open-Source Modular Exoskeleton to Augment Human Function

OpenSourceLeg Banner
Build Status Python Versions License

Prerequisites

Before installing the OpenExo library, ensure you have the following installed:

  • Python 3.9 or later

  • pip package manager

Installation

The easiest and quickest way to install the OpenExo library is to clone the repository directly from GitHub:

git clone https://github.com/naubiomech/OpenExo.git
cd OpenExo

Getting Started

For new users, visit the Getting Started page for an overview of the library and its documentation.

Developing

If you wish to modify, develop, or contribute to the OpenExo library, it is recommended to install Poetry, a Python packaging and dependency management tool. Once Poetry is installed, clone the repository and set up your development environment using the following commands:

git clone https://github.com/naubiomech/OpenExo.git
cd OpenExo
poetry install
poetry shell

License

The OpenExo library is licensed under the GPL-3.0 license. This license grants you the following freedoms:

  • Use: You are free to use the library for any purpose.

  • Modify: You may modify the library to suit your needs.

  • Study: You can study and change how the library works.

  • Distribute: You are allowed to distribute modified versions of the library.

The GPL license ensures that these freedoms are upheld, requiring contributors to share their modifications publicly if they distribute the library.

Contact & Resources

For questions, issues, or further assistance, reach out to us at:

Tutorials: