Skip to main content

Design, create, and generate unique, complex molecular structures of any shape and size!

Project description

TurtleMol

Design, create, and generate unique, complex molecular structures of any shape and size!

Build Status Codecov License Repo size Black style Black style

Introduction

The goal of TurtleMol is to ease the process of generating unique and complex molecular structures for computational chemistry. Available as a standalone python-package, or as a plugin for Avogadro2 TurtleMol aims to quickly generate the intial state of molecular strcutres that are ready for optimization via quamtum or classical calculations!

Generating intial structure files for calculations can be a tedious process, one that TurtleMol aims to fix. Large structures can be generated quickly, and are very tunable based on the need of the user! Currently only basic shapes such as boxes and spheres are generatable, but more complex meshes are in the works!

Approach

TurtleMol takes an input molecules (or molecules) and copies them into a grid filling out a user defined volume. The number of molecules in the volume can be specially defined, calculated via a desired density, or for filling space.

The orientation of the molecules can be randomized so structures are closer to their equilibrium point, but will still need outside optimization. Molecules can also be placed randomly instead of in a grid, allowing for a more disordered structure.

Current Features

  • Generate a box or sphere of molecules
  • Generate a box or sphere of molecules around an existing molecular structure
  • Fill a volume, or place a specfied number of molecules in space
  • Randomly orient molecules to better represent an equilibrium structure
  • Read/Write structures from XYZ and PDB formats

Features in Progress

  • Generate structures based on meshes defined from outside software/packagaes such as Blender

Installation

You can install the latest development version of TurtleMol from the Github Repository.

git clone https://github.com/Dfilono/TurtleMol
cd TurtleMol
pip install .

A PyPI version is in progress!

Citation

If you find this code helpful, please consider referencing it! We don't currently have a released article to cite, but any reference to our work helps acknowledge the effort put into developing and maintaining this code base, provides support for further development!

License

Distributed under the MIT License. See LICENSE for more information.

Documentation

Documentation is in progress.

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

TurtleMol-0.post0.dev1.tar.gz (44.0 kB view details)

Uploaded Source

Built Distribution

TurtleMol-0.post0.dev1-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

Details for the file TurtleMol-0.post0.dev1.tar.gz.

File metadata

  • Download URL: TurtleMol-0.post0.dev1.tar.gz
  • Upload date:
  • Size: 44.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for TurtleMol-0.post0.dev1.tar.gz
Algorithm Hash digest
SHA256 d59ffb6c782f43c6e6def9ba5ad3c9e7a5143b6949ffdfac92f9d142b50325e9
MD5 d25f5c0c8f133196dbacfafbfce78dc0
BLAKE2b-256 8526c181553ebd7379a1782ad49e73e4a363c5aaacea060cbfe207fafffa170e

See more details on using hashes here.

File details

Details for the file TurtleMol-0.post0.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for TurtleMol-0.post0.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 e2f2cf0d17c7784b4000e67749c7027d69bad71c8933fb0722e3ed17a1b91b47
MD5 48b782c27900470290ea8beb9d73fd0a
BLAKE2b-256 44fb32084bd1130991310764c50ce1d81a4509f23e209aa224ea29134cd329cf

See more details on using hashes here.

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