Skip to content

Home

Jump to bottom
Donato Meoli edited this page Jun 18, 2026 · 3 revisions

The SMS++ Project Wiki

To boldly model (and solve) what no one has modeled (and solved) before

This wiki contains additional information on the SMS++ project and core library. For an overview and quick build/install instructions, see the SMS++ Project repository. See the SMS++ API reference for the documentation of the classes and methods of the SMS++ core library and all its modules, and the SMS++ User Manual for a complete, narrative guide.

Resources for users

  • Getting started with SMS++ — a hands-on introduction to building and solving your first model in C++.
  • Using SMS++ from Python — build and run SMS++ models from Python with pySMSpp, or convert PyPSA energy-system networks with pypsa2smspp.
  • Installation guide — detailed instructions on how to install the SMS++ project and all its dependencies on Linux, macOS and Windows.
  • Customize the configuration — choose the build type, enable/disable modules and point external libraries to custom locations.
  • Using SMS++ with vcpkg — pull SMS++ into your own project as a dependency through the SMS++ vcpkg registry.
  • Troubleshooting — solutions to the most common build and configuration problems.

Resources for developers

  • Developer's Guide — the submodule-based architecture, how to build for development and how to contribute.
  • GitLab CI/CD guide — how the pipelines, the GitLab Pages docs and the GitHub mirror are organized.

Developers and maintainers should also read the CONTRIBUTING guide in the project repository, which covers the merge-request workflow, the Keep-a-Changelog format and semantic versioning.

Clone this wiki locally