Skip to main content

A library for analyzing potential energy surfaces (PESs) and using the resulting PES descriptors for constructing forcefield parameters.

Project description

https://github.com/nlesc-nano/auto-FOX/workflows/Tests/badge.svg https://readthedocs.org/projects/auto-fox/badge/?version=latest https://codecov.io/gh/nlesc-nano/auto-FOX/branch/master/graph/badge.svg?token=7IgHsRDVdo https://zenodo.org/badge/DOI/10.5281/zenodo.3988142.svg https://badge.fury.io/py/Auto-FOX.svg

https://img.shields.io/badge/python-3.7-blue.svg https://img.shields.io/badge/python-3.8-blue.svg https://img.shields.io/badge/python-3.9-blue.svg https://img.shields.io/badge/python-3.10-blue.svg

Automated Forcefield Optimization Extension 0.10.1

Auto-FOX is a library for analyzing potential energy surfaces (PESs) and using the resulting PES descriptors for constructing forcefield parameters. Further details are provided in the documentation.

Currently implemented

This package is a work in progress; the following functionalities are currently implemented:

  • The MultiMolecule class, a class designed for handling and processing potential energy surfaces. (1)

  • A multi-XYZ reader. (2)

  • A radial and angular distribution generator (RDF & ADF). (3)

  • A root mean squared displacement generator (RMSD). (4)

  • A root mean squared fluctuation generator (RMSF). (5)

  • Tools for describing shell structures in, e.g., nanocrystals or dissolved solutes. (6)

  • A Monte Carlo forcefield parameter optimizer. (7)

Using Auto-FOX

  • An input file with some basic examples is provided in the FOX.examples directory.

  • An example MD trajectory of a CdSe quantum dot is included in the FOX.data directory.

    • The absolute path + filename of aforementioned trajectory can be retrieved as following:

>>> from FOX import example_xyz
  • Further examples and more detailed descriptions are available in the documentation.

Installation

Anaconda environments

  • While not a strictly required, it stronly recomended to use the virtual environments of Anaconda.

  • Anaconda comes with a built-in installer; more detailed installation instructions are available for a wide range of OSs.

  • Anaconda environments can be created, enabled and disabled by, respectively, typing:

    • Create environment: conda create -n FOX -c conda-forge python pip

    • Enable environment: conda activate FOX

    • Disable environment: conda deactivate

Installing Auto-FOX

  • If using Conda, enable the environment: conda activate FOX

  • Install Auto-FOX with PyPi: pip install auto-FOX --upgrade

  • Congratulations, Auto-FOX is now installed and ready for use!

Optional dependencies

  • The plotting of data produced by Auto-FOX requires Matplotlib. Matplotlib is distributed by both PyPi and Anaconda:

    • Anaconda: conda install --name FOX -y -c conda-forge matplotlib

    • PyPi: pip install matplotlib

  • Construction of the angular distribution function in parallel requires DASK.

    • Anaconda: conda install -name FOX -y -c conda-forge dask

  • RDKit is required for a number of .psf-related recipes.

    • Anaconda: conda install -name FOX -y -c conda-forge rdkit

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

Auto-FOX-0.10.1.tar.gz (163.8 kB view hashes)

Uploaded Source

Built Distribution

Auto_FOX-0.10.1-py3-none-any.whl (24.1 MB view hashes)

Uploaded Python 3

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