Skip to main content

Electrostatic Map Suite - A Comprehensive Set of Calculators for Qualifying and Quantifying Electrostatic Interactions and Effects.

Project description

EMSuite - Electrostatic Map Suite

A comprehensive Python package for calculating electrostatic tuning effects on molecular properties using quantum mechanical methods.

Overview

EMSuite is aimed at qualifying and quantifying the influence of external electrostatic fields on electronic structure and corresponding chemistry. The current implementation includes the tuning module, inspired by the concluding sentence of Electrostatic Spectral Tuning Maps for Biological Chromophores's (Gozem et al., 2019) abstract. This module extends the central approach of ESTMs to 13 new chemical properties enabling systematic exploration of supramolecular electronic influence. This approach enables the prediction and visualization of electrostatic tuning effects, which are crucial for understanding molecular behavior in different environments.

Features

  • Multiple Input Formats: Support for SMILES strings (with automatic QM optimization) and XYZ coordinate files
  • Comprehensive Property Calculations: Ground state energies, orbital energies, dipole moments, ionization potentials, electron affinities, and excited state properties
  • GPU Acceleration: Full GPU support via GPU4PySCF for enhanced computational speed (CPU fallback immediately available).
  • Implicit Solvation: Built-in support for solvent effects using the SMD model.
  • Visualization Output: MOL2 files for 3D visualization and CSV summaries for data analysis.

Installation

#CPU Installation
pip install emsuite

#GPU Installation
pip install emsuite[gpu]

EMSuite automatically detects available hardware and uses GPU acceleration when available, falling back to CPU mode otherwise.

Quick Start

  1. Create a tuning input file (tuning.in):
input_type = 'SMILES'      # Or 'xyz' for coordinate files
input_data = 'O'           # SMILES string or path to xyz file
method = 'dft'             # HF also permissible
basis_set = '6-31G*'       # Full list in method-info/basis-sets on GitHub
functional = 'pbe0'        # Full list in method-info/functionals.csv on GitHub
charge = 0                 # Molecular charge
spin = 0                   # Spin multiplicity
surface_charge = 1.0       # Point charge magnitude (can be fractional, e.g., 0.005)
solvent = None             # Solvent name or None for gas phase
properties = ['gse']       # List of properties to calculate (see below)
state_of_interest = 1      # Number of excited states (if exe/osc requested)
triplet = False            # Set True for triplet excited states
  1. Run the calculation:
emsuite tuning.in

Available Properties

The following molecular properties can be calculated:

Property Description Units
'gse' Ground state energy kcal/mol
'homo' HOMO energy eV
'lumo' LUMO energy eV
'gap' HOMO-LUMO gap eV
'dm' Dipole moment magnitude Debye
'ie' Ionization energy kcal/mol
'ea' Electron affinity kcal/mol
'cp' Chemical potential kcal/mol
'eng' Electronegativity eV
'hard' Chemical hardness eV
'efl' Electrophilicity eV
'nfl' Nucleophilicity eV
'exe' Excitation energies eV
'osc' Oscillator strengths dimensionless

Use 'all' to calculate all available properties.

Input Options

Input Types

  • SMILES: Automatically generates 3D coordinates and performs geometry optimization
  • XYZ: Uses provided coordinate file directly

Methods and Basis Sets

  • Methods: 'dft', 'hf'
  • Functionals: See method-info/functionals.csv on GitHub for complete list
  • Basis Sets: See method-info/basis-sets/ on GitHub for available options
  • Solvents: See method-info/solvents/ on GitHub for available solvents

Output Files

For each calculated property, EMSuite tuning generates:

  1. MOL2 files: {molecule_name}_{property}.mol2 - 3D visualization files showing property effects mapped to surface coordinates
  2. CSV summary: {molecule_name}_tuning_summary.csv - Tabular data with coordinates and all property effects

Example Usage

Water molecule LUMO tuning:

input_type = 'SMILES'
input_data = 'O'
basis_set = '6-31G*'
functional = 'b3lyp'
properties = ['lumo']
surface_charge = 1.0

Benzene with multiple properties:

input_type = 'SMILES'
input_data = 'c1ccccc1'
basis_set = 'def2-SVP'
functional = 'pbe0'
properties = ['homo', 'lumo', 'gap', 'ie', 'ea']
solvent = 'water'

Excited state analysis:

input_type = 'xyz'
input_data = 'molecule.xyz'
properties = ['exe', 'osc']
state_of_interest = 5
triplet = True

Sample Outputs for tuning.in in water-test/

Citation

If you use EMSuite in your research, please cite:

Gozem, S., et al. "Electrostatic Tuning of Molecular Properties" J. Phys. Chem. B 2019, DOI: 10.1021/acs.jpcb.9b00489

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For questions, bug reports, or feature requests, please open an issue on GitHub.

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

emsuite-1.0.0.tar.gz (105.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

emsuite-1.0.0-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file emsuite-1.0.0.tar.gz.

File metadata

  • Download URL: emsuite-1.0.0.tar.gz
  • Upload date:
  • Size: 105.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for emsuite-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a18bfa75f5e4dd875faeb069f163697e983d25a5a7d70d86e05261678711f701
MD5 683af1ac1a05a736fa8d693076dec5a6
BLAKE2b-256 35f691630ba3c6aa7eb3edbcfe75b0f2c81d0e22d0de2398588f1c5166ff44c7

See more details on using hashes here.

File details

Details for the file emsuite-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: emsuite-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for emsuite-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2397504c4c129afb0d2d0873e35394af54e7c5a2aaa38eced32c198668aa855a
MD5 b3e06208a0b40f2e44fd20c18e44037f
BLAKE2b-256 9056fb236a7a154081bbb76cd2eb7807c017d6ce04b2e871bb68e293564f774b

See more details on using hashes here.

Supported by

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