Updated documentation for IOFlexIO.

The documentation.tex file now also describes the IEEEIO file layout
used by IOFlexIO and how to import external data into Cactus.
The CreateIOFlexIOdatafile.c example serves as a template C source
to build a converter program for IEEEIO files which can be fed back
into Cactus.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGHIO/IOFlexIO/trunk@179 ebee0441-1374-4afa-a3b5-247f3ba15b9a

1 files changed, 5 insertions, 15 deletions

diff --git a/README b/README
index 75e0fde..66aa7bc 100644
--- a/README
+++ b/README
@@ -5,26 +5,16 @@ CVS info   : $Header$
 
 1. Purpose of the thorn
 
-This thorn does output of 2D and 3D variables in IEEEIO data format.
+This thorn does output of arbitrary Cactus variables in IEEEIO file format.
 
 It also provides checkpointing/recovery functionality -
 you can create IEEEIO checkpoint files and recover from them.
 
-The IO methods "IOFlexIO_2D" and "IOFlexIO_3D" are registered 
-which can be called by other thorns via CCTK_OutputVarAsByMethod()
-to output a variable without specifying it in the parameter file.
-
 
 2. Additional information
 
-IEEEIO is implemented by John Shalf's FlexIO library - that's why
-the name of this thorn.
-
-If the output files contain so-called "chunked" data (that is, each
-processor has written data as a separate field in the output file), 
-the data may need to be "recombined". A tool to perform this is 
-provided with this thorn. To build the recombiner:
-
-> gmake <configuration>-utils UTILS=ieee_recombiner
+Please refer to the documentation.tex file in the doc/ subdirectory.
 
-the executable for the recombiner will be located in exe/<configuration>
+The IEEEIO file format is implemented by John Shalf's FlexIO library
+(hence the name of this thorn).
+For more information on FlexIO see http://infinite-entropy.lbl.gov/FlexIO/.