Skip to main content

Package for parallel calculation of energy voxels.

Project description

Logo

Requires Python 3.10+ Licensed under GPL-3.0-only Read the Docs pip install pymoxel Documentation Status PyPI version

MOXελ is a Python package for parallel calculation of energy voxels, with emphasis on reticular chemistry.

The majority of time in a ML workflow goes into constructing the inputs and making sure they are clean, rather than focusing on the ML part itself.

MOXελ aims to provide a simple and fast interface to generate energy voxels in a ML-ready format, minimizing as much as possible the time spent on these preprocessing steps.

⚙️ Installation

It is strongly recommended to perform the installation inside a virtual environment.

Check the installation steps.

Assuming an activated virtual environment:

pip install pymoxel

📖 Usage

Check the tutorial.

Voxels

📰 Citing MOXελ

If you use ΜΟΧελ in your research, please consider citing the following work:

@article{Sarikas2024,
title = {Gas adsorption meets deep learning: voxelizing the potential energy surface of metal-organic frameworks},
volume = {14},
ISSN = {2045-2322},
url = {http://dx.doi.org/10.1038/s41598-023-50309-8},
DOI = {10.1038/s41598-023-50309-8},
number = {1},
journal = {Scientific Reports},
publisher = {Springer Science and Business Media LLC},
author = {Sarikas,  Antonios P. and Gkagkas,  Konstantinos and Froudakis,  George E.},
year = {2024},
month = jan
}

📇 TODO

  1. CLI for training RetNet.
  2. Improve performance
  3. Improve voxelization scheme
  4. Improve modeling of interactions

📑 License

MOXελ is released under the GNU General Public License v3.0 only.

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

pymoxel-0.1.2.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

pymoxel-0.1.2-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

Details for the file pymoxel-0.1.2.tar.gz.

File metadata

  • Download URL: pymoxel-0.1.2.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for pymoxel-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6fd7a7c383be79cad72a9098fc3b28eef18bcd9bf40f7609b4fd46f649c7bb16
MD5 579dd16bf051b9c569f0e9c3a5b8597c
BLAKE2b-256 8bdc0466eb8eae0de2f44f16fca94aa0942633b0cd5b2926a9d1333395f3194d

See more details on using hashes here.

File details

Details for the file pymoxel-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pymoxel-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 24.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for pymoxel-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0f5f4d3079f851714d0b873f2d9ddd7205eaa80f06491e4fca7978f87dec46a0
MD5 976165046188fc90d2aeca2749849d63
BLAKE2b-256 b23bf8d8b31e62a09cbe4f1d22b6889ed9094789c528c29a6cd64b1a1fb02d05

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