Skip to main content

PyAR: Python program for Aggregation and Reaction

Project description

PyAR

PyAR is a chemistry-focused structure-search package for aggregation, reaction discovery, solvation growth, and bond scans.

Install

python -m pip install pyar-chem

Quick Start

pyar-cli --help
pyar-cli -a C H -as 1 4 -N 8
pyar-cli react A.xyz B.xyz -N 8 -gmin 100 -gmax 1000 --software xtb
pyar-cli solvate solute.xyz solvent.xyz --software xtb -ss 10 -N 16

Supported Workflows

  • aggregate for clusters, aggregates, and noncovalent complexes
  • react for AFIR-style reaction searches between two reactants
  • solvate for microsolvation, ligand addition, and growth around a core
  • scan-bond for a simple bond-distance probe
  • pyar-reaction-trace for reaction-trace analysis

External Program Requirements

Some workflows rely on external executables such as xTB, ORCA, Gaussian, Psi4, MOPAC, Turbomole, OpenBabel, MLatom, and DFT-D4. The optional extras install Python dependencies only; they do not bundle large model or vendor files into the main pyar-chem wheel. AIMNet2 .jpt models, AIQM1 .pt models, and vendored MLatom binaries must come from the upstream project or another separate model/package source. See docs/external_programs.rst for the official project websites and installation notes.

Documentation

Full documentation: docs/ and https://pyar.readthedocs.io/ Changelog: CHANGELOG.md

Citation

If you use PyAR, cite the paper that matches your chemistry problem. See docs/publications.rst for the current publication map. For general cluster-building use, start with:

  • Nandi et al., Computational and Theoretical Chemistry 1111, 69-81 (2017)
  • Khatun et al., Frontiers in Chemistry 7:644 (2019)

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

pyar_chem-1.1.1.tar.gz (386.8 kB view details)

Uploaded Source

Built Distribution

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

pyar_chem-1.1.1-py3-none-any.whl (411.6 kB view details)

Uploaded Python 3

File details

Details for the file pyar_chem-1.1.1.tar.gz.

File metadata

  • Download URL: pyar_chem-1.1.1.tar.gz
  • Upload date:
  • Size: 386.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyar_chem-1.1.1.tar.gz
Algorithm Hash digest
SHA256 06ce03f5f9c51042ffe7dc84af0f3a9f2624887daf3a1c5424e446d689cb186b
MD5 d894208f53b810c26cc7bd9797269df8
BLAKE2b-256 74de937aeaedb7f3b24f1bc985cccaeb10508ba3507bec3644b570f2ed2d791e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyar_chem-1.1.1.tar.gz:

Publisher: publish.yml on anooplab/pyar

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyar_chem-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: pyar_chem-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 411.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyar_chem-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6c7969ed1258a2992feb270a31e195ba8a09c3ea12167688c8d2fcdb80d4705f
MD5 915ed39f757a5bb45817f171489f88ae
BLAKE2b-256 06a29f11967d42e17d3fb33c4e9ea3255415c3e8c3bb44588c0363fe398b5661

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyar_chem-1.1.1-py3-none-any.whl:

Publisher: publish.yml on anooplab/pyar

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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