omsdetector_forked


Nameomsdetector_forked JSON
Version 2024.11.13 PyPI version JSON
download
home_pageNone
SummaryForked omsdetector to make it compliant with current python versions and dependencies
upload_time2024-11-13 11:53:16
maintainerNone
docs_urlNone
authorDinga Wonanke
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # A Python program to analyze collections of Metal Organic Frameworks (MOFs) for open metal sites.
Author: Emmanuel Haldoupis <emmhald@gmail.com>

March 12th 2018

## Description

Given a set of CIF files this program can read the files, analyze the structures and
detect all the unique open metal sites present in each structure.

The first step is to create a collection containing all the desired CIF files. We can do
this by pointing to a folder containing the CIF files.

```
from omsdetector-forked import MofCollection
mof_coll = MofCollection.from_folder(collection_folder="path to cif folder",
                                     analysis_folder="path to analysis folder")
```

Where **collection_folder** is the folder where the CIF files are located and **analysis_folder** is the folder where the results will be saved.


The analysis is run using the following command on the mof_coll object:

```
mof_coll.analyse_mofs()
```

Specifying a value for num_batches instructs the analysis to run in parallel in the specified number
of batches, each as a separate process.

Once the results have finished they can be summarized using the following methods:

```
mof_coll.summarize_results()
mof_coll.summarize_tfactors()
```

The summarize_results() method generates a table that summarizes the number of open metal sites found for each metal type.
The summarize_tfactors() method generates histograms (and stores them) for the distribution of the t-factors, which indicate
the degree of deviation from a closed coordination sphere for tetra, penta, and hexa-coordinated coordination spheres.

Finaly, a collection can be filtered to create a sub-collection using the following filters:

* "density": [min, max] (range of values)
* "oms_density": [min, max] (range of values)
* "uc_volume":  [min, max] (range of values)
* "metal_species": ["Cu", "Zn", ...] (list of metal species)
* "non_metal_species": ["C", "N", ...] (list of non metal species)
* "cif_okay": True (boolean value)
* "has_oms": True (boolean value)
* "mof_name":  [mof_name1, mof_name2] (string values)

For example:

```
co_oms = mof_coll.filter_collection(using_filter={"metal_species":["Co"], "has_oms":True})
```
See the example jupyter notebook for more details.

## Requirments
* python >=3.9
* pymatgen >=2023.2.28
* pandas 1.3.5
* numpy 1.21.6
* matplotlib 2.1.1

## Reference

