diff --git a/README.md b/README.md index 3b3953b1b7653f5a77e3d4b36a6e61ddf6a44b2c..ae1954950d7c1bbf9f7e6160d6d916c2a7e906af 100644 --- a/README.md +++ b/README.md @@ -18,16 +18,26 @@ gnuplot (www.gnuplot.info/) ``` ${SRC_DIR}/recursive_gmconvert.sh -f map_filename -t threshold -n num_gaussians -N num_iterations [-i first_iteration] [-s] ``` + Required arguments: + `-f map_filename`: the file name of the input EM map + `-t threshold`: the density threshold + `-n num_gaussians`: number of gaussians per sub-process + `-N num_iterations`: number of recursion levels + Optional arguments: + `-i first_iteration`: initial recursion level (defaults to 1) + `-s`: enable serial mode + `-h`: display this message + The script creates a sub-directory (called `i`) for each recursion level `i`, and the output files are called `i/i.gmm` and `i_imp.gmm`. `i/i.gmm` contains the gmm in `gmconvert` format, and `i_imp.gmm` contains the gmm in `IMP` format (the conversion is handeld by `gmconvert2imp.sh`), which can be read in IMP using `IMP.isd.gmm_tools.decorate_gmm_from_text` function.