Installation

MechLab requires Python 3.8+ and can be installed via pip.

Prerequisites

  • Python: 3.8 or higher

  • Operating System: Windows, macOS, or Linux

Installation Methods

Choose the method that best fits your workflow.

Ideal for most users and environments.

pip install mechlab

Best for contributors or those needing the latest features.

git clone https://github.com/sewaksunar/mechlab.git
cd mechlab
pip install -e .
cd mechlab

Dependencies

Core dependencies (automatically installed):

  • numpy - Numerical computations

  • rich - Terminal output formatting

  • matplotlib - Plotting and visualization

Optional dependencies (for specific features):

# For PDF export
pip install reportlab

# For Jupyter widgets
pip install ipywidgets

Verify Installation

Test your installation:

# CLI check
mechlab --version
mechlab doctor

# Python check
python -c "import mechlab; print(f'MechLab {mechlab.__version__} successfully initialized.')"

Tip

Stuck? If you encounter issues, try using a fresh virtual environment:

python -m venv mechlab_env
# Windows: mechlab_env\\Scripts\\activate
# Linux/Mac: source mechlab_env/bin/activate
pip install mechlab