Skip to main content

Calculation of electronic aromaticity indicators

Project description

The ESIpy program is aimed at the calculation of population analysis and aromaticity indicators from different Hilbert-space partitions using the PySCF module. The program supports both restricted and unrestricted calculations for single-determinant wavefunctions, and correlated wavefunctions from a restricted object (RHF). The atomic partitions supported by the program are Mulliken, Löwdin, meta-Löwdin, Natural Atomic Orbitals (NAO), and Intrinsic Atomic Orbita ( IAO).

Citation

All the calculations performed for the creation and implementation of this program have been conducted in the following scientific paper:

Joan Grèbol-Tomàs, Eduard Matito, Pedro Salvador, Chem. Eur. J. 2024, 30, e202401282.

Also, find it on-line here. If you are publishing the results obtained from ESIpy remember to cite the program. The code is licensed under the GNU GPLv3. See the LICENSE file for details. See the examples/README.md file for details on how to use the program. If you encounter any bugs, please feel free to report them on the Issues page, or send a mail to joan.grebol@dipc.org.

Installation

ESIpy can be installed through:

pip install esipython

For a detailed explanation on how to run the code and how to customize it, please see the documentation.

Getting started

ESIpy works on the object ESI, which will contain all the information required for the calculation. It is recommended to initialize the object with all the data, rather than adding it once the initialization process is finished.

The simplest form of input follows a usual PySCF calculation

    from pyscf import gto, dft
    import esipy

    mol = gto.Mole()
    mol.atom = '''
    6        0.000000000      0.000000000      1.393096000
    6        0.000000000      1.206457000      0.696548000
    6        0.000000000      1.206457000     -0.696548000
    6        0.000000000      0.000000000     -1.393096000
    6        0.000000000     -1.206457000     -0.696548000
    6        0.000000000     -1.206457000      0.696548000
    1        0.000000000      0.000000000      2.483127000
    1        0.000000000      2.150450000      1.241569000
    1        0.000000000      2.150450000     -1.241569000
    1        0.000000000      0.000000000     -2.483127000
    1        0.000000000     -2.150450000     -1.241569000
    1        0.000000000     -2.150450000      1.241569000
    '''
    mol.basis = 'sto-3g'
    mol.spin = 0
    mol.charge = 0
    mol.symmetry = True
    mol.verbose = 0
    mol.build()

    mf = dft.KS(mol)
    mf.kernel()

    ring = [1, 2, 3, 4, 5, 6]
    arom = esipy.ESI(mol=mol, mf=mf, rings=ring, partition="nao")
    arom.print()

In order to avoid the single-point calculation, the attributes saveaoms and savemolinfo will save the AOMs and a dictionary containing information about the molecule and calculation into a binary file in disk. Hereafter, these will be accessible at any time. It is also recommended to use a for-loop scheme for all the partitions, as the computational time to generate the matrices is minimal and independent to the chosen scheme.

    ring = [1, 2, 3, 4, 5, 6]
    name = "benzene"
    for part in ["mulliken", "lowdin", "meta_lowdin", "nao", "iao"]:
        aoms_name = name + '_' + part + '.aoms'
        molinfo_name = name + '_' + part + '.molinfo'
        arom = esipy.ESI(mol=mol, mf=mf, rings=ring, partition=part, saveaoms=aoms_name, savemolinfo=molinfo_name)
        arom.print()

Additionally, one can generate a directory containing the AOMs in AIMAll format. These files are readable from ESIpy, but also from Eduard Matito's ESI-3D code. These are written through the method writeaoms()

    arom = esipy.ESI(mol=mol, mf=mf, rings=[1,2,3,4,5,6], partition="nao")
    arom.writeaoms("benzene_nao.aoms")

Further work

  • Approximations for the MCI calculation in large systems.
  • Read the AOMs (or the data required for their calculation) from other source programs and store them as ESIpy Smo.
  • Calculation of aromaticity indicators from defined fragments.
  • Split the calculation into orbital contributions.
  • Algorithm to automatically find the rings inside a system.

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

ESIpython-1.0.2.tar.gz (43.2 kB view details)

Uploaded Source

Built Distribution

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

ESIpython-1.0.2-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file ESIpython-1.0.2.tar.gz.

File metadata

  • Download URL: ESIpython-1.0.2.tar.gz
  • Upload date:
  • Size: 43.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for ESIpython-1.0.2.tar.gz
Algorithm Hash digest
SHA256 9e36b47b5f36e9baa153a1add8f57c325c15e0a6c4b5236785b1d507bb1e7b1e
MD5 ebf3dafc22178f40e1249e1eca13d0a8
BLAKE2b-256 81f898aa123fc956796fec6f6697afd864c71ab689b87adfb4a516cb51165c59

See more details on using hashes here.

File details

Details for the file ESIpython-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: ESIpython-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 47.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for ESIpython-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 105dbd67f4648f197d91b19f099216bbb4f420f8f1f9e00dc495efadc9ba132b
MD5 682cfd095f8fd78b3696f6aa39e8494e
BLAKE2b-256 635ced2911c2ecde6f1bb51db05830d5c4713fa1af9cafda5af1cec469223596

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