Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 3.97 KB

README.md

File metadata and controls

63 lines (40 loc) · 3.97 KB
Raw

opensourceleg

Build status Documentation Status Python Version Dependencies Status

Code style: black Security: bandit Pre-commit License Coverage Report

An open-source software library for numerical computation, data acquisition,
and control of lower-limb robotic prostheses.


Installation

The easiest and quickest way to install the opensourceleg library is via pip:

pip install opensourceleg

If you plan on installing the opensourceleg library on a Raspberry Pi, we recommend using opensourcelegpi tool, which is a cloud-based CI tool used to build an up-to-date OS for a Raspberry Pi that can be used headless/GUI-less to control autonomous/remote robotic systems. This tool bundles the opensourceleg library and its dependencies into a single OS image, which can be flashed onto a microSD card and used to boot a Raspberry Pi. For more information, click here.

Developing

To modify, develop, or contribute to the opensourceleg library, we encourage you to install Poetry, which is a python packaging and dependency management tool. Once you have Poetry installed on your local machine, you can clone the repository and install the opensourceleg library by running the following commands:

git clone https://github.com/neurobionics/opensourceleg.git
cd opensourceleg

poetry install
poetry shell

Documentation

You can find tutorials and API documentation at opensourceleg.readthedocs.io.

License

The opensourceleg library is licensed under the terms of the LGPL-v2.1 license. This license grants users a number of freedoms:

  • You are free to use the opensourceleg library for any purpose.
  • You are free to modify the opensourceleg library to suit your needs.
  • You can study how the opensourceleg library works and change it.
  • You can distribute modified versions of the opensourceleg library.

The GPL license ensures that all these freedoms are protected, now and in the future, requiring everyone to share their modifications when they also share the library in public.

Contributing

Contributions are welcome, and they are greatly appreciated! For more details, read our contribution guidelines.