Welcome to contimod_graphene

contimod_graphene is a standalone Python package for multilayer graphene Hamiltonians, parameter sets, basis metadata, and related single-particle utilities.

If you only read one page, start with the user guide: it gives the shortest working recipes, the core equations, and concrete output examples.

The recommended API entry points are:

• GrapheneTBParameters

• BernalMultilayer

• RhombohedralMultilayer

Low-level kernel modules remain available for advanced use, but the docs below lead with the standalone model/parameter surface rather than downstream contimod integration.

Start Here

• usage: quickest API path, equations, conventions, and representative outputs

• examples: figure-producing scripts and expected artifacts

• installation: install and local-development notes

Documentation

User Guide

• Installation
  • Develop Locally
• Usage Guide
  • What The Package Computes
  • 30-Second API Example
  • Common Tasks
  • Parameters
  • Low-Level Functional API
  • Conventions That Matter
• Standalone Examples
  • 1. ABC Trilayer: Full Model vs 2-Band Reduction
  • 2. Bilayer Landau-Level Fan
  • 3. ABA Trilayer Zero-Field Bands
  • 4. Quickstart And Notebooks

API Reference

• contimod_graphene
  • contimod_graphene package

Indices

• Index

• Module Index