Home
Hello! Welcome to the Hubbard Diagonalization Project documentation :D
This project provides a system that characterizes the Hubbard model under various sets of system parameters and uses Exact-Diagonalization (ED) to determine statistical characteristics of the system under various temperatures and chemical potentials.
Image Source: xkcd #1343 by Randall Munroe CC-BY-NC 2.5
Before diving into the details, I want to give a brief overview of what this guide is and what it isn't. Firstly,
Note
This documentation makes use of GitHub's flavor markdown syntax and extensions. If you are reading this locally or in another markdown viewer, you may miss out on some nicer formatting features.
Note
This section isn't actually that relevant yet as I haven't gotten the chance yet to dive into explaining implementation.
Secondly, I've done my best to include helpful comments throughout the source code to help make the specifics of each part of the codebase clear. This documentation is meant to supplement the code, not replace it. As such, I will often skip over specific implementation details/edge cases/syntax quirks/etc. in favor of more high-level explanations and pseudocode.
As we go along, it may be helpful to have a copy of the code up while reviewing these docs in order to get a full idea of how theory meshes with implementation. I also recommend you check out RepositoryLayout.md for a quick summary of how this repository is structured so that you can orient yourself within the project.
This brings us to the next point: I will be assuming that you understand the basic concepts/syntax of both Julia and the Hubbard model. I will attempt to highlight the relevant parts of both, but if you are unfamiliar with either, get some documentation ready to refer to as you read through this guide.
With that out of the way, let's get started! (See the pages in the sidebar for various topics.)