<img src="./assets/logo.svg" width="200px">
# Oganesson
`oganesson` (`og` for short) is a python package that enables you to apply artificial intelligence workflows to your material discovery projects.
## Installation
`og` requires the installation of the following library:
- DGL: https://www.dgl.ai/pages/start.html
After installing the above library, you can install `og` using the `pip` command as follows:
`pip install oganesson`
# Features
`og` is currently under active development. The following features are currently available.
## Machine learning descriptors
`og` will bring together machine learning descriptors for materials and molecules within a unified framework. `og` currently provides the following descriptors:
- The BACD, ROSA and SymmetryFunctions introduced in this [publication](https://doi.org/10.1186/s13321-022-00658-9)
- Most of the descriptors from [DScribe](https://github.com/SINGROUP/dscribe)
Each descriptor has its own class, which extends the `Descriptors` class in the `oganesson.descriptors` module. Here is an example of how to describe a structure using the `BACD` and `SymmetryFunctions` descriptor classes.
```python
from oganesson.descriptors import BACD, SymmetryFunctions
from oganesson.ogstructure import OgStructure
bacd = BACD(OgStructure(file_name='examples/structures/Li3PO4_mp-13725.cif'))
print(bacd.describe())
sf = SymmetryFunctions(OgStructure(file_name='examples/structures/Li3PO4_mp-13725.cif'))
print(sf.describe())
```
## Genetic algorithms
The main purpose of `og` is to make complex artificial intelligence workflows easy to compose. Here is an example: running a genetic search for structures, where the structure optimization is performed using the M3GNET neural network model.
```python
from oganesson.genetic_algorithms import GA
ga = GA(species=['Na']*4 + ['H']*4)
for i in range(10):
ga.evolve()
```
## Generation of the diffusion path for NEB calculations
The most painful part of doing transition state calculations in VASP is in building the images. The following code makes this happen in 2 lines of code. You only need to specify the structure file, and the atomic species you want to diffuse, and OgStructure will generate a folder for each path, and then write the POSCAR image files in each of these folders.
In the following example, we explore the possible Li diffusion paths in Li3PO4, given there are 6 Li atoms in the cell.
```python
from oganesson.ogstructure import OgStructure
og = OgStructure(file_name='examples/structures/Li3PO4_mp-13725.cif')
og.generate_neb('Li')
```
Note that the default value of `r`, which is 3, is sufficient for lithium systems. However, for the case of larger atoms such as Na, a larger value of `r` would be required.
## Finding a reasonable adsorption site of an atom on a surface
```python
from oganesson.ogstructure import OgStructure
og=OgStructure(file_name='examples/structures/MoS2.vasp')
og.add_atom_to_surface('Li').structure.to('MoS2_Li.vasp','poscar')
```
Raw data
{
"_id": null,
"home_page": "https://github.com/oganesson-ai/oganesson",
"name": "oganesson",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "ai, machine learning, material science",
"author": "Sherif Abdulkader Tawfik Abbas",
"author_email": "sherif.tawfic@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1c/ce/bed673a8ce0489da8a4f434cafbe2d1185f99488f3b02dbd8697194169c9/oganesson-0.1.44.tar.gz",
"platform": null,
"description": "<img src=\"./assets/logo.svg\" width=\"200px\">\r\n\r\n# Oganesson\r\n\r\n`oganesson` (`og` for short) is a python package that enables you to apply artificial intelligence workflows to your material discovery projects.\r\n\r\n## Installation\r\n\r\n`og` requires the installation of the following library:\r\n\r\n- DGL: https://www.dgl.ai/pages/start.html\r\n\r\nAfter installing the above library, you can install `og` using the `pip` command as follows:\r\n\r\n`pip install oganesson`\r\n\r\n# Features\r\n\r\n`og` is currently under active development. The following features are currently available.\r\n\r\n## Machine learning descriptors\r\n\r\n`og` will bring together machine learning descriptors for materials and molecules within a unified framework. `og` currently provides the following descriptors:\r\n\r\n- The BACD, ROSA and SymmetryFunctions introduced in this [publication](https://doi.org/10.1186/s13321-022-00658-9)\r\n- Most of the descriptors from [DScribe](https://github.com/SINGROUP/dscribe)\r\n\r\nEach descriptor has its own class, which extends the `Descriptors` class in the `oganesson.descriptors` module. Here is an example of how to describe a structure using the `BACD` and `SymmetryFunctions` descriptor classes.\r\n\r\n```python\r\nfrom oganesson.descriptors import BACD, SymmetryFunctions\r\nfrom oganesson.ogstructure import OgStructure\r\n\r\nbacd = BACD(OgStructure(file_name='examples/structures/Li3PO4_mp-13725.cif'))\r\nprint(bacd.describe())\r\n\r\nsf = SymmetryFunctions(OgStructure(file_name='examples/structures/Li3PO4_mp-13725.cif'))\r\nprint(sf.describe())\r\n```\r\n\r\n## Genetic algorithms\r\n\r\nThe main purpose of `og` is to make complex artificial intelligence workflows easy to compose. Here is an example: running a genetic search for structures, where the structure optimization is performed using the M3GNET neural network model.\r\n\r\n```python\r\nfrom oganesson.genetic_algorithms import GA\r\nga = GA(species=['Na']*4 + ['H']*4)\r\nfor i in range(10):\r\n ga.evolve()\r\n```\r\n\r\n## Generation of the diffusion path for NEB calculations\r\n\r\nThe most painful part of doing transition state calculations in VASP is in building the images. The following code makes this happen in 2 lines of code. You only need to specify the structure file, and the atomic species you want to diffuse, and OgStructure will generate a folder for each path, and then write the POSCAR image files in each of these folders.\r\n\r\nIn the following example, we explore the possible Li diffusion paths in Li3PO4, given there are 6 Li atoms in the cell.\r\n\r\n```python\r\nfrom oganesson.ogstructure import OgStructure\r\nog = OgStructure(file_name='examples/structures/Li3PO4_mp-13725.cif')\r\nog.generate_neb('Li')\r\n```\r\nNote that the default value of `r`, which is 3, is sufficient for lithium systems. However, for the case of larger atoms such as Na, a larger value of `r` would be required.\r\n\r\n## Finding a reasonable adsorption site of an atom on a surface\r\n\r\n```python\r\nfrom oganesson.ogstructure import OgStructure\r\nog=OgStructure(file_name='examples/structures/MoS2.vasp')\r\nog.add_atom_to_surface('Li').structure.to('MoS2_Li.vasp','poscar')\r\n```\r\n",
"bugtrack_url": null,
"license": "mit",
"summary": "oganesson enables rapid AI workflows for material science and chemistry",
"version": "0.1.44",
"project_urls": {
"Homepage": "https://github.com/oganesson-ai/oganesson"
},
"split_keywords": [
"ai",
" machine learning",
" material science"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "331e28d47a8dea5e96826244870dbb5a8ed369baa0a617b2622c9f1211cf8115",
"md5": "ff6a6b94ca69117a1c399c9f40b4e6b5",
"sha256": "b824502de6836d277eb2f6e51ee43e857bce2bf4a2abd4880dfda254f3a8e14f"
},
"downloads": -1,
"filename": "oganesson-0.1.44-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff6a6b94ca69117a1c399c9f40b4e6b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1264583,
"upload_time": "2024-12-16T01:36:45",
"upload_time_iso_8601": "2024-12-16T01:36:45.843963Z",
"url": "https://files.pythonhosted.org/packages/33/1e/28d47a8dea5e96826244870dbb5a8ed369baa0a617b2622c9f1211cf8115/oganesson-0.1.44-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ccebed673a8ce0489da8a4f434cafbe2d1185f99488f3b02dbd8697194169c9",
"md5": "45b5636c641b232d44c15ba50025a171",
"sha256": "d700483d3b7d9a705874e698a46ceb146e062e53752b10a4311178f68b793654"
},
"downloads": -1,
"filename": "oganesson-0.1.44.tar.gz",
"has_sig": false,
"md5_digest": "45b5636c641b232d44c15ba50025a171",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1264029,
"upload_time": "2024-12-16T01:36:47",
"upload_time_iso_8601": "2024-12-16T01:36:47.911716Z",
"url": "https://files.pythonhosted.org/packages/1c/ce/bed673a8ce0489da8a4f434cafbe2d1185f99488f3b02dbd8697194169c9/oganesson-0.1.44.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 01:36:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oganesson-ai",
"github_project": "oganesson",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "oganesson"
}
JSON
