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:

• Overview of Open Source MPS and this Manual
• Document Syntax
• Getting Help
• Simulation Overview
• Simulation Details
  • Including the required Python libraries
  • Specifying the parameters of a simulation
  • Defining local operators
  • Defining the Hamiltonian and other many-body operators
  • Defining and reading observables: obsterms.Observables
  • Specification of dynamics
  • Abelian symmetries
  • Convergence criteria
  • Running simulations
  • Putting it all together
• OpenMPS Examples
  • Example: Static Ising Model
  • Example: Static Bose Hubbard Model
  • Example: Dynamics in the Bose-Hubbard Model
• Algorithms of the OpenMPS
  • Definitions
  • Variational ground state search
  • Variational excited state search: eMPS
  • iMPS as initial ansatz
  • Infinite-size ground state search: iMPS
  • Krylov-based time evolution : tMPS
  • Time Evolving Block Decimbation (TEBD)
  • Time-Dependent Variational Principle (TDVP)
  • Local Runge-Kutta (LRK)
• Input/Output of MPS states
  • Statics - Saving ground states
  • Providing initial states for time evolution
  • Interrupted Dynamics
• Python-frontend manual
  • Documentation of classes and functions
• Developer’s Manual
  • Programming conventions
  • Generic programming in fortran with templates
  • Building this documentation
  • Building the local Hilbert space and operators
  • Function/Subroutine documentations
• Testing framework
• Changelog
  • Release v1 to release v2
  • Release v2 to release v3
• Acknowledgments and Citation
• Resources and Links for DMRG and MPS
• Bibliography

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

• Index

• Module Index

• Search Page