From 7fdfc1ede40f60868cc2982537f14932c95e9c4b Mon Sep 17 00:00:00 2001
From: Paul Romano <paul.k.romano@gmail.com>
Date: Sat, 12 Sep 2015 13:43:57 +0700
Subject: [PATCH] Add particle restart file format in documentation.

---
 docs/source/devguide/index.rst            |  1 +
 docs/source/devguide/particle_restart.rst | 59 +++++++++++++++++++++++
 docs/source/devguide/statepoint.rst       | 10 ++--
 3 files changed, 65 insertions(+), 5 deletions(-)
 create mode 100644 docs/source/devguide/particle_restart.rst

diff --git a/docs/source/devguide/index.rst b/docs/source/devguide/index.rst
index 03838363c9..13dfc351fe 100644
--- a/docs/source/devguide/index.rst
+++ b/docs/source/devguide/index.rst
@@ -17,5 +17,6 @@ as debugging.
     workflow
     xml-parsing
     statepoint
+    particle_restart
     voxel
     docbuild
diff --git a/docs/source/devguide/particle_restart.rst b/docs/source/devguide/particle_restart.rst
new file mode 100644
index 0000000000..ecee81103d
--- /dev/null
+++ b/docs/source/devguide/particle_restart.rst
@@ -0,0 +1,59 @@
+.. _devguide_particle_restart:
+
+============================
+Particle Restart File Format
+============================
+
+The current revision of the particle restart file format is 1.
+
+**/filetype** (*int*)
+
+    Flags what type of file this is. A value of -1 indicates a statepoint file,
+    a value of -2 indicates a particle restart file, and a value of -3 indicates
+    a source file.
+
+**/revision** (*int*)
+
+    Revision of the binary state point file. Any time a change is made in the
+    format of the state-point file, this integer is incremented.
+
+**/current_batch** (*int*)
+
+    The number of batches already simulated.
+
+**/gen_per_batch** (*int*)
+
+    Number of generations per batch.
+
+**/current_gen** (*int*)
+
+    The number of generations already simulated.
+
+**/n_particles** (*int8_t*)
+
+    Number of particles used per generation.
+
+**/run_mode** (*int*)
+
+    Run mode used. A value of 1 indicates a fixed-source run and a value of 2
+    indicates an eigenvalue run.
+
+**/id** (*int8_t*)
+
+    Unique identifier of the particle.
+
+**/weight** (*double*)
+
+    Weight of the particle.
+
+**/energy** (*double*)
+
+    Energy of the particle in MeV.
+
+**/xyz** (*double[3]*)
+
+    Position of the particle.
+
+**/uvw** (*double[3]*)
+
+    Direction of the particle.
diff --git a/docs/source/devguide/statepoint.rst b/docs/source/devguide/statepoint.rst
index 7b08620563..de86c22543 100644
--- a/docs/source/devguide/statepoint.rst
+++ b/docs/source/devguide/statepoint.rst
@@ -1,10 +1,10 @@
 .. _devguide_statepoint:
 
-======================================
-State Point Binary File Specifications
-======================================
+=======================
+State Point File Format
+=======================
 
-The current revision of the statepoint binary file is 13.
+The current revision of the statepoint file format is 13.
 
 **/filetype** (*int*)
 
@@ -64,7 +64,7 @@ if (run_mode == MODE_EIGENVALUE)
 
         Number of inactive batches.
 
-    **gen_per_batch** (*int*)
+    **/gen_per_batch** (*int*)
 
         Number of generations per batch.