diff --git a/docs/source/devguide/index.rst b/docs/source/devguide/index.rst index 02015cfb4b..e73d8ba70d 100644 --- a/docs/source/devguide/index.rst +++ b/docs/source/devguide/index.rst @@ -16,9 +16,5 @@ as debugging. styleguide workflow xml-parsing - statepoint - source - particle_restart - track voxel docbuild diff --git a/docs/source/usersguide/index.rst b/docs/source/usersguide/index.rst index 675ed4081a..5a7e7addfa 100644 --- a/docs/source/usersguide/index.rst +++ b/docs/source/usersguide/index.rst @@ -5,7 +5,7 @@ User's Guide ============ Welcome to the OpenMC User's Guide! This tutorial will guide you through the -essential aspects of using OpenMC to perform neutronic simulations. +essential aspects of using OpenMC to perform simulations. .. toctree:: :numbered: @@ -14,5 +14,6 @@ essential aspects of using OpenMC to perform neutronic simulations. beginners install input + output/index processing troubleshoot diff --git a/docs/source/usersguide/output/index.rst b/docs/source/usersguide/output/index.rst new file mode 100644 index 0000000000..1eb85e9d52 --- /dev/null +++ b/docs/source/usersguide/output/index.rst @@ -0,0 +1,14 @@ +.. _usersguide_output: + +=================== +Output File Formats +=================== + +.. toctree:: + :numbered: + :maxdepth: 3 + + statepoint + source + particle_restart + track diff --git a/docs/source/devguide/particle_restart.rst b/docs/source/usersguide/output/particle_restart.rst similarity index 97% rename from docs/source/devguide/particle_restart.rst rename to docs/source/usersguide/output/particle_restart.rst index bf69655589..12ab3237f4 100644 --- a/docs/source/devguide/particle_restart.rst +++ b/docs/source/usersguide/output/particle_restart.rst @@ -1,4 +1,4 @@ -.. _devguide_particle_restart: +.. _usersguide_particle_restart: ============================ Particle Restart File Format diff --git a/docs/source/devguide/source.rst b/docs/source/usersguide/output/source.rst similarity index 96% rename from docs/source/devguide/source.rst rename to docs/source/usersguide/output/source.rst index 20457fb116..cc8e71a675 100644 --- a/docs/source/devguide/source.rst +++ b/docs/source/usersguide/output/source.rst @@ -1,4 +1,4 @@ -.. _devguide_source: +.. _usersguide_source: ================== Source File Format diff --git a/docs/source/devguide/statepoint.rst b/docs/source/usersguide/output/statepoint.rst similarity index 99% rename from docs/source/devguide/statepoint.rst rename to docs/source/usersguide/output/statepoint.rst index 82686ff670..b17bdca024 100644 --- a/docs/source/devguide/statepoint.rst +++ b/docs/source/usersguide/output/statepoint.rst @@ -1,4 +1,4 @@ -.. _devguide_statepoint: +.. _usersguide_statepoint: ======================= State Point File Format diff --git a/docs/source/devguide/track.rst b/docs/source/usersguide/output/track.rst similarity index 97% rename from docs/source/devguide/track.rst rename to docs/source/usersguide/output/track.rst index afa27adfd0..9a85ac7ea2 100644 --- a/docs/source/devguide/track.rst +++ b/docs/source/usersguide/output/track.rst @@ -1,4 +1,4 @@ -.. _devguide_track: +.. _usersguide_track: ================= Track File Format diff --git a/docs/source/usersguide/processing.rst b/docs/source/usersguide/processing.rst index e773cf1563..a6e9875cef 100644 --- a/docs/source/usersguide/processing.rst +++ b/docs/source/usersguide/processing.rst @@ -194,7 +194,7 @@ Data Extraction --------------- A great deal of information is available in statepoint files (See -:ref:`devguide_statepoint`), most of which is easily extracted by the provided +:ref:`usersguide_statepoint`), most of which is easily extracted by the provided utility statepoint.py. This utility provides a Python class to load statepoints and extract data - it is used in many of the provided plotting utilities, and can be used in user-created scripts to carry out manipulations of the data. To