1. Installation

In this section, we’ll cover how to install the SMADI package.

1.1 Prerequisites

Before installing SMADI,

  • Ensure Python 3.x is installed on your system.

  • Create a virtual environment (optional but recommended) to manage dependencies and ensure isolation from other Python installations.

# Create a virtual environment named 'smadi_env' using python3 -m venv
python3 -m venv smadi_env

# Alternatively, if you have virtualenv installed, you can use:
# virtualenv smadi_env

# Activate the virtual environment

# On Windows
smadi_env\Scripts\activate

# On Unix or MacOS
source smadi_env/bin/activate

1.2 Installing SMADI

You can install SMADI using pip, which is the recommended method:

[1]:

%%capture --no-display
! pip install smadi

This command will download and install the latest version of SMADI along with its dependencies. Also, a full list of dependencies required to run this notebook is available in the file requiremets.txt at SMADI github repo.

1.3 Verifying Installation

To verify that SMADI has been installed correctly, you can run the following command in your Python environment:

[2]:

import smadi

print(smadi.__version__)

1.0.1

SMADI has been installed successfully, this command will print the version number of the installed package.