Skip to main content

Computational Chemistry Input Generator

Project description

Computational Chemistry Input Generator

codecov PyPI version Downloads DOI

ccinput is an application to generate input files for computational chemistry software.

Example usage:

$ ccinput gaussian opt M062X -bs def2tzvp -f ethanol.xyz -n 8 --mem 32G
%chk=calc.chk
%nproc=8
%mem=32000MB
#p opt M062X/Def2TZVP

File created by ccinput

0 1
C   -1.31970000  -0.64380000   0.00000000
H   -0.96310000  -1.65260000   0.00000000
H   -0.96310000  -0.13940000  -0.87370000
H   -2.38970000  -0.64380000   0.00000000
C   -0.80640000   0.08220000   1.25740000
H   -1.16150000   1.09160000   1.25640000
H   -1.16470000  -0.42110000   2.13110000
O    0.62360000   0.07990000   1.25870000
H    0.94410000   0.53240000   2.04240000

ccinput can also be used as python library:

>>> from ccinput.wrapper import gen_input
>>> inp = gen_input(software="orca", type="ts", method="PBEh-3c", in_file="ethanol.xyz", nproc=16, solvent="ethanol", solvation_model="SMD")
*** No solvation radii specified; using default radii ***
>>> print(inp)
!OPTTS PBEh-3c
*xyz 0 1
C   -1.31970000  -0.64380000   0.00000000
H   -0.96310000  -1.65260000   0.00000000
H   -0.96310000  -0.13940000  -0.87370000
H   -2.38970000  -0.64380000   0.00000000
C   -0.80640000   0.08220000   1.25740000
H   -1.16150000   1.09160000   1.25640000
H   -1.16470000  -0.42110000   2.13110000
O    0.62360000   0.07990000   1.25870000
H    0.94410000   0.53240000   2.04240000
*
%pal
nprocs 16
end
%cpcm
smd true
SMDsolvent "ethanol"
end
>>>

Installation

From PyPI

pip install ccinput

From Github

You can install the bleeding-edge version of ccinput from Github:

pip install git+https://github.com/cyllab/ccinput

Usage

ccinput supports a wide range of options, including different solvation radii, density fitting and multiple basis sets. As of now, Gaussian 16 and ORCA 5 are supported, and more packages will be added in the future.

From the command line

Simply use the ccinput command with the desired parameters:

usage: ccinput [-h] [--basis_set BASIS_SET] [--solvent SOLVENT] [--solvation_model SOLVATION_MODEL]
               [--solvation_radii SOLVATION_RADII] [--custom_solvation_radii CUSTOM_SOLVATION_RADII]
               [--specifications SPECIFICATIONS] [--density_fitting DENSITY_FITTING]
               [--custom_basis_sets CUSTOM_BASIS_SETS] [--xyz XYZ] [--file FILE] [--output OUTPUT]
               [--constraints CONSTRAINTS] [--freeze ATOM [ATOM ...]] [--scan ATOM [ATOM ...]]
               [--from FROM] [--to TO] [--nsteps NSTEPS] [--step STEP] [--nproc NPROC] [--mem MEM]
               [--charge CHARGE] [--mult MULT] [--d3 | --d3bj] [--name NAME] [--aux_name AUX_NAME]
               [--header HEADER] [--version]
               software type method

More detailed information about each option can be obtained with the ccinput -h command.

As Python library

The function gen_input returns input files as a single strings with the correct whitespace.

>>> from ccinput.wrapper import gen_input
>>> inp = gen_input(...)

The input can also be directly written to a file using write_input.

>>> from ccinput.wrapper import write_input
>>> write_input(filename, ...)

See the documentation for all options.

Contributing

We welcome all contributions to the project. This includes:

  • Support for new packages (even if rudimentary)
  • Support for new features of supported packages
  • Correction or improvement of static data (like DFT functionals or basis sets)

Planned tasks are listed in the roadmap. This can be a good place to start when looking to contribute, although do not limit yourself to what is listed there. The contribution guidelines are detailed in CONTRIBUTING.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ccinput-1.3.2.tar.gz (66.5 kB view details)

Uploaded Source

Built Distribution

ccinput-1.3.2-py3-none-any.whl (52.8 kB view details)

Uploaded Python 3

File details

Details for the file ccinput-1.3.2.tar.gz.

File metadata

  • Download URL: ccinput-1.3.2.tar.gz
  • Upload date:
  • Size: 66.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for ccinput-1.3.2.tar.gz
Algorithm Hash digest
SHA256 848b647a1777a0ad0bee4447fe3ef9d314700ed38bd14d1e5b694252ef14a1f5
MD5 a38594cfdd8081317bf231e281d0b944
BLAKE2b-256 c812146b43265ec1f08c61ee3906ea4b1b9c4dfbd5ad64ebeb593c28abab0397

See more details on using hashes here.

File details

Details for the file ccinput-1.3.2-py3-none-any.whl.

File metadata

  • Download URL: ccinput-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 52.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for ccinput-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 611b4550afcf3545797f74d760b336880114575c234599356033d77512a97932
MD5 25dfeec1b2311575962ae876b0b79d81
BLAKE2b-256 447981d2e73b05c15c40b533d9f87308c0323ead5f67e2bdc61511ef626ba2d2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page