Sovereign 8s.is mirror of standardgalactic/rxn-ca
  • Jupyter Notebook 91.8%
  • Python 8.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-03-15 22:15:58 -07:00
data improve enumerate script 2023-12-21 15:24:22 -08:00
docs UPdate lockfile and fix out of date guide 2026-03-15 22:15:01 -07:00
guides Merge branch 'master' of github.com:mcgalcode/rxn-ca into feature/optim 2026-03-04 16:26:21 -08:00
src/rxn_ca Add CLI entrypoint for precursor set generation 2026-03-13 15:35:58 -07:00
tests update precuros rseelctino for optimizations 2026-03-04 16:25:18 -08:00
.gitignore Add basic usage guide 2025-01-20 14:11:19 -08:00
CHANGELOG.md init 2022-10-21 11:18:04 -07:00
CODE_OF_CONDUCT.md init 2022-10-21 11:18:04 -07:00
CONTRIBUTING.md init 2022-10-21 11:18:04 -07:00
LICENSE Update License 2024-02-12 16:59:37 -08:00
mkdocs.yml Massive update to documentation 2026-03-15 22:10:14 -07:00
pyproject.toml Massive update to documentation 2026-03-15 22:10:14 -07:00
README.md Massive update to documentation 2026-03-15 22:10:14 -07:00
setup.cfg init 2022-10-21 11:18:04 -07:00
setup.py Merge branch 'master' of github.com:mcgalcode/rxn-ca into feature/optim 2026-03-04 16:26:21 -08:00
uv.lock UPdate lockfile and fix out of date guide 2026-03-15 22:15:01 -07:00

rxn-ca

A lattice model for simulating solid state reactions.

Documentation

Overview

rxn-ca is a Python library for predicting the outcome of solid-state synthesis reactions using a cellular automaton approach. It uses thermodynamic data from the Materials Project to enumerate possible reactions and simulate phase evolution during synthesis.

Installation

git clone https://github.com/mcgalcode/rxn-ca.git
cd rxn-ca
pip install -e .

For optional features:

pip install -e ".[optimization]"  # Bayesian/genetic optimization
pip install -e ".[workflow]"      # Jobflow integration
pip install -e ".[vis]"           # Visualization tools

Quick Start

from rxn_ca.core.recipe import ReactionRecipe
from rxn_ca.core.heating import HeatingSchedule, HeatingStep

# Define reactants (mole ratios)
reactants = {"MgO": 1, "Al2O3": 1}

# Create heating schedule
heating_schedule = HeatingSchedule.build(
    HeatingStep.sweep(500, 1600, stage_length=1, temp_step_size=50),
    HeatingStep.hold(1600, stage_length=20)
)

# Create recipe
recipe = ReactionRecipe(
    reactant_amounts=reactants,
    heating_schedule=heating_schedule
)

Documentation

Full documentation is available at mcgalcode.github.io/rxn-ca

Requirements

License

BSD-3-Clause