From 12ca3bf2e3789ec30194658deb28b406762d5ec1 Mon Sep 17 00:00:00 2001 From: Guilhem Lavaux Date: Sat, 2 Mar 2013 15:27:27 -0600 Subject: [PATCH] Put the name in README --- README | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README b/README index ef831be..9a1b6ba 100644 --- a/README +++ b/README @@ -1,5 +1,36 @@ +\ / / |-\ ----- + \ / | | \ | + \ / / | | |-- + \ / | | / | + \/ / |-/ ----- + +*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-* + +This is VIDE. The Void IDEntifier pipeline. + + +License/Copyright information +----------------------------- + +Copyright (C) 2010-2013 Guilhem Lavaux, 2011-2013 Paul M. Sutter. +This software is put under the GNU Public License. Please see LICENSE +for further information. + + +Parts of the pipeline includes ZOBOV. See zobov/zobov_readme.txt for +copyright/license information + +Building +-------- + + After compiling, go to the pipeline directory. + +Using the pipeline +------------------ + + Create a dataset parameter file. Look at datasets/multidark.py for an example. Describe the simulation, where to put outputs, how many redshift slices, subvolumes, etc. etc.