Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zhaoqy1996 authored May 28, 2021
1 parent ef29f37 commit 14fe10d
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**TCIT**, the short of Taffi component increment theory, is a powerful tool to predict thermochemistry properties, like enthalpy of formation.

This script implemented TCIT which performs on a given folder of target compounds based on a fixed TCIT CAV database distributed with the paper "[A Self-Consistent Component Increment Theory for Predicting Enthalpy of Formation](https://pubs.acs.org/doi/abs/10.1021/acs.jcim.0c00092)" by Zhao and Savoie. Further ring correction is added distributed with the paper "[Transferable Ring Corrections for Predicting Enthalpy of Formation of Cyclic Compounds](https://pubs.acs.org/doi/10.1021/acs.jcim.1c00367)" by Zhao, Iovanac and Savoie. The heat of vaporization wil take NIST value is available, otherwis it will be computed by SIMPOL1 model ("[Vapor pressure prediction – simple group contribution method](https://doi.org/10.5194/acp-8-2773-2008)". Similarly, the heat of sublimation comes from "[Simple yet accurate prediction method for sublimation enthalpies of organic contaminants using their molecular structure](https://doi.org/10.1016/j.tca.2012.05.008)"
This script implemented TCIT which performs on a given folder of target compounds based on a fixed TCIT CAV database distributed with the paper "[A Self-Consistent Component Increment Theory for Predicting Enthalpy of Formation](https://pubs.acs.org/doi/abs/10.1021/acs.jcim.0c00092)" by Zhao and Savoie. Further ring correction is added distributed with the paper "[Transferable Ring Corrections for Predicting Enthalpy of Formation of Cyclic Compounds](https://pubs.acs.org/doi/10.1021/acs.jcim.1c00367)" by Zhao, Iovanac and Savoie. The heat of vaporization wil take NIST value is available, otherwis it will be computed by SIMPOL1 model ("[Vapor pressure prediction – simple group contribution method](https://doi.org/10.5194/acp-8-2773-2008)"). Similarly, the heat of sublimation comes from "[Simple yet accurate prediction method for sublimation enthalpies of organic contaminants using their molecular structure](https://doi.org/10.1016/j.tca.2012.05.008)"

The script operates on either a folder of xyz files or a list of smiles strings, prints out the Taffi components and corresponding CAVs that are used for each prediction, and returns the 0K and 298K enthalpy of formation as well as enthalpy of formation of liquid phase and solid phase.

Expand All @@ -19,19 +19,19 @@ The script operates on either a folder of xyz files or a list of smiles strings,
## Usage
If your input type a xyz file:

1. Put xyz files of the compounds with research interest in one folder (default: inputxyz)
1. Put xyz files of the compounds with research interest in one folder (default: input_xyz)
2. Type "python TCIT.py -h" for help if you want specify the database files and run this program.
3. By default, run "python TCIT" and the program will take all xyz files in "input_xyz" and return a prediction result in result.log
3. By default, run "python TCIT" and the program will take all xyz files in "input_xyz" and return a prediction result in result.log and result_output.txt.

If your input type is smiles string:

1. Make a list of smiles string (default: input.txt)
1. Make a list of smiles string (default: input_list/test_inp.txt)
2. Type "python TCIT.py -h" for help if you want specify the database files and run this program.
3. By default, run "python TCIT -t smiles" and the program will take all smiles string in input.txt and return a prediction result in result.log
3. By default, run "python TCIT -t smiles" and the program will take all smiles string in input_list/test_inp.txt and return a prediction result in result.log and result_output.txt.

If you want to get liquid/solid phase predictions as well, add --liquid/--solid in the end.

I.e. 'python TCIT.py -t smiles -i input_list/test_inp.txt --liquid --solid'
e.g. 'python TCIT.py -t smiles -i input_list/test_inp.txt --liquid --solid'

## Notes
1. Make sure the bin folder of openbabel is added in the environment setting, or 'alias obabel=' to that bin folder. Check by running 'obabel -H'.
Expand Down

0 comments on commit 14fe10d

Please sign in to comment.