Skip to main content

Mine MOF oxidation states and featurize metal sites.

Project description

oximachine_featurizer

Actions Status Documentation Status DOI Binder codecov

Mine oxidation states for structures from the (MOF) subset of the CSD and calculate features for them. Runscripts are automatically installed for the most important steps. Some of these runscripts contain hard coded paths, that would need to be updated. This code generates inputs that can be used with the learnmofox package to replicate our work [1].

If you're just interested in using a pre-trained model, the oximachinerunner package.

⚠️ Warning: For the mining of the oxidation states, you need the CSD Python API. You need to export the CSD_HOME path. Due to the licensing issues, this cannot be done automatically.

Installation

The commands below automatically install several command-line tools (CLI) which are detailed below.

The full process should take some seconds.

Latest version

To install the latest version of the software with all dependencies, you can use

pip install git+https://github.com/kjappelbaum/oximachine_featurizer.git

Stable release

pip install oximachine_featurizer

How to use it

To run the default featurization on one structure you can use the CLI

run_featurization <structure> <outdir>

for each metal center this should take seconds if there is no disorder.

Some output can be found on the MaterialsCloud Archive (doi: 10.24435/materialscloud:2019.0085/v1 ).

More details can be found in the documentation.

Example usage

The use of the main functions of this package is shown in the Jupyter Notebook in the example directory. It contains some example structures and the output, which should be produces in seconds.

Testing the installation

For testing, you can---as it is done for the continuous integration (CI)---use pytest and run the files in the test directory. For example

pip install pytest
pytest test/main

References

[1] Jablonka, Kevin Maik; Ongari, Daniele; Moosavi, Seyed Mohamad; Smit, Berend (2020): Using Collective Knowledge to Assign Oxidation States. ChemRxiv. Preprint. https://doi.org/10.26434/chemrxiv.11604129.v1

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

oximachine_featurizer-0.4.0.tar.gz (49.8 kB view details)

Uploaded Source

Built Distribution

oximachine_featurizer-0.4.0-py3-none-any.whl (52.5 kB view details)

Uploaded Python 3

File details

Details for the file oximachine_featurizer-0.4.0.tar.gz.

File metadata

  • Download URL: oximachine_featurizer-0.4.0.tar.gz
  • Upload date:
  • Size: 49.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for oximachine_featurizer-0.4.0.tar.gz
Algorithm Hash digest
SHA256 80271cd636e25c76d5adbef1282bfb4f3f4a936e8e13118ac08a8d032cb93ba1
MD5 9c8d320b4bb789d910e12db7ffde070c
BLAKE2b-256 05376f024b53a8eb07c2279a430a045322ab1ebd0b49b9a31ce286dc1bf91f05

See more details on using hashes here.

File details

Details for the file oximachine_featurizer-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for oximachine_featurizer-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d4980f938b92ca98e475f271ff5190fee3db6343cea0270c8849bc4e9dd8c296
MD5 fef86ec5cd1bd82f417c54fac1a40877
BLAKE2b-256 5883a400628c56d67494a780db4ea6f6d5527cd5d278a05ad791711dd33f13a4

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