Skip to main content

A toolkit for LAMMPS reaction modeling within MuPT

Project description

AutoREACTER

AutoREACTER is a Python-based toolkit for automating reaction-based molecular system generation for LAMMPS workflows. It is developed as part of the Multiscale Polymer Toolkit (MuPT).

Status: AutoREACTER is currently in v0.2-beta and under active development. APIs, configuration schemas, reaction libraries, and core functionality may change without notice.

Documentation

Full documentation is available at:

autoreacter.org

The documentation includes installation instructions, input configuration, supported reactions, supported force fields, cleanup utilities, and developer API references.

Current reaction support

AutoREACTER currently supports beta-stage step-growth polycondensation workflows for:

Polyesterification

  • Hydroxy-carboxylic acid polycondensation
  • Hydroxy acid halide polycondensation
  • Diol + di-acid halide polycondensation
  • Diol + di-carboxylic acid polycondensation

Polyamidation

  • Amino acid polycondensation
  • Diamine + di-carboxylic acid polycondensation
  • Diamine + di-carboxylic acid halide polycondensation

For the detailed functional-group mapping and reaction rules, see the supported reactions documentation.

Installation

Clone the repository:

git clone https://github.com/NanoCIPHER-Lab/AutoREACTER.git
cd AutoREACTER

Create and activate the recommended Conda environment:

conda create -n autoRX -y -c conda-forge python=3.13 numpy pandas rdkit ipykernel networkx
conda activate autoRX

Install AutoREACTER in editable mode:

python -m pip install -U pip
python -m pip install -e .

AutoREACTER also requires LUNAR for atom typing. See the getting started documentation for setup details.

Quick start

Run AutoREACTER with a JSON input file:

python AutoREACTER.py -i path/to/input.json

or:

python AutoREACTER.py --input path/to/input.json

Example:

python AutoREACTER.py -i examples/example_1_inputs_ratio_mode.json

View available commands and options:

python AutoREACTER.py --help

Interactive notebook workflow

AutoREACTER can also be used through Jupyter notebooks for an interactive, visual, step-by-step workflow. This mode is recommended for inspecting monomers, functional groups, reaction templates, and generated LAMMPS setup files before running larger workflows.

See the examples directory for notebooks and usage notes:

examples/README.md

Cleanup utility

Delete cached runs older than a given number of days:

python AutoREACTER.py --cleanup 30

Delete all cached runs:

python AutoREACTER.py --cleanup all

Short flags are also available:

python AutoREACTER.py -c 30
python AutoREACTER.py -c all

Help and support

If you find a bug, need a new reaction type, or want to request additional force-field support, please open an issue:

AutoREACTER Issues

License

AutoREACTER is released under the MIT License. See LICENSE for details.

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

autoreacter-0.2b1.tar.gz (92.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autoreacter-0.2b1-py3-none-any.whl (110.7 kB view details)

Uploaded Python 3

File details

Details for the file autoreacter-0.2b1.tar.gz.

File metadata

  • Download URL: autoreacter-0.2b1.tar.gz
  • Upload date:
  • Size: 92.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for autoreacter-0.2b1.tar.gz
Algorithm Hash digest
SHA256 7bd903bc84379e614803afced880f2fba5f0cdabfb6adc8ef5533331aba4929a
MD5 122d66158c93a1e7e39bafad61ea5f66
BLAKE2b-256 9eb55163f31f35c9e065fe4f20e9dd656275c284544833daae7194764f3a6fe7

See more details on using hashes here.

File details

Details for the file autoreacter-0.2b1-py3-none-any.whl.

File metadata

  • Download URL: autoreacter-0.2b1-py3-none-any.whl
  • Upload date:
  • Size: 110.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for autoreacter-0.2b1-py3-none-any.whl
Algorithm Hash digest
SHA256 c5e8d587c43c1932dfcf0c6a39c15b6bfb2b8708ecda9feac0b1ae8f5cecdbb7
MD5 ece0e120904fa19c8cee87182868718d
BLAKE2b-256 afc67c6e08dcac0d04389fa09336ba01bdeb97767bc7876634f9fcf1ec0fe2da

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page