Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 3.79 KB

README.md

File metadata and controls

98 lines (64 loc) · 3.79 KB
Raw

Continuous Integration PyPI version

Basis Set Exchange Website

If you are looking for the Basis Set Exchange website (which can be used to browse and download this data in a more user-friendly way), visit https://www.basissetexchange.org

Overview

This project is a library containing basis sets for use in quantum chemistry calculations. In addition, this library has functionality for manipulation of basis set data.

The goal of this project is to create a consistent, thoroughly curated database of basis sets, and to provide a standard nomenclature for quantum chemistry.

The data contained within this library is being thoroughly evaluated and checked against relevant literature, software implementations, and other databases when available. The original data from the PNNL Basis Set Exchange is also available.

This library is used to form the backend of the new Basis Set Exchange website.

This project is a collaboration between the Molecular Sciences Software Institute (https://molssi.org) and the Environmental Molecular Sciences Laboratory (https://www.emsl.pnl.gov)

Citation

When publishing results obtained from use of the Basis Set Exchange software, please cite:

  • A New Basis Set Exchange: An Open, Up-to-date Resource for the Molecular Sciences Community Benjamin P. Pritchard, Doaa Altarawy, Brett Didier, Tara D. Gibson, and Theresa L. Windus J. Chem. Inf. Model. 2019, 59(11), 4814-4820 doi:10.1021/acs.jcim.9b00725

For citing the previous EMSL/PNNL Basis Set Exchange, please cite the following references:

  • The Role of Databases in Support of Computational Chemistry Calculations, Feller, D., J. Comp. Chem. 1996, 17(13), 1571-1586, doi:10.1002/(SICI)1096-987X(199610)17:13<1571::AID-JCC9>3.0.CO;2-P
  • Basis Set Exchange: A Community Database for Computational Sciences Schuchardt, K.L., Didier, B.T., Elsethagen, T., Sun, L., Gurumoorthi, V., Chase, J., Li, J., and Windus, T.L. J. Chem. Inf. Model. 2007, 47(3), 1045-1052, doi:10.1021/ci600510j

Documentation

Full user and developer documentation can be found at https://molssi-bse.github.io/basis_set_exchange

An overview of the project and its design is also available at https://molssi-bse.github.io/basis_set_exchange/project_doc.html

Command line interface

This library also includes a command line interface. See https://molssi-bse.github.io/basis_set_exchange/bse_cli.html for how to use it.

Installation

This project can be installed via pip/PyPI.

pip install basis_set_exchange

If checking out from github, you can do a local install of the Python directory,

pip install -e .

Testing

Tests can be run using py.test -v once installed. Thorough (but very long) tests can be run with py.test --runslow.

Examples

import basis_set_exchange as bse

# Obtain the STO-3G basis set in nwchem format (as a string) for hydrogen and carbon
bse.get_basis('STO-3G', elements=[1,6], fmt='nwchem')

# Obtain the references for the above
bse.get_references('STO-3G', elements=[1,6], fmt='txt')

For more documentation, see https://molssi-bse.github.io/basis_set_exchange

Command line

Same as above, but using the command line

$ bse get-basis sto-3g nwchem --elements=1,6

$ bse get-refs sto-3g txt --elements=1,6

License

This project is released under the BSD 3-Clause license. See LICENSE for details.