Package for parallel calculation of energy voxels.
Project description
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
moxel path/to/CIFs path/to/voxels_data/ --grid_size=5
You can also use a configuration file:
moxel --config=path/to/config.yaml
[!NOTE] For more information, please refer to the 📚 Documentation.
📰 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
- Improve performance
- Improve voxelization scheme
- Improve modeling of interactions
📑 License
MOXελ is released under the GNU General Public License v3.0 only.
Project details
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pymoxel-0.5.0.post0.tar.gz.
File metadata
- Download URL: pymoxel-0.5.0.post0.tar.gz
- Upload date:
- Size: 2.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c3eabc1e9196ba1451a9fc12072f586d3962ab155a4a8b6b3838b4921bbb41b1
|
|
| MD5 |
035d76d751a5d277b56e1a1961895680
|
|
| BLAKE2b-256 |
ec65d82e58aadb978d842e1e66e0db0a0df7ec7b36837a3d57b730e5d895e76c
|
Provenance
The following attestation bundles were made for pymoxel-0.5.0.post0.tar.gz:
Publisher:
python-publish.yaml on adosar/moxel
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pymoxel-0.5.0.post0.tar.gz -
Subject digest:
c3eabc1e9196ba1451a9fc12072f586d3962ab155a4a8b6b3838b4921bbb41b1 - Sigstore transparency entry: 883724018
- Sigstore integration time:
-
Permalink:
adosar/moxel@a40129f9131bd0d6311d4ef40a3ec896e5e00e6e -
Branch / Tag:
refs/tags/0.5.0.post0 - Owner: https://github.com/adosar
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yaml@a40129f9131bd0d6311d4ef40a3ec896e5e00e6e -
Trigger Event:
push
-
Statement type:
File details
Details for the file pymoxel-0.5.0.post0-py3-none-any.whl.
File metadata
- Download URL: pymoxel-0.5.0.post0-py3-none-any.whl
- Upload date:
- Size: 22.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ea667c1cab35d7ce076d367f94d8573bde3a3eef5fa413f7888c67800da78eda
|
|
| MD5 |
a97ec7b233edb547351cc6ad116e6ae0
|
|
| BLAKE2b-256 |
a20e2d24e2fae8a178212cc562809ab70dab483ea58374ffe81ef08d9c10ec6a
|
Provenance
The following attestation bundles were made for pymoxel-0.5.0.post0-py3-none-any.whl:
Publisher:
python-publish.yaml on adosar/moxel
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pymoxel-0.5.0.post0-py3-none-any.whl -
Subject digest:
ea667c1cab35d7ce076d367f94d8573bde3a3eef5fa413f7888c67800da78eda - Sigstore transparency entry: 883724089
- Sigstore integration time:
-
Permalink:
adosar/moxel@a40129f9131bd0d6311d4ef40a3ec896e5e00e6e -
Branch / Tag:
refs/tags/0.5.0.post0 - Owner: https://github.com/adosar
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yaml@a40129f9131bd0d6311d4ef40a3ec896e5e00e6e -
Trigger Event:
push
-
Statement type: