Skip to content

Commit

Permalink
modified the description for generateTree script
Browse files Browse the repository at this point in the history
A few more lines are added in the description
  • Loading branch information
yunsiechung committed Dec 9, 2019
1 parent fa822af commit 71f10d7
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions scripts/generateTree.py
Expand Up @@ -29,9 +29,12 @@

"""
This script cleans and generates new trees for the specified family running in parallel on the specified number of processors
`python generate_tree.py familyName nprocs`
ex: `python generate_tree.py intra_H_migration 6`
`python generateTree.py familyName nprocs`
ex: `python generateTree.py intra_H_migration 6`
Note that 6 is the maximum number of processors used currently by this script
This script will work only for the certain reaction families that have been fixed to run this script.
Running this script on other reaction families will throw error.
The documentation for this script will be ready in the future.
"""

import argparse
Expand Down

0 comments on commit 71f10d7

Please sign in to comment.