GENXFF user manual

GENXFF is distributed both as this web service and as a command line tool. This manual covers the command line tool: how to write its configuration file and what every option means.

Note: currently, genxff can only be run on a Linux x86 machine.

Guide to fetch XFF parameters with GENXFF

Write a config file for genxff

An example config file, example.config:

example.config
input:
    mol: ligand.sdf    #required, input mol file, supported format [mol, sdf, mol2]
    charge: char_file.chg   #optional, partial charge file
    mol_name: lig   #optional, ligand name in the output file

output:
    amber: amber_out_name #output: amber_out_name.mol2, amber_out_name.frcmod, amber_out_name_leaprc.dat
    charmm: charmm_out_name #output: charmm_out_name.pdb, charmm_out_name.prm, charmm_out_name.rtf
    gromacs: gromacs_out_name #output: gromacs_out_name.pdb, gromacs_out_name.top

config:
    revise_charge_precision: True
    use_antechamber_for_charge: False

amber: /mnt/workflow/amber20 #amber home

Fetch XFF3.0 parameters with genxff

Shell
genxff --config example.config

Detailed explanation of config file for genxff

Here is a complete version of the config template. You can also obtain it by running

Shell
genxff --dump_config template.config

input

mol
Path to the input ligand file. Currently only the mol, sdf and mol2 formats are supported.
charge

Path to the partial charge file. Currently, three types of partial charge file are supported:

  1. Mol2 format with partial charges in it. For example, a mol2 file obtained with antechamber using the -c bcc option.
  2. A single column charge file (.chg). For example:
    -0.01
    0.02
    -0.03
    ...
  3. A double column charge file (.chg). The first column is the atom index starting from 1 and the second column is the partial charge. For example:
    1 -0.01
    2 0.02
    3 -0.03
    ...
mol_name
Residue name in the output file.

output

You can choose all of them or any combination of the formats.

amber / charmm / gromacs
Output file name for the amber / charmm / gromacs format. Output files for the designated format are generated in the current working directory.
Files written for an output name of
FormatFiles
amber<name>.mol2 <name>.frcmod <name>_leaprc.dat
charmm<name>.pdb <name>.prm <name>.rtf
gromacs<name>.pdb <name>.top

config

revise_charge_precision
Whether to adjust atomic partial charges so that their sum matches exactly the net charge of the molecule. Usually True.
use_antechamber_for_charge
Whether to use antechamber to calculate AM1-BCC charges. Usually False if a charge file is provided.

amber

amber
Path to AMBERHOME, needed if you want to use antechamber.