README.md 2.92 KB
Newer Older
1 2 3 4 5 6 7
Master [![build status](https://gitlab.com/structural-fragment-search/super/badges/master/build.svg)](https://gitlab.com/structural-fragment-search/super/commits/master)

[![coverage report](https://gitlab.com/structural-fragment-search/super/badges/master/coverage.svg)](https://gitlab.com/structural-fragment-search/super/commits/master)

# Super -- Information for developers

Generate the configure script using GNU Autotools:
8 9
$ autoreconf -i

10
There are a few dependencies required to build and run Super:
11 12 13
python2 (https://www.python.org/) script is used to pre-process PDB text datafiles into an efficient binary database format
prody (http://prody.csb.pitt.edu/) is used to parse PDB files
[OPTIONAL] check (https://libcheck.github.io/check/) is used for unit testing and can be disabled by passing --disable-check to the configure script.
James Collier's avatar
James Collier committed
14

James Collier's avatar
James Collier committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
COMPILE:
$ ./configure --prefix=${HOME}/some/install/path
I say ${HOME} so that I don't have to install as superuser. I often use --prefix=${HOME}/bin or ${HOME}/install

$ make && make install

RUN:
in ${prefix}/bin directory:
$ LD_LIBRARY_PATH=../lib ./super [OPTIONS...] ${pdb_path}/pdb.db

Options listing from ./super --help:
Usage: super [OPTION...] DATABASE
super -- A 3D protein pattern search program.

  -c, --thread-count=COUNT   Concurrently process the database with COUNT
                             threads of control
  -d, --defaults             Keep default arguments.
  -g, --disable-gershgorin   Disable use of gershgorin circles for Jacobi
                             diagonalisation
  -l, --lowerbounds=BOUNDS   Comma separated list of lower bound checks to use
  -n, --disable-rmsd         Disable the full (Kearsley) RMSD calculation, just
                             use the LB
  -o, --output=OUTPUT        Output to OUTPUT instead of stdout
      --quiet                Produce no output
  -q, --query=QUERY          Query database
  -r, --disable-mmap         Disable use of memory mapped databases to speed up
                             calculations
  -t, --threshold=THRESHOLD  Pattern matching threshold measured in Angstrom
  -?, --help                 Give this help list
      --usage                Give a short usage message
  -V, --version              Print program version

Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.

Report bugs to james.collier412@gmail.com.

I usually run with:
LD_LIBRARY_PATH=${HOME}/install/lib ./super --lowerbounds=arithmetic --threshold=1.0 --query=qry.db pdb.db

55 56 57 58 59 60 61 62 63 64 65
OR ON Mac OSX:
DYLD_LIBRARY_PATH=${HOME}/install/lib ./super -t 1.0 -q qry.db pdb.db

DATABASES:
An up-to-date pre-processed version of the entire PDB is available for download from http://lcb.infotech.monash.edu.au/super/pdb.db

To generate a query:
python pdb_pp.py --query [YOUR PDB FRAGMENT FILE].pdb --output myquery.qry

To generate a searchable database from a directory containing PDB files (pdb/):
python pdb_pp.py -o pdb.db pdb/