SteelModel Installation Guide¶

Install from Published Package¶

Install uv if it is not already available on your machine.
Create a new virtual environment (optional but recommended):
```
uv venv -p python3.13
source .venv/bin/activate
```
Install the Steel Model package and its CLI tools:
```
uv add steel-model
```
Verify the installation:
```
run_simulation --help
```
This command prints the CLI usage information and confirms the installation worked.

If you need to pin a specific version, append ==<version> to the package name when running uv add.

Check out the source repository:

git clone git@github.com:systemiqofficial/steel-iq.git
cd steel-iq

Install uv following the instructions on their website.

Create a virtual environment:

uv venv -p python3.13

If you don’t have Python 3.13 installed, you can use uv to install it:

uv python install 3.13

Activate the virtual environment:

source .venv/bin/activate  # use the appropriate command for your shell

Install the dependencies:

uv sync

Install the pre-commit hooks:

uvx pre-commit install

To run the tests, use the following command:

pytest

Run the tests including the ones for the wind_and_pv package which are skipped by default:

pytest --run-wind-and-pv-tests

To run the tests with coverage, use the following command:

coverage run -m pytest

To generate a coverage report, use the following command:

coverage report

coverage html

and open the htmlcov/index.html file in your browser.

To run the static type checker, use the following command:

mypy src/

To add a new dependency, use the uv command:

uv add <package-name>

To add a development dependency, use the --dev flag:

uv add --dev <package-name>

To update all dependencies to their latest versions, use the uv sync command:

uv sync

To upgrade the dependencies in the lockfile to their latest compatible versions:

uv lock --upgrade

To build the package, use the following command:

uv build --sdist --wheel

To run the Jupyter notebook, use the following command:

uv run --with jupyter jupyter lab --notebook-dir=notebooks/

Maybe prefix your notebooks with your name to avoid conflicts.

Via GitHub Actions, you can build a standalone application for Windows and macOS. The built applications are available in the dist folder.

gh workflow run standalone_app.yaml

This package requires the CBC solver to be installed separately. You can install it via:

Ensure cbc is available in your system PATH.