1. Guide for Using and Extending GeneralEffHam class in PyBEST

This guide explains how to use the GeneralEffHam class to handle tensor contractions, the directory structure for implementing new Hamiltonian blocks, the expected getter protocols, and the automated registration infrastructure.

• 1.1. Usage Guide for GeneralEffHam
  • 1.1.1. Folder Structure
  • 1.1.2. Key Components
  • 1.1.3. Initializing the Hamiltonian
  • 1.1.4. Using the contract() API
• 1.2. Adding a New Hamiltonian Block
  • 1.2.1. Determine Directory and Create File
  • 1.2.2. Implement with the Correct Getter Protocol
  • 1.2.3. Register in Featured Lists
  • 1.2.4. Route in BLOCK_LIBRARY
• 1.3. Implementation Examples
  • 1.3.1. Understanding the Directory Routing
  • 1.3.2. Example 1: Dense Block Implementation (Protocol A)
  • 1.3.3. Example 2: Special Block Implementation (Protocol B)
  • 1.3.4. Example 3: Cholesky Block Implementation with Helper Functions (Protocols A & B)