Welcome to pemcoupling’s documentation!

The pemcoupling package provides tools for computing coupling functions and more.

The code can be found at the git lab repository.

See the PEM website for more information on the PEM subystem.

Contents:

• Installation
• Command-line tools
  • pemcoupling
  • pemcoupling-composite
  • pemcoupling-sitewide
  • Configuring pemcoupling
  • HTML report
• The pemcoupling module
  • The Injection
  • The CoupFunc object
• How it works
  • Pre-processing
  • Coupling functions
  • Composite coupling functions
  • Site-wide coupling functions