A library for analyzing potential energy surfaces (PESs) and using the resulting PES descriptors for constructing forcefield parameters.
Project description
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_xyzFurther 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.
See the Anaconda documentation.
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file Auto-FOX-0.10.1.tar.gz.
File metadata
- Download URL: Auto-FOX-0.10.1.tar.gz
- Upload date:
- Size: 163.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 29e2792fb9f5b0af9de2a868dc8f49d81336d3d6a5478c9747bf156c8061abdd |
|
| MD5 | 381a8d68b31d53fa7e851a67ef35ffaa |
|
| BLAKE2b-256 | d59b5cd088835a5443f315dd668c9bb3f5698575499a2eab7d81afb583fe7ca4 |
File details
Details for the file Auto_FOX-0.10.1-py3-none-any.whl.
File metadata
- Download URL: Auto_FOX-0.10.1-py3-none-any.whl
- Upload date:
- Size: 24.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 356de4c018d45e4a231669f81f32c4c76fa94ec6887ce28c06de677ceaa58cd9 |
|
| MD5 | edb023428f5bb9c0838c1c2d4c7f62bb |
|
| BLAKE2b-256 | 281c5af155f0313d90c7ae4efc5938c34a38a4daca7dba51dbb2a5f9315699f7 |
