Surge Documentation

This index covers the release-facing documentation in this repository.

Start Here

Document	Purpose
README	Repository overview and public interfaces
Quickstart	Shortest route to a working source build
Support And Compatibility	Supported versions, platforms, and dependencies
Data Model And Conventions	Per-unit system, sign conventions, and entity schema
Glossary	Power-systems terminology and acronyms
Native Formats	Canonical .surge.json, .surge.json.zst, and .surge.bin guidance
Examples	Packaged release-facing example assets
Architecture	Workspace structure and dependency boundaries

User Workflows

Document	Purpose
Tutorials	Markdown walkthroughs for current user workflows
Notebook Index	Python notebook companions for the tutorial set
Method Fidelity	What Surge means by exact, approximate, heuristic, and experimental methods
Performance And Scaling	Threading, memory scaling, and large-case guidance

Dispatch And Markets

Document	Purpose
Markets Overview	The markets/ contract — Policy, Problem, solve — and reusable DispatchRequest builder
markets/battery/	Single-site price-taker BESS reference market
markets/go_c3/	GO Competition Challenge 3 adapter and solve
surge-dispatch	Unified SCED/SCUC kernel crate doc
surge-market	Canonical market-formulation layer crate doc

Interfaces And Reference

Document	Purpose
Crate Docs	Per-crate documentation index
CLI Reference	Current surge-solve option surface
Generated CLI Surface	Generated contract from surge-solve --help
Generated Python Root Surface	Generated root-package contract from .pyi
Generated Python Namespace Surface	Generated namespace contract from stubs/modules
Python Result Objects	Fields and methods on all Python result types
Python Exception Reference	Exception hierarchy and when each type is raised
References	Mathematical citations and governing references

Contributor Docs

Document	Purpose
CONTRIBUTING.md	Contribution process
Developer Setup	Contributor environment setup
Method Documentation Checklist	What to update when public methods change
VERSIONING.md	Versioning policy
RELEASING.md	Release process
SECURITY.md	Security reporting policy

Legal

Document	Purpose
LICENSE	PolyForm Noncommercial license text
COMMERCIAL-LICENSE.md	Commercial-use overview
license-notes.md	Third-party license notes
NOTICE	Attribution notices