Installation Guide¶

The hwm package offers advanced tools for dynamic system modeling, nonlinear regression, and data analysis. Follow these steps to install and start using hwm.

Prerequisites¶

The following software and packages are required before installing hwm:

Python 3.9+: Ensure Python 3.9 or later is installed on your system.
pip: The package installer for Python. Keep it up-to-date for smoother installation.
virtualenv (recommended): A virtual environment helps isolate dependencies and prevents conflicts with other packages.

Quick Installation¶

To install hwm from PyPI, run the following command:

pip install hwm

This command installs hwm along with its required dependencies, making it ready for immediate use.

Installation from Source¶

For the latest features and updates, you can install hwm directly from the source code repository.

Clone the repository:

git clone https://github.com/earthai-tech/hwm.git
cd hwm

Install the package:
```
pip install .
```
Verify installation:

After installation, verify it by running:
```
import hwm
print(hwm.__version__)
```
This command should output the hwm package version, confirming a successful installation.

Optional Dependencies¶

Installing these optional dependencies enables additional hwm features:

numpy and scipy: Core libraries for numerical computations.
matplotlib: Required for visualization capabilities.
scikit-learn: Useful for Scikit-learn compatibility with certain estimators.
pandas: Recommended for data handling and preprocessing tasks.

To install hwm with all optional dependencies:

pip install hwm[all]

Setting Up a Virtual Environment¶

For a clean installation and to avoid conflicts, it’s recommended to set up a virtual environment:

Create a virtual environment:
```
python3 -m venv hwm_env
```

Activate the environment:

On macOS/Linux:
```
source hwm_env/bin/activate
```
On Windows:
```
hwm_env\Scripts\activate
```

Install `hwm` in the environment:
```
pip install hwm
```

Troubleshooting¶

If you encounter issues during installation, consider the following steps:

Check Python version: Confirm that Python 3.9 or newer is installed.
Upgrade pip: An outdated pip version may cause issues. Upgrade pip using:
```
pip install --upgrade pip
```
Verify dependencies: Ensure required packages like numpy and scipy are installed by running:
```
pip install numpy scipy
```

Uninstallation¶

To remove hwm from your system, use:

pip uninstall hwm

This will uninstall hwm and remove its dependencies installed with the package.

Getting Started¶

Once installed, refer to the API Reference for detailed examples and guides on using hwm for dynamic system modeling, regression, and data analysis tasks.