welcome: please sign in
location: Diff for "User's guide"
Differences between revisions 1 and 41 (spanning 40 versions)
Revision 1 as of 2013-08-30 08:46:16
Size: 267
Editor: 10
Comment:
Revision 41 as of 2014-10-19 20:27:18
Size: 2275
Editor: natedu100-12
Comment: method description changed, acronym "vgmfci" should be changed also everywhere in the code
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## page was renamed from User's Guide
## page was renamed from User Guide
Line 7: Line 9:
Line 9: Line 10:

Line 16: Line 15:
== How to run BDF ==
Line 17: Line 17:
To run BDF, you can write a shell script named "run.sh" with following content,
Line 18: Line 19:
{{{
 
 #!/bin/bash
 # Set BDF home directory
 export BDFHOME=~/work/0.5.dev

 # run BDF driver with input file $1
 $BDFHOME/sbin/bdfdrv.py -r $1

}}}
For example, you can copy the file named "$BDFHOME/Tests/input/test002.inp" to a work directory. Then, you write done the shell script and store it in you work directory. To evoke BDF calculation, you just use command

{{{
$./run.sh test001.inp
}}}
The output will be printed on standard output. Thus, it is better to redirect output to a file.

{{{
$./run.sh test001.inp > test001.out
}}}
== Some tips to run BDF ==
{{{
 1. There are a lot of testing inputs saved in directory of $BDFHOME/Tests/input.
 2. BDF driver assume input file has the name *.inp. Thus, you can run BDF with command
    $./run.sh test001
 3. If BDF is compiled with OpenMP supporting, you can can set OpenMP environmental variables in running script. For example,
    export OMP_NUM_THREADS=4
    export OMP_STACKSIZE=1024M
}}}

== BDF Flowchat ==

{{attachment:bdf_module_chart.jpg||width=640,align="middle"}}

== Input style ==
Line 19: Line 55:
[[compass]] - Molecule geometry and basis set preprocess.

[[drt]] - Generate DRTs in GUGA.

[[grad]] - Gradient.

[[mcscf]] - Multi-configuration self-consistent-field program

[[mp2]] - MP2 program

[[mrci]] - Multi-reference configuration interaction program.

[[localmo]] - Localization of molecule orbital.

[[scf]] - Self-consistent-field program.

[[tddft]] - Time dependent density functional program.

[[vgmfci]] - electron-nucleus mean field configuration interaction program.

[[xuanyuan]] - 1e and 2e integrals program.

[[genfrag]] - Generate or optimize fragments and fragments pairs in Local orbital based Frag-MP2/CCSD.

[[expandmo]] - Expand molecular orbital from small basis set to large basis set.

BDF User's guide

Insert introduction of BDF module at here.

How to run BDF

To run BDF, you can write a shell script named "run.sh" with following content,

 #!/bin/bash
 # Set BDF home directory
 export BDFHOME=~/work/0.5.dev

 # run BDF driver with input file $1
 $BDFHOME/sbin/bdfdrv.py -r $1

For example, you can copy the file named "$BDFHOME/Tests/input/test002.inp" to a work directory. Then, you write done the shell script and store it in you work directory. To evoke BDF calculation, you just use command

$./run.sh test001.inp

The output will be printed on standard output. Thus, it is better to redirect output to a file.

$./run.sh test001.inp > test001.out

Some tips to run BDF

 1. There are a lot of testing inputs saved in directory of $BDFHOME/Tests/input.
 2. BDF driver assume input file has the name *.inp. Thus, you can run BDF with command
    $./run.sh test001
 3. If BDF is compiled with OpenMP supporting, you can can set OpenMP environmental variables in running script. For example,
    export OMP_NUM_THREADS=4
    export OMP_STACKSIZE=1024M

BDF Flowchat

bdf_module_chart.jpg

Input style

BDF modules

compass - Molecule geometry and basis set preprocess.

drt - Generate DRTs in GUGA.

grad - Gradient.

mcscf - Multi-configuration self-consistent-field program

mp2 - MP2 program

mrci - Multi-reference configuration interaction program.

localmo - Localization of molecule orbital.

scf - Self-consistent-field program.

tddft - Time dependent density functional program.

vgmfci - electron-nucleus mean field configuration interaction program.

xuanyuan - 1e and 2e integrals program.

genfrag - Generate or optimize fragments and fragments pairs in Local orbital based Frag-MP2/CCSD.

expandmo - Expand molecular orbital from small basis set to large basis set.

User's guide (last edited 2022-10-12 07:51:38 by bsuo)