Getting Started with MyoAssist

Welcome to MyoAssist! This section will help you get up and running with the framework.

Prerequisites

Before you begin, make sure you have:

Python 3.11 (Make sure to add Python to PATH during installation)
Visual Studio Code (Or other IDE)
MuJoCo 3.3.3
Git

Installation

Step 1: Clone the Repository

git clone https://github.com/neumovelab/myoassist.git
cd myoassist

Step 2: Set Up Virtual Environment (venv)

This step is optional if you are already familiar with Python virtual environments and prefer to set up your own environment.

Virtual environments (venv) are essential because they allow you to create isolated Python environments for your projects. This means each project can have its own dependencies, regardless of what dependencies other projects have. This helps prevent version conflicts and makes your development process more reliable and reproducible.

How to Set Up a Virtual Environment

Create a virtual environment:
- On Linux/macOS:
```
python3.11 -m venv .my_venv
```
- On Windows:
```
py -3.11 -m venv .my_venv
```
  This will create a new folder named .my_venv in your project directory.
Activate the virtual environment:
- On Linux/macOS:
```
source .my_venv/bin/activate
```
- On Windows:
```
.my_venv\Scripts\activate
```
Note:

After activation, your command prompt will display (.my_venv) in front of the current directory. The virtual environment must always be activated when working on this project. If you encounter issues while following the documentation, please double-check that your virtual environment is active.

Example:
```
(.my_venv) D:\your\project\directory\myoassist
```
This indicates that the virtual environment is currently active.
Deactivate the virtual environment (optional):
```
deactivate
```
You only need to deactivate the virtual environment when you are completely done working on the project, or if you want to switch to a different virtual environment.
In most cases, you do not need to deactivate unless you specifically want to leave the current environment.

After creating and activating the virtual environment, you can install the required packages. This ensures that your dependencies are managed per project and do not affect your global Python installation.

Step 3: Install the Package

pip install -e .

Step 4: Verify Installation

python test_setup.py

You should see output similar to this:

Test Summary
----------------------------------------
Total tests: 13
Passed: 13
Failed: 0
Total time: 13.60s