Enzo User's Guide

Introduction

This document provides a brief description of the compilation and operation of Enzo, a structured Adaptive Mesh Refinement (SAMR, or more loosely AMR) code which is primarily intended for use in astrophysics and cosmology. The User's Guide is intended to explain how to compile and run Enzo, the initial conditions generation code and the various analysis tools bundled with Enzo. The instructions on actually running the code are not comprehensive in that they are not machine or platform-specific. Arguably the most useful and important piece of this guide is the parameter list, which contains descriptions of all of the roughly 300 possible input parameters (as of September 2008). For more detailed information on the Enzo algorithms and on running Enzo on different platforms, you should refer to the Enzo Tutorials. Detailed information on the algorithms used in Enzo will be available in the method paper (unreleased as of September 2008). In the meantime, look at the reference list for more concrete Enzo information.

This guide (and Enzo itself) was originally written by Greg Bryan. Since the original writing of both the simulation code and the User's Guide, the maintenance of Enzo and its associated tools and documentation has been taken over by the Laboratory for Computational Astrophysics at The University of California, San Diego. Your input in improving both the code and the User's Guide is appreciated. Please send email to the Enzo User's Listserv. Thank you!

Notes

Versions

This user guide for the Enzo public Subversion trunk. For a particular release, please the Enzo v1.0.1 docs, or the Enzo v1.5 docs. For how to solve specific problems, read the Tutorials.

Editors

If you add new pages, please update the Table of Contents macro below.

Table of Contents

1. Enzo compilation requirements
2. Subversion Check Out Instructions
   1. Subversion Clients
   2. Getting a Copy
   3. Updating
3. Building enzo
   1. Checkout the Code
   2. Initializing the Build System
   3. Go to the Source Directory
   4. Find the Right Machine File
   5. Porting
   6. HDF5 Versions
   7. Build the Makefile
   8. Build Enzo
   9. Building other Tools
4. The Enzo Makefile System
   1. Makefile commands
   2. Machine settings
   3. Configuration options
   4. The Make* Files
5. Executables, Arguments, and Outputs
   1. enzo
   2. inits
   3. ring
   4. enzohop
6. Enzo Parameter List
   1. Stopping Parameters
   2. Initialization Parameters
   3. I/O Parameters
   4. Hierarchy Control Parameters
   5. Hydrodynamic Parameters
   6. Cosmology Parameters
   7. Gravity Parameters
   8. Particle Parameters
   9. Parameters for Additional Physics
   10. Test Problem Parameters
   11. Other External Parameters
   12. Other Internal Parameters
   13. Parameters to be Described
7. Running Enzo
   1. Restarting
   2. Monitoring information
   3. Debugging information
   4. Test Problems
8. Enzo Test Suite
9. Running Inits
   1. Single Grid Initialization
   2. Multiple-grid Initialization
   3. Inits Parameter List
10. Enzo Output Formats
    1. Summary of Files
    2. Output Units
    3. File Schema
11. Analyzing With YT
    1. What is YT?
    2. Making Slices
    3. Making Simple Radial Profiles
    4. More Analysis Tasks
12. The Enzo Hierarchy File - Explanation and Usage
13. Enzo Internal Unit System
14. Enzo Particle Masses
15. Grid Field Arrays
    1. Class Description
    2. Access Methods
    3. Field Numbers and Names
    4. Using the Methods
    5. Field List Reference
16. Enzo Flow Chart, Source Browser
    1. Flow Chart Errors