diff --git a/README b/README index 30a84da..8bf010a 100644 --- a/README +++ b/README @@ -1,23 +1,37 @@ After compiling, go to the pipeline directory. -Edit the parameters at the top of prepareGadgetCatalog.py: decide where to put outputs, how many redshifts to do, how many slices, subdivisions, subsamples, etc. etc. +Edit the parameters at the top of prepareGadgetCatalog.py: decide +where to put outputs, how many redshifts to do, how many slices, +subdivisions, subsamples, etc. etc. -Note that eventually prepareGadgetCatalog will be replaced by the more general and flexible prepareCatalogs. +Note that eventually prepareGadgetCatalog will be replaced by the more +general and flexible prepareCatalogs. -prepareGadgetCatalogs will produce a pipeline script for each subsampling you choose. If you have multiple redshift particle files, and choose multiple slices and/or subdivisions, they will be packaged in the same pipeline script. +prepareGadgetCatalogs will produce a pipeline script for each +subsampling you choose. If you have multiple redshift particle files, +and choose multiple slices and/or subdivisions, they will be packaged +in the same pipeline script. -Run "./generateCatalog.py [name of pipeline script]" for each script written by prepareGadgetCatalog. This will run generateMock, zobov, and pruneVoids. At the end of it, you should have a void catalog for each redshift, slice, and subdivision. +Run "./generateCatalog.py [name of pipeline script]" for each script +written by prepareGadgetCatalog. This will run generateMock, zobov, +and pruneVoids. At the end of it, you should have a void catalog for +each redshift, slice, and subdivision. Check the logfiles for any error messages. -See the README of the public void catalog for the format of the outputs. +See the README of the public void catalog for the format of the +outputs. -I'm also working on incorporating plotting into the pipeline script, so that you can immediately get some basic info about the voids. +I'm also working on incorporating plotting into the pipeline script, +so that you can immediately get some basic info about the voids. -Please do not change the outputs of pruneVoids etc. without discussion, since further analysis relies on the current formats. +Please do not change the outputs of pruneVoids etc. without +discussion, since further analysis relies on the current formats. -If you're wondering why these scripts are rather complex, it's because it can also support A-P analysis, which is much more complicated :) +If you're wondering why these scripts are rather complex, it's because +it can also support A-P analysis, which is much more complicated :) -We can talk about ways to incorporate your analysis into the pipline and to have your tools under this umbrella. +We can talk about ways to incorporate your analysis into the pipline +and to have your tools under this umbrella. Good luck!