10
0
mirror of https://github.com/LCPQ/EMSL_Basis_Set_Exchange_Local synced 2024-12-23 04:43:40 +01:00
EMSL_Basis_Set_Exchange_Local/README.md

65 lines
2.5 KiB
Markdown
Raw Normal View History

2014-11-12 14:36:12 +01:00
EMSL_Basis_Set_Exchange_Local
=============================
2014-12-04 15:07:19 +01:00
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/TApplencourt/EMSL_Basis_Set_Exchange_Local?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2014-11-12 14:36:12 +01:00
2014-11-12 18:34:25 +01:00
Create of Local Copy of the famous [EMSL Basis Set Exchange](https://bse.pnl.gov/bse/portal) and use it easily with the API.
2014-11-12 16:36:38 +01:00
2014-11-12 18:34:25 +01:00
* Make a slight copy (40Mo Sqlite3 database) of the EMSL Basis Set Exchange website (One database for all the basis set of one format);
2014-11-12 17:41:06 +01:00
* API for scripting ;
* Quick local access without delay ;
* Only need [Python](https://www.python.org/) and [Request](http://docs.python-requests.org/en/latest/) module.
2014-11-12 16:36:38 +01:00
2014-11-19 17:31:00 +01:00
##Dependancy
* Python >2.6
* Request ```pip install requests```
##Installation
* Download the git (```$ git clone https://github.com/TApplencourt/EMSL_Basis_Set_Exchange_Local.git``` for example)
* ```cd``` into & run ```$ ./setup.py```
* ```source EMSL_api.rc```
* Done ! You can now, use ```EMSL_api.py``` or use all the python fonction inside ```./src```
2014-11-12 17:41:06 +01:00
##Usage
2014-11-12 16:36:38 +01:00
```
EMSL Api.
Usage:
EMSL_api.py get_list_basis <db_path>
EMSL_api.py get_list_elements <db_path> <basis_name>
EMSL_api.py get_basis_data <db_path> <basis_name> <elts>...
EMSL_api.py get_list_formats
EMSL_api.py create_db <db_path> <format> [--no-contraction]
EMSL_api.py (-h | --help)
EMSL_api.py --version
Options:
-h --help Show this screen.
--version Show version.
--no-contraction Basis functions are not contracted
<db_path> is the path to the SQLite3 file containing the Basis sets.
```
2014-11-12 17:41:06 +01:00
##To do
2014-11-12 18:28:38 +01:00
For now we can only parse Gaussian-US basis set type file. (Look at ```./src/EMSL_utility.py#EMSL_dump.basis_data_row_to_array```)
2014-11-12 17:41:06 +01:00
Feel free to fork/pull request.
##Disclaimer
2014-11-12 17:41:50 +01:00
It'is not a official API. Use it with moderation.
2014-11-12 17:41:06 +01:00
2014-11-20 16:31:26 +01:00
In papers where you use the basis sets obtained from the Basis Set Exchange please site this :
>The Role of Databases in Support of Computational Chemistry Calculations
>
>>--<cite>Feller, D.; J. Comp. Chem., 17(13), 1571-1586, 1996.</cite>
>Basis Set Exchange: A Community Database for Computational Sciences
>
>>--<cite>Schuchardt, K.L., Didier, B.T., Elsethagen, T., Sun, L., Gurumoorthi, V., Chase, J., Li, J., and Windus ; T.L.
>>J. Chem. Inf. Model., 47(3), 1045-1052, 2007, doi:10.1021/ci600510j.</cite>
And don't forget:
2014-11-12 17:41:06 +01:00
>These documents may be freely distributed and used for non-commercial, scientific and educational purposes.
2014-11-12 17:41:20 +01:00
>-- <cite>http://www.pnl.gov/notices.asp</cite>
2014-11-12 17:41:06 +01:00