<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/pyamplicol/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/pyamplicol/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav ul li a { background-image: none; } </style> <script src="/pyamplicol/assets/js/vendor/lunr.min.js"></script> <script src="/pyamplicol/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>pyAmpliCol | Fast color-ordered scattering amplitudes from Python and native APIs.</title> <meta name="generator" content="Jekyll v3.10.0" /> <meta property="og:title" content="pyAmpliCol" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="Fast color-ordered scattering amplitudes from Python and native APIs." /> <meta property="og:description" content="Fast color-ordered scattering amplitudes from Python and native APIs." /> <link rel="canonical" href="https://mg5amcnlo.github.io/pyamplicol/assets/css/just-the-docs-head-nav.css" /> <meta property="og:url" content="https://mg5amcnlo.github.io/pyamplicol/assets/css/just-the-docs-head-nav.css" /> <meta property="og:site_name" content="pyAmpliCol" /> <meta property="og:image" content="https://mg5amcnlo.github.io/pyamplicol/assets/pyamplicol_social_preview.png" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="https://mg5amcnlo.github.io/pyamplicol/assets/pyamplicol_social_preview.png" /> <meta property="twitter:title" content="pyAmpliCol" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"Fast color-ordered scattering amplitudes from Python and native APIs.","headline":"pyAmpliCol","image":"https://mg5amcnlo.github.io/pyamplicol/assets/pyamplicol_social_preview.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://mg5amcnlo.github.io/pyamplicol/assets/pyamplicol_logo.png"}},"url":"https://mg5amcnlo.github.io/pyamplicol/assets/css/just-the-docs-head-nav.css"}</script> <!-- End Jekyll SEO tag --> <link rel="icon" type="image/png" href="/pyamplicol/assets/pyamplicol_mark.png"> <meta name="color-scheme" content="light dark"> <link rel="stylesheet" href="/pyamplicol/assets/css/just-the-docs-dark.css?v=a99ef9d73a18207fd66892ac47e73ce22f54e29f" media="(prefers-color-scheme: dark)"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <header class="side-bar"> <div class="site-header"> <a href="/pyamplicol/" class="site-title lh-tight"> <div class="site-logo" role="img" aria-label="pyAmpliCol"></div> </a> <button id="menu-button" class="site-button btn-reset" aria-label="Menu" aria-expanded="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/pyamplicol/" class="nav-list-link">Home</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Installation submenu" aria-expanded="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/pyamplicol/user/installation/" class="nav-list-link">Installation</a><ul class="nav-list"><li class="nav-list-item"><a href="/pyamplicol/user/quick-start/" class="nav-list-link">Quick Start</a></li><li class="nav-list-item"><a href="/pyamplicol/user/examples-gallery/" class="nav-list-link">Examples Gallery</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Get started: a gentle walkthrough submenu" aria-expanded="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/pyamplicol/user/gentle-walkthrough/" class="nav-list-link">Get started: a gentle walkthrough</a><ul class="nav-list"><li class="nav-list-item"><a href="/pyamplicol/user/lc-workloads-and-execution-modes/" class="nav-list-link">LC workloads and execution modes</a></li><li class="nav-list-item"><a href="/pyamplicol/user/profiling-campaign-walkthrough/" class="nav-list-link">Profiling campaign: from measurements to the PDF</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Configuration submenu" aria-expanded="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/pyamplicol/user/configuration/" class="nav-list-link">Configuration</a><ul class="nav-list"><li class="nav-list-item"><a href="/pyamplicol/user/models-and-processes/" class="nav-list-link">Models and Processes</a></li><li class="nav-list-item"><a href="/pyamplicol/user/ufo-model-coverage/" class="nav-list-link">UFO Model Coverage</a></li><li class="nav-list-item"><a href="/pyamplicol/user/process-selection-and-permutations/" class="nav-list-link">Process Selection and Permutations</a></li><li class="nav-list-item"><a href="/pyamplicol/user/generation-modes-and-evaluators/" class="nav-list-link">Generation Modes and Evaluators</a></li><li class="nav-list-item"><a href="/pyamplicol/user/command-line-interface/" class="nav-list-link">Command-Line Interface</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Python API submenu" aria-expanded="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/pyamplicol/user/python-api/" class="nav-list-link">Python API</a><ul class="nav-list"><li class="nav-list-item"><a href="/pyamplicol/user/runtime-and-selectors/" class="nav-list-link">Runtime and Selectors</a></li><li class="nav-list-item"><a href="/pyamplicol/user/native-apis/" class="nav-list-link">Native APIs</a></li><li class="nav-list-item"><a href="/pyamplicol/user/artifacts-and-portability/" class="nav-list-link">Artifacts and Portability</a></li><li class="nav-list-item"><a href="/pyamplicol/correlators/" class="nav-list-link">Born Correlations</a></li><li class="nav-list-item"><a href="/pyamplicol/correlator-conventions/" class="nav-list-link">Correlation Conventions</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Profiling and Benchmarking submenu" aria-expanded="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/pyamplicol/user/profiling-and-benchmarking/" class="nav-list-link">Profiling and Benchmarking</a><ul class="nav-list"><li class="nav-list-item"><a href="/pyamplicol/user/profiling-campaigns/" class="nav-list-link">Profiling Campaigns</a></li><li class="nav-list-item"><a href="/pyamplicol/performance_reports/" class="nav-list-link">Performance Reports</a></li><li class="nav-list-item"><a href="/pyamplicol/user/fullcolor-fft-profiling/" class="nav-list-link">FullColor FFT Profiling</a></li><li class="nav-list-item"><a href="/pyamplicol/user/troubleshooting/" class="nav-list-link">Troubleshooting</a></li><li class="nav-list-item"><a href="/pyamplicol/user/release-and-support/" class="nav-list-link">Release and Support</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Architecture Overview submenu" aria-expanded="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/pyamplicol/user/architecture-overview/" class="nav-list-link">Architecture Overview</a><ul class="nav-list"><li class="nav-list-item"><a href="/pyamplicol/user/symbolica-and-licensing/" class="nav-list-link">Symbolica and Licensing</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Development Documentation submenu" aria-expanded="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/pyamplicol/development/" class="nav-list-link">Development Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/pyamplicol/development/API_CONTRACT/" class="nav-list-link">Public API Contract</a></li><li class="nav-list-item"><a href="/pyamplicol/development/CONFIG_CONTRACT/" class="nav-list-link">Configuration Contract</a></li><li class="nav-list-item"><a href="/pyamplicol/development/ARCHITECTURE_DECISIONS/" class="nav-list-link">Architecture Decisions</a></li><li class="nav-list-item"><a href="/pyamplicol/development/PACKAGING_CONTRACT/" class="nav-list-link">Packaging Contract</a></li><li class="nav-list-item"><a href="/pyamplicol/development/PHYSICS_EXTRACTION_CONTRACT/" class="nav-list-link">Physics Extraction Contract</a></li><li class="nav-list-item"><a href="/pyamplicol/development/MODEL_ASSET_PROVENANCE/" class="nav-list-link">Model Asset Provenance</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Packaged Model Assets submenu" aria-expanded="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/pyamplicol/development/model-assets/" class="nav-list-link">Packaged Model Assets</a><ul class="nav-list"><li class="nav-list-item"><a href="/pyamplicol/development/model-assets/TRANSFORMATIONS/" class="nav-list-link">Model Asset Transformations</a></li></ul></li><li class="nav-list-item"><a href="/pyamplicol/development/ON_THE_FLY_MODE_ARCHITECTURE/" class="nav-list-link">On-the-fly mode architecture</a></li></ul></li></ul> </nav> <div class="d-md-block d-none site-footer"> <p> <a href="https://github.com/mg5amcnlo/pyamplicol">Repository</a> &middot; <a href="https://pypi.org/project/pyamplicol/">PyPI</a> &middot; <a href="https://github.com/mg5amcnlo/pyamplicol/issues">Issues</a> </p> </div> </header> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search pyAmpliCol" autocomplete="off"> <label for="search-input" class="search-label"> <span class="sr-only">Search pyAmpliCol</span> <svg viewBox="0 0 24 24" class="search-icon" aria-hidden="true"><use xlink:href="#svg-search"></use></svg> </label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="https://github.com/mg5amcnlo/pyamplicol" class="site-button" target="_blank" rel="noopener noreferrer" > Repository </a> </li> <li class="aux-nav-list-item"> <a href="https://pypi.org/project/pyamplicol/" class="site-button" target="_blank" rel="noopener noreferrer" > PyPI </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <div id="main-content" class="main-content"> <main> </main> <hr> <footer> <p><a href="#top" id="back-to-top">Back to top</a></p> <div class="d-flex mt-2"> <p class="text-small mb-0"> <a href="https://github.com/mg5amcnlo/pyamplicol/edit/main/docs/assets/css/just-the-docs-head-nav.css" id="edit-this-page">Edit this page on GitHub</a> </p> </div> <div class="d-md-none mt-4 fs-2"> <p> <a href="https://github.com/mg5amcnlo/pyamplicol">Repository</a> &middot; <a href="https://pypi.org/project/pyamplicol/">PyPI</a> &middot; <a href="https://github.com/mg5amcnlo/pyamplicol/issues">Issues</a> </p> </div> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
