Skip to main content

Reaction-network is a Python package for predicting likely inorganic chemical reaction pathways using graph theory.

Reason this release was yanked:

improper release

Project description

Reaction Network

Pytest Status Code Coverage

Reaction network (rxn-network) is a Python package for predicting chemical reaction pathways in solid-state materials synthesis using combinatorial and graph-theorteical methods.

Installation directions

The rxn-network package has several dependencies, most of which can be installed through PyPI. However, graph-tool must be installed through a more customized method; please see https://graph-tool.skewed.de/ for more details. We recommend the following installation procedure which creates a new conda environment with Python 3.9, activates it, and then installs graph-tool through conda-forge.

conda create -n gt python=3.9
conda activate gt
conda install -c conda-forge graph-tool

Reaction network can then simply be installed via pip:

pip install reaction-network

For developers:

To install an editable version of the rxn-network code, simply clone the code from this repository, navigate to its directory, and then run the following command to install the requirements:

pip install -r requirements.txt
pip install -e .

Note that this only works if the repository is cloned from GitHub, such that it contains the proper metadata.

Tutorial notebooks

The notebooks folder contains two (2) demonstration notebooks:

  • enumerators.ipynb: how to enumerate reactions from a set of entries; running enumerators using Fireworks
  • network.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 Fireworks

Citation

If you use this code or Python package in your work, please consider citing the following paper:

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/

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

reaction-network-6.0.0.tar.gz (8.5 MB view details)

Uploaded Source

Built Distribution

reaction_network-6.0.0-py3-none-any.whl (97.6 kB view details)

Uploaded Python 3

File details

Details for the file reaction-network-6.0.0.tar.gz.

File metadata

  • Download URL: reaction-network-6.0.0.tar.gz
  • Upload date:
  • Size: 8.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for reaction-network-6.0.0.tar.gz
Algorithm Hash digest
SHA256 4751db770588549af31194dd859fb2789d19c56fd9abe1b2b7d0fce06a143694
MD5 686926f45aa82b78e3e12ff9185f0a2e
BLAKE2b-256 c9f5358136766ced243583fca53385c406e6da41005cf01f2ecd6e2fe5e1e227

See more details on using hashes here.

File details

Details for the file reaction_network-6.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for reaction_network-6.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb467275b4227d6b0d0701c98660c23f2b8e5e5104a9669c2bc1f387808d04cc
MD5 fd54dd6c5dc945cf46c125998acfd1ba
BLAKE2b-256 8492658809feb7491d5a7f3148bc68424937e96dd0f2e66da996ef242f92d25d

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