Splits MOFs into metal nodes and linkers.
Project description
💪 Getting Started
mof = MOF.from_cif('tests/test_files/HKUST-1.cif')
Fragment the MOF
fragments = mof.fragment()
If you are in a Jupyter notebook you can visualize the components.
fragments.linkers[0].show_molecule()
fragments.nodes[0].show_molecule()
You can also search PubChem for the building blocks
fragments.linkers[0].search_pubchem()
To get the RCSR code run
fragments.net_embedding.rcsr_code
🚀 Installation
To install the latest release run
pip install moffragmentor
To install the development version run
pip install git+https://github.com/kjappelbaum/moffragmentor.git
You need to have openbabel
installed which you can install with conda install -c conda-forge openbabel
.
As a utility, you can also run bash create_conda.sh
to create a conda environment with all dependencies.
Note that you might want to change the name of the name of the environment (defaults to moffragmentor
).
moffragmentor in the MOF decomposition tool landscape
While moffragmentor has some unique features, it might not be the right tool for your task. Due to some design choices (having a pymatgen representation of all fragments and the net) it is relatively slow in the current implementation (though there are obvious ways for fixing this).
Therefore, we encourage you to also consider alternative tools:
👐 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.rst for more information on getting involved.
⚖️ License
The code in this package is licensed under the MIT License.
💰 Funding
The research was supported by the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (grant agreement 666983, MaGic), by the NCCR-MARVEL, funded by the Swiss National Science Foundation, and by the Swiss National Science Foundation (SNSF) under Grant 200021_172759.
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
File details
Details for the file moffragmentor-0.0.6.tar.gz
.
File metadata
- Download URL: moffragmentor-0.0.6.tar.gz
- Upload date:
- Size: 1.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f41649b5010ba875d3c7eefda907f070adae4161114b785187f63ece4ca67aa3 |
|
MD5 | 0f7bee7a8a76d9516808188a4b77f213 |
|
BLAKE2b-256 | a49e51425dafdd0de12bcc4be7bd7f62bedbaa509363566dab6eb67fe8d08fc6 |
File details
Details for the file moffragmentor-0.0.6-py3-none-any.whl
.
File metadata
- Download URL: moffragmentor-0.0.6-py3-none-any.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 972635544199e3f8b67fdf39457e9d19b9c957608b079e2860bc71868753ed6f |
|
MD5 | 9214994ac272a993dc8a6941f7e7fe46 |
|
BLAKE2b-256 | 939f21722e5efe1007f317ba3d950b64fb7dca614ae3549963492beb35c038e0 |