Metadata-Version: 2.4
Name: steel-model
Version: 1.0.0
Summary: Add your description here
License-File: LICENSE
Requires-Python: >=3.13
Requires-Dist: black
Requires-Dist: cartopy
Requires-Dist: dash
Requires-Dist: dash-extensions
Requires-Dist: dash-leaflet
Requires-Dist: dask[array,distributed]>=2025.5.0
Requires-Dist: django
Requires-Dist: django-environ
Requires-Dist: django-htmx
Requires-Dist: django-tasks>=0.9.0
Requires-Dist: fiona
Requires-Dist: folium
Requires-Dist: geopandas
Requires-Dist: geopy
Requires-Dist: highspy>=1.9.0
Requires-Dist: httpx
Requires-Dist: ipython
Requires-Dist: matplotlib
Requires-Dist: mocker
Requires-Dist: networkx
Requires-Dist: numba>=0.61.2
Requires-Dist: openpyxl
Requires-Dist: osm2geojson
Requires-Dist: osmnx
Requires-Dist: pandas
Requires-Dist: psutil
Requires-Dist: pycountry
Requires-Dist: pydantic
Requires-Dist: pydantic-settings
Requires-Dist: pydeck>=0.9.1
Requires-Dist: pyomo
Requires-Dist: python-dotenv
Requires-Dist: reverse-geocoder
Requires-Dist: rich
Requires-Dist: rioxarray>=0.19.0
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: seaborn
Requires-Dist: sentry-sdk
Requires-Dist: tqdm
Requires-Dist: whitenoise
Description-Content-Type: text/markdown

# Steel Model

A comprehensive simulation system for modeling the global steel industry.

## Documentation

- **[Public site](https://systemiqofficial.github.io/steel-iq/)** – Full documentation

## Development Quick Reference

Install [uv](https://docs.astral.sh/uv/getting-started/installation/) and [just](https://github.com/casey/just), then bootstrap dependencies:

```bash
uv sync
uvx pre-commit install
```

### Core Checks

- `just test` – Run the full pytest suite
- `just typecheck` – Run mypy over `src/`
- `just lint` – Ruff lint

### Documentation

- `just docs` – Incremental Sphinx build
- `just docs-check` – Clean public build (used in CI)
- `just docs-serve` / `just docs-serve-headless` – Live preview
- `just docs-clean-build` – Force a full rebuild
- `just docs-clean` – Remove build artifacts

Run `just` to list every command. See the public docs for detailed guides.
