Differences between revisions 2 and 6 (spanning 4 versions)
Revision 2 as of 2012-03-16 21:52:48
Size: 2975
Editor: IanRees
Comment:
Revision 6 as of 2012-03-16 21:57:24
Size: 3390
Editor: IanRees
Comment:
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
<<TableOfContents>>

= Installing a TSP Solver =

e2pathwalker.py is included in the EMAN2 distribution, but requires a third party Traveling Salesman Problem (TSP) solver to run. Two TSP solvers are supported: LKH and Concorde.
Line 8: Line 14:

We generally use LKH as the TSP solver for Pathwalker; it is fast, works well, and is relatively easy to compile.
Line 19: Line 27:
== Running Pathwalker == == Installing Concorde ==

...

= Running Pathwalker =
Line 64: Line 76:

= Examples =

= FAQ =

e2pathwalker.py

e2pathwalker.py is a key component of Pathwalker, described in the following publication:

Installing a TSP Solver

e2pathwalker.py is included in the EMAN2 distribution, but requires a third party Traveling Salesman Problem (TSP) solver to run. Two TSP solvers are supported: LKH and Concorde.

Installing LKH

We generally use LKH as the TSP solver for Pathwalker; it is fast, works well, and is relatively easy to compile.

You can download LKH from the author's site:

It is pretty easy to compile -- go into the LKH-2.0.5/SRC directory and run "make".

This will result in a binary "LKH" in LKH-2.0.5. You can copy this to /usr/local/bin or somewhere in your $PATH.

Installing Concorde

...

Running Pathwalker

e2pathwalker.py operates on a single PDB file. With no additional options, it will simply read the PDB file and print out some statistics. To actually run the TSP solver, use the --solve option, with either --solve=lkh to use the LKH solver, or --solve=concorde to use the Concorde solver.

To save the TSP results, use the --output option with a filename: e.g. --output=test.pdb

By default, e2pathwalker.py will use the 'CA' atoms in 'A' chain in the input file; this can be changed with the --atomtype and --chain options.

There are several additional options; the current e2pathwalker.py options can be displayed using --help.

muta:~ irees$ e2pathwalker.py --help
usage: prog [options] <pdb file>
        
        Find paths between two atoms in a PDB model. You can also specify two PDB files to calculate an RMSD.
        
        Use "--solve=<solver>" to run the TSP solver and save the output.
        Use "--output" to save the output to a PDB file.

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --output OUTPUT       Output file
  --start START         Start ATOM
  --end END             End ATOM
  --average AVERAGE     Average Ca-Ca length
  --dmin DMIN           Mininum Ca-Ca length
  --dmax DMAX           Maximum Ca-Ca length
  --noise NOISE         Add Gaussian Noise
  --solver SOLVER       Run TSP Solver: concorde or lkh
  --atomtype ATOMTYPE   Load Atom Type. Default: 'CA'. Options: 'C' or 'all'
  --chain CHAIN         Load Chain. Default: load all chains
  --edgefile EDGEFILE   Load fixed fragment file; one sequence of forced
                        connections per line, separated by space.
  -e EDGE, --edge EDGE  Forced edge: e.g. -e1,3
  --iterations ITERATIONS
                        Iterations
  --json JSON           If writing output pdb, also write JSON metadata.
                        Default: 1. Options: 0, 1
  --overwrite           Overwrite files without prompting
  --verbose n, -v n     verbose level [0-9], higher number means higher level
                        of verboseness
  --ppid PPID           Set the PID of the parent process, used for cross
                        platform PPID

Examples

FAQ

EMAN2/Programs/e2pathwalker (last edited 2016-09-06 12:21:24 by MuyuanChen)