Skip to main content

Open source implementation of multiple minimum Monte Carlo

Project description

Multiple Minimum Monte Carlo

pypi Ruff

This package will help you perform a multiple minumum Monte Carlo conformer search as described in Chang et al., 1989. It is built to be used with an ASE calculator and ASE optimization tools but user-defined optimization strategies can be employed as well.

Installation

This package can be installed with pip

pip install multiple-minimum-monte-carlo

Tutorial

To run a search, you need to initialize Conformer, Calculation, and ConformerEnsemble objects. Conformer objects require either an input xyz or SMILES string. The default Calculation object is ASEOptimization which requires an ASE optimization routine (like FIRE) and an ASE calculator (the example below uses the xtb calculator which will need to be installed separately from this package). ConformerEnsemble objects require a Conformer and Calculation object.

from ase.optimize.fire import FIRE
from ase.io import write
from xtb.ase.calculator import XTB
from multiple_minimum_monte_carlo.conformer import Conformer
from multiple_minimum_monte_carlo.calculation import ASEOptimization
from multiple_minimum_monte_carlo.conformer_ensemble import ConformerEnsemble

smiles = "CC(=O)Oc1ccccc1C(=O)O"
conformer = Conformer(smiles=smiles)
optimizer = ASEOptimization(calc=XTB(method="gfn2-xtb"), optimizer=FIRE)
conformer_ensemble = ConformerEnsemble(conformer=conformer, calc=optimizer)

To run the search, call run_monte_carlo with the ConformerEnsemble object

final_ensemble = conformer_ensemble.run_monte_carlo()

final_ensemble will be a list of coordinate arrays that arranged by their energy (lowest energy first). To read out the minimum energy compound, do this

from ase.io import write
conformer.atoms.set_positions(final_ensemble[0])
write("lowest_energy_conformer.xyz", conformer.atoms, format="xyz")

User-Defined Calculation

To define a Calculation object, a class will need three function: init, run, and energy. init initializes the class with whatever information is necessary. run performs an optimization. It takes an ase.Atoms object and a list of atoms to constrain and returns an np array of cartesian coordinates (in angstroms) and a float with the energy of the conformation (in kcal/mol). energy calculates the energy of a conformer. It takes an ase.Atoms object and returns a float the with energy (in kcal/mol)

Planned future work

Include support for batched optimization

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

multiple_minimum_monte_carlo-0.0.1.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

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

multiple_minimum_monte_carlo-0.0.1-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file multiple_minimum_monte_carlo-0.0.1.tar.gz.

File metadata

File hashes

Hashes for multiple_minimum_monte_carlo-0.0.1.tar.gz
Algorithm Hash digest
SHA256 2502066a5d6d08d3e030b119423e9c053366b01491e181cf21c6adc31c319607
MD5 3500e279836d02268b35e06fb9343244
BLAKE2b-256 b2bb25d149215bebd2fe4aa4ec0aa91a05bb0ab18c6e751f4f75baf59791e3a2

See more details on using hashes here.

File details

Details for the file multiple_minimum_monte_carlo-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for multiple_minimum_monte_carlo-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f34ac183f158e21b58d17b5bdc2901dfba0063f6f68d2ad35bf78002763831f7
MD5 8e6e048deb14b1e6fbc1e227a3893337
BLAKE2b-256 7aeed45d7571286a640400e6d801a98d239c63cbab99696f1d9e776aae3b98f6

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