Installation Guide

OpenSMC provides multiple installation options for both Python and MATLAB.

Python Installation

The easiest way to install OpenSMC is through pip.

Basic Installation

For core control features:

pip install opensmc

With Extras

Depending on your needs, you can install additional extras:

• RL Extras (Gymnasium environments):

  pip install opensmc[rl]
  

• Viz Extras (Advanced plotting):

  pip install opensmc[viz]
  

• Full Installation (All features):

  pip install opensmc[all]
  

From Source

To install from the GitHub repository:

git clone https://github.com/Balghanimi/OpenSMC.git
cd OpenSMC/python
pip install -e .

MATLAB Installation

The MATLAB version of OpenSMC is organized using the + package namespace system.

1. Clone the Repository:

   git clone https://github.com/Balghanimi/OpenSMC.git
   

2. Add to Path: In MATLAB, navigate to the root directory of the repository and run:

   addpath(genpath(pwd));
   savepath;
   

3. Verify: Try calling a constructor:

   surface = surfaces.Linear(2.0);
   

Requirements

Python

• Python 3.8 or higher
• numpy
• scipy
• matplotlib
• gymnasium (optional, for RL environments)

MATLAB

• MATLAB R2021b or higher
• Control System Toolbox (recommended)
• Symbolic Math Toolbox (optional, for custom derivations)