OSMPS Documentation

To get started with OpenMPS, please visit The OpenMPS Wiki. There, you will find useful guides for compiling OpenMPS from source, and deploying OpenMPS in a wide suite of modern software technologies (Docker, Google Colab, and more).

This documentation provides detailed information for the Examples in OpenMPS. It also captures information regarding the OpenMPS Python API, making commands, their inputs and their implementation, searchable. Also provided, are descriptions of functions, and various physical assumptions made throughout OpenMPS.

The chapters of this guide are as follows:

  1. Overview of Open Source MPS and this Manual

  2. Document Syntax

  3. Getting Help

  4. Obtaining/Modifying the Source Code (For Developers)

  5. Dependencies

  6. Building and installation

  7. Simulation Overview

  8. Acknowledgments and Citation

Where ever the Quick Start Manual deviates from the manual, we provide an additional link to the next Quick Start chapter at the begin and end of the chapter as here to start with the quick start manual: Overview of Open Source MPS and this Manual.

The complete manual contains the following chapters:

Throughout the manual we provide external links for convenience. We are not responsible for any content, legality, etc for these external sites.

Indices and tables