Getting Started with SAFIRE#
Welcome to the SAFIRE documentation!
Installation#
First, see Installation for how to install SAFIRE on your machine.
Three Ways to Learn#
We provide three pathways for learning how to use SAFIRE depending on your experience level and your personal research interests.
Tutorials#
For users who are completely new to Auxiliary-Field Quantum Monte Carlo simulations, we recommend starting with our tutorials. The tutorials come in three self-contained tracks, one per application domain, and each track should be followed in order. They will teach you how to perform a simple SAFIRE calculation with minimal prior knowledge.
Examples#
For users who are already familiar with the Auxiliary-Field Quantum Monte Carlo method, or those who have completed the tutorials, we provide a collection of examples that show how to use SAFIRE to reproduce real-world research calculations. These examples are ideal starting points to adapt to your own application.
User Manual#
For power users who want to drive SAFIRE to its limits, we provide a User Manual, a reference for all configuration parameters and input file formats used in SAFIRE. This lets you, for example, simulate exotic Hamiltonians by writing input files directly, or add new integrations with input-generation or post-processing tools. Similarly, the safiretools Python companion package has an API reference for all of its public functions.