aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 22 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..8b7643d
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+Cactus Code Thorn IOHDF5
+Authors : Thomas Radke
+CVS info : $Header$
+--------------------------------------------------------------------------
+
+1. Purpose of the thorn
+
+This thorn does output of 2D and 3D variables in HDF5 format.
+
+It also provides checkpointing/recovery functionality -
+you can create HDF5 checkpoint files and recover from them.
+
+The IO methods "IOHDF5_2D" and "IOHDF5_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
+
+Currently only 3D output is implemented.
+
+Fore more information on HDF5 see http://hdf.ncsa.uiuc.edu.