Chung, Yongchul; Haldoupis, Emmanuel; Bucior, Benjamin; Haranczyk, Maciej ; Zhang, Hongda; Vogiatzis, Konstantinos; Milisavljevic, Marija; Ling, Sanliang; Camp, Jeffrey; Slater, Ben; Siepmann, J.; Sholl, David; Snurr, Randall *Computation-Ready, Experimental Metal-Organic Framework Database 2018: Additional Structures, Open Metal Sites, and Crystal Reconstruction* (submited to Chemistry of Materials)


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "omsdetector_forked",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Dinga Wonanke",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/ff/2f/7e123b528fdb0de294de6ff74000e1462d63f73b706c962fe654a8d6a682/omsdetector_forked-2024.11.13.tar.gz",
    "platform": null,
    "description": "# A Python program to analyze collections of Metal Organic Frameworks (MOFs) for open metal sites.\nAuthor: Emmanuel Haldoupis <emmhald@gmail.com>\n\nMarch 12th 2018\n\n## Description\n\nGiven a set of CIF files this program can read the files, analyze the structures and\ndetect all the unique open metal sites present in each structure.\n\nThe first step is to create a collection containing all the desired CIF files. We can do\nthis by pointing to a folder containing the CIF files.\n\n```\nfrom omsdetector-forked import MofCollection\nmof_coll = MofCollection.from_folder(collection_folder=\"path to cif folder\",\n                                     analysis_folder=\"path to analysis folder\")\n```\n\nWhere **collection_folder** is the folder where the CIF files are located and **analysis_folder** is the folder where the results will be saved.\n\n\nThe analysis is run using the following command on the mof_coll object:\n\n```\nmof_coll.analyse_mofs()\n```\n\nSpecifying a value for num_batches instructs the analysis to run in parallel in the specified number\nof batches, each as a separate process.\n\nOnce the results have finished they can be summarized using the following methods:\n\n```\nmof_coll.summarize_results()\nmof_coll.summarize_tfactors()\n```\n\nThe summarize_results() method generates a table that summarizes the number of open metal sites found for each metal type.\nThe summarize_tfactors() method generates histograms (and stores them) for the distribution of the t-factors, which indicate\nthe degree of deviation from a closed coordination sphere for tetra, penta, and hexa-coordinated coordination spheres.\n\nFinaly, a collection can be filtered to create a sub-collection using the following filters:\n\n* \"density\": [min, max] (range of values)\n* \"oms_density\": [min, max] (range of values)\n* \"uc_volume\":  [min, max] (range of values)\n* \"metal_species\": [\"Cu\", \"Zn\", ...] (list of metal species)\n* \"non_metal_species\": [\"C\", \"N\", ...] (list of non metal species)\n* \"cif_okay\": True (boolean value)\n* \"has_oms\": True (boolean value)\n* \"mof_name\":  [mof_name1, mof_name2] (string values)\n\nFor example:\n\n```\nco_oms = mof_coll.filter_collection(using_filter={\"metal_species\":[\"Co\"], \"has_oms\":True})\n```\nSee the example jupyter notebook for more details.\n\n## Requirments\n* python >=3.9\n* pymatgen >=2023.2.28\n* pandas 1.3.5\n* numpy 1.21.6\n* matplotlib 2.1.1\n\n## Reference\n\nChung, Yongchul; Haldoupis, Emmanuel; Bucior, Benjamin; Haranczyk, Maciej ; Zhang, Hongda; Vogiatzis, Konstantinos; Milisavljevic, Marija; Ling, Sanliang; Camp, Jeffrey; Slater, Ben; Siepmann, J.; Sholl, David; Snurr, Randall *Computation-Ready, Experimental Metal-Organic Framework Database 2018: Additional Structures, Open Metal Sites, and Crystal Reconstruction* (submited to Chemistry of Materials)\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Forked omsdetector to make it compliant with current python versions and dependencies",
    "version": "2024.11.13",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7141529954b83e83f625ee6ecf4633c68c752bd9de4c31990fb4f9929eef2cca",
                "md5": "23586ce65f9c41940514db3185164179",
                "sha256": "376b663df21eed3cc40fb3be1b24e6ae3024fcf43a0b9983f5ddfbb0e4942952"
            },
            "downloads": -1,
            "filename": "omsdetector_forked-2024.11.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "23586ce65f9c41940514db3185164179",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 21678,
            "upload_time": "2024-11-13T11:53:15",
            "upload_time_iso_8601": "2024-11-13T11:53:15.180771Z",
            "url": "https://files.pythonhosted.org/packages/71/41/529954b83e83f625ee6ecf4633c68c752bd9de4c31990fb4f9929eef2cca/omsdetector_forked-2024.11.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ff2f7e123b528fdb0de294de6ff74000e1462d63f73b706c962fe654a8d6a682",
                "md5": "fd792ea19e743fc30d0ac62fb4688f3c",
                "sha256": "3121a322e95c69cbe61ad692fbc673d3959376e727e571e5bb5ea2c9fcd3a6eb"
            },
            "downloads": -1,
            "filename": "omsdetector_forked-2024.11.13.tar.gz",
            "has_sig": false,
            "md5_digest": "fd792ea19e743fc30d0ac62fb4688f3c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 21060,
            "upload_time": "2024-11-13T11:53:16",
            "upload_time_iso_8601": "2024-11-13T11:53:16.306922Z",
            "url": "https://files.pythonhosted.org/packages/ff/2f/7e123b528fdb0de294de6ff74000e1462d63f73b706c962fe654a8d6a682/omsdetector_forked-2024.11.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-13 11:53:16",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "omsdetector_forked"
}
        
Elapsed time: 0.41384s