Put the name in README

This commit is contained in:
Guilhem Lavaux 2013-03-02 15:27:27 -06:00
parent b22257b610
commit 12ca3bf2e3

31
README
View file

@ -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. After compiling, go to the pipeline directory.
Using the pipeline
------------------
Create a dataset parameter file. Look at datasets/multidark.py for Create a dataset parameter file. Look at datasets/multidark.py for
an example. Describe the simulation, where to put outputs, how many an example. Describe the simulation, where to put outputs, how many
redshift slices, subvolumes, etc. etc. redshift slices, subvolumes, etc. etc.