Software:forcebalance: Difference between revisions

From biowiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 25: Line 25:


Alternatively (for AMOEBA only, not AMOEBA+), for GPU tinker modifications and cluster submission. Please read [https://github.com/bdw2292/Ren-Lab-Daemon/blob/main/README_HELP.MD https://github.com/bdw2292/Ren-Lab-Daemon/blob/main/README_HELP.MD] , the section titled''' Creating workers for ForceBalance cluster submission'''
Alternatively (for AMOEBA only, not AMOEBA+), for GPU tinker modifications and cluster submission. Please read [https://github.com/bdw2292/Ren-Lab-Daemon/blob/main/README_HELP.MD https://github.com/bdw2292/Ren-Lab-Daemon/blob/main/README_HELP.MD] , the section titled''' Creating workers for ForceBalance cluster submission'''
== '''<span style="font-size:large">ForceBalance input files</span>''' ==
<font size="3">In the following I will use amoeba water as an example. All the files are located in Renlab cluster at</font>
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><code>/home/liuchw/FB-demo/015_amoeba_tinker</code></div>
<font size="3">A&nbsp;&nbsp;typical job of ForceBalance folder looks like:&nbsp;</font>
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><code>├── example.in<br/> ├── forcefield<br/> │&nbsp; &nbsp;└── water.prm<br/> └── targets<br/> &nbsp; &nbsp; ├── DimerMin<br/> &nbsp; &nbsp; ├── Interactions_CCSDT<br/> &nbsp; &nbsp; ├── Interactions_MP2<br/> &nbsp; &nbsp; ├── Liquid<br/> &nbsp; &nbsp; ├── Monomer_Moments<br/> &nbsp; &nbsp; ├── Monomer_Vibration<br/> &nbsp; &nbsp; ├── cluster-02<br/> &nbsp; &nbsp; ├── cluster-03</code></div>
<font size="3">where example.in has the settings read by ForceBalance, forcefield directory contains the tinker parameter file, and targets folder contains lots of targets (both QM and Liquid).&nbsp;</font>
<font size="3">Inside the QM target is the tinker xyz and interactions.txt, interactions.key files Inside the Liquid target are the input files for Tinker (key and xyz) and experimental data (data.csv).&nbsp;</font>
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><code>&nbsp;Liquid/<br/> ├── data.csv<br/> ├── gas.key<br/> ├── gas.xyz<br/> ├── liquid.key<br/> └── liquid.xyz</code></div>
A cluster folder typically contains the XYZ files, interactions.key, and interactions.txt, which defines the QM reference and how you calculate the interaction energy for AMOEBA.
<font size="3">A QM target folder (showing below)&nbsp;typically contains xyz files, interactions.key and interactions.txt, which defines the QM reference and how you calculate the interaction energy for AMOEBA.&nbsp;</font>
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><code>Interactions_CCSDT/<br/> ├── 01-Prism.xyz<br/> ├── 02-Cage.xyz<br/> ├── 03-Bag.xyz<br/> ├── 04-Cyclic-Chair.xyz<br/> ├── 05-Book-1.xyz<br/> ├── 06-Book-2.xyz<br/> ├── 07-Cyclic-Boat-1.xyz<br/> ├── 08-Cyclic-Boat-2.xyz<br/> ├── interactions.key<br/> ├── interactions.txt<br/> ├── monomer_exp.xyz<br/> ├── monomer_mp2.xyz<br/> ├── monomer_opt.xyz</code></div>
<span style="font-size:small;">After setting up the above files, you should be able to run ForceBalance using the simple command:</span>
<div style="background:#eeeeee;border:1px solid #cccccc;padding:5px 10px;"><code><span style="font-size:medium">ForceBalance example.in</span></code></div>
If ForceBalance jobs crash, check the error message and modify your setting.&nbsp; More information about settings in the example.in, please refer to ForceBalance manual file<span style="display: none">&nbsp;</span>
[http://leeping.github.io/forcebalance/doc/ForceBalance-Manual.pdf http://leeping.github.io/forcebalance/doc/ForceBalance-Manual.pdf]

Revision as of 20:25, 16 November 2023

Background

ForceBalance is an automatic force field parametrization tool developed by Lee-Ping Wang et al. It allows one to use both quantum chemical data and experimental observables of the liquid phase. It has been applied to parameterize a bunch of water models and organic molecules. The following examples are some of them.

J. Phys. Chem. Lett., 2014, 5 (11), pp 1885–1891 (ForceBalance paper, TIP3P and TIP4P water as examples)

J. Phys. Chem. B, 2013, 117 (34), pp 9956–9972 (iAMOEBA paper)

J. Phys. Chem. B, 2015, 119 (29), pp 9423–9437 (AMOEBA14 paper)

Here, a brief tutorial on how to install, set up, parallelize and run FB is provided below.   

ForceBalance Installation

ForceBalance can be installed in different ways. Here I recommend installing FB through conda software manager (either Anaconda or Miniconda). For how to install conda, please go to the anaconda download page (https://www.anaconda.com/products/individual).

After you have conda installed, FB can be easily installed through the following commands:

  conda create --name FB17 python=3.7
  conda activate FB17
  conda install --strict-channel-priority -c conda-forge forcebalance

Now ForceBalance is installed. You should be able to run (but not efficiently) FB jobs with the following settings.

 

Alternatively (for AMOEBA only, not AMOEBA+), for GPU tinker modifications and cluster submission. Please read https://github.com/bdw2292/Ren-Lab-Daemon/blob/main/README_HELP.MD , the section titled Creating workers for ForceBalance cluster submission

ForceBalance input files

In the following I will use amoeba water as an example. All the files are located in Renlab cluster at

/home/liuchw/FB-demo/015_amoeba_tinker

A  typical job of ForceBalance folder looks like: 

├── example.in
├── forcefield
│   └── water.prm
└── targets
    ├── DimerMin
    ├── Interactions_CCSDT
    ├── Interactions_MP2
    ├── Liquid
    ├── Monomer_Moments
    ├── Monomer_Vibration
    ├── cluster-02
    ├── cluster-03

where example.in has the settings read by ForceBalance, forcefield directory contains the tinker parameter file, and targets folder contains lots of targets (both QM and Liquid). 

Inside the QM target is the tinker xyz and interactions.txt, interactions.key files Inside the Liquid target are the input files for Tinker (key and xyz) and experimental data (data.csv). 

 Liquid/
├── data.csv
├── gas.key
├── gas.xyz
├── liquid.key
└── liquid.xyz

A cluster folder typically contains the XYZ files, interactions.key, and interactions.txt, which defines the QM reference and how you calculate the interaction energy for AMOEBA.

A QM target folder (showing below) typically contains xyz files, interactions.key and interactions.txt, which defines the QM reference and how you calculate the interaction energy for AMOEBA. 

Interactions_CCSDT/
├── 01-Prism.xyz
├── 02-Cage.xyz
├── 03-Bag.xyz
├── 04-Cyclic-Chair.xyz
├── 05-Book-1.xyz
├── 06-Book-2.xyz
├── 07-Cyclic-Boat-1.xyz
├── 08-Cyclic-Boat-2.xyz
├── interactions.key
├── interactions.txt
├── monomer_exp.xyz
├── monomer_mp2.xyz
├── monomer_opt.xyz

After setting up the above files, you should be able to run ForceBalance using the simple command:

ForceBalance example.in

If ForceBalance jobs crash, check the error message and modify your setting.  More information about settings in the example.in, please refer to ForceBalance manual file 

http://leeping.github.io/forcebalance/doc/ForceBalance-Manual.pdf