# 
Reaction Network (`rxn_network`) is a Python package for synthesis planning and predicting chemical reaction pathways in inorganic materials synthesis.
## Installation
We recommend installing using pip:
```properties
pip install -U reaction-network
```
The package will then be installed under the name `rxn_network`. The Materials Project
API is not installed by default; to install it, run: `pip install -U mp-api`.
> **Note**
> As of version 7.0 and beyond, the `reaction-network` package no longer uses `graph-tool`. All network functionality is now implemented using `rustworkx`. This means it is no longer required to complete any extra installations.
## Tutorials
The `examples` folder contains two (2) demonstration notebooks:
- **1_enumerators.ipynb**: how to enumerate reactions from a set of entries; running
enumerators using jobflow
- **2_networks.ipynb**: how to build reaction networks from a list of enumerators and
entries; how to perform pathfinding to recommend balanced reaction pathways; running
reaction network analysis using jobflow
## Citation
If you use this code in your work, please consider citing the following paper (see
`CITATION.bib`):
> McDermott, M. J., Dwaraknath, S. S., and Persson, K. A. (2021). A graph-based network
> for predicting chemical reaction pathways in solid-state materials synthesis. Nature
> Communications, 12(1). <https://doi.org/10.1038/s41467-021-23339-x>
## Acknowledgements
This work was supported as part of GENESIS: A Next Generation Synthesis Center, an
Energy Frontier Research Center funded by the U.S. Department of Energy, Office of
Science, Basic Energy Sciences under Award Number DE-SC0019212.
Learn more about the GENESIS EFRC here: <https://www.stonybrook.edu/genesis/>
Raw data
{
"_id": null,
"home_page": "",
"name": "reaction-network",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "reaction,network,computational,graph,inorganic,materials,retrosynthesis,synthesis,planning",
"author": "",
"author_email": "Matthew McDermott <mcdermott@lbl.gov>",
"download_url": "https://files.pythonhosted.org/packages/fc/8d/c7ec48b98a73d29b6afd6aff64dcadc3fd2f74b452af4e2691da9a850461/reaction-network-8.2.1.tar.gz",
"platform": null,
"description": "# \n\n\n\n\n\n\n\n\nReaction Network (`rxn_network`) is a Python package for synthesis planning and predicting chemical reaction pathways in inorganic materials synthesis.\n\n## Installation\n\nWe recommend installing using pip:\n\n```properties\npip install -U reaction-network\n```\n\nThe package will then be installed under the name `rxn_network`. The Materials Project\nAPI is not installed by default; to install it, run: `pip install -U mp-api`.\n\n> **Note**\n> As of version 7.0 and beyond, the `reaction-network` package no longer uses `graph-tool`. All network functionality is now implemented using `rustworkx`. This means it is no longer required to complete any extra installations.\n\n## Tutorials\n\nThe `examples` folder contains two (2) demonstration notebooks:\n\n- **1_enumerators.ipynb**: how to enumerate reactions from a set of entries; running\n enumerators using jobflow\n- **2_networks.ipynb**: how to build reaction networks from a list of enumerators and\n entries; how to perform pathfinding to recommend balanced reaction pathways; running\n reaction network analysis using jobflow\n\n## Citation\n\nIf you use this code in your work, please consider citing the following paper (see\n`CITATION.bib`):\n\n> McDermott, M. J., Dwaraknath, S. S., and Persson, K. A. (2021). A graph-based network\n> for predicting chemical reaction pathways in solid-state materials synthesis. Nature\n> Communications, 12(1). <https://doi.org/10.1038/s41467-021-23339-x>\n\n## Acknowledgements\n\nThis work was supported as part of GENESIS: A Next Generation Synthesis Center, an\nEnergy Frontier Research Center funded by the U.S. Department of Energy, Office of\nScience, Basic Energy Sciences under Award Number DE-SC0019212.\n\nLearn more about the GENESIS EFRC here: <https://www.stonybrook.edu/genesis/>\n",
"bugtrack_url": null,
"license": "modified BSD",
"summary": "Reaction-network is a Python package for synthesis planning and predicting chemical reaction pathways in inorganic materials synthesis.",
"version": "8.2.1",
"project_urls": {
"changelog": "https://github.com/materialsproject/reaction-network/blob/main/docs/CHANGELOG.md",
"documentation": "https://materialsproject.github.io/reaction-network/",
"homepage": "https://materialsproject.github.io/reaction-network/",
"repository": "https://github.com/materialsproject/reaction-network"
},
"split_keywords": [
"reaction",
"network",
"computational",
"graph",
"inorganic",
"materials",
"retrosynthesis",
"synthesis",
"planning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d5063d2b72e0d122be0b32c83741c279d7e33e5426bfcfeff52803176b0b6a0e",
"md5": "90e43409422dcbbc78e22209765231a2",
"sha256": "5b329ddeb75032045e6b71a678bdedfc2c7064d3dee84dd80575386c6750c37a"
},
"downloads": -1,
"filename": "reaction_network-8.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90e43409422dcbbc78e22209765231a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 577821,
"upload_time": "2024-02-07T20:07:40",
"upload_time_iso_8601": "2024-02-07T20:07:40.153848Z",
"url": "https://files.pythonhosted.org/packages/d5/06/3d2b72e0d122be0b32c83741c279d7e33e5426bfcfeff52803176b0b6a0e/reaction_network-8.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc8dc7ec48b98a73d29b6afd6aff64dcadc3fd2f74b452af4e2691da9a850461",
"md5": "66e0a1a6b8952d231a46dd992a79c0af",
"sha256": "af4f8cb691032893ad122d73bdd4082621fed9ab6e6738d76f49837cb4a04707"
},
"downloads": -1,
"filename": "reaction-network-8.2.1.tar.gz",
"has_sig": false,
"md5_digest": "66e0a1a6b8952d231a46dd992a79c0af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 555899,
"upload_time": "2024-02-07T20:07:43",
"upload_time_iso_8601": "2024-02-07T20:07:43.773837Z",
"url": "https://files.pythonhosted.org/packages/fc/8d/c7ec48b98a73d29b6afd6aff64dcadc3fd2f74b452af4e2691da9a850461/reaction-network-8.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-07 20:07:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "materialsproject",
"github_project": "reaction-network",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "reaction-network"
}
JSON
