Metadata-Version: 2.1
Name: quacc
Version: 0.2.6
Summary: A platform to enable high-throughput, database-driven quantum chemistry and computational materials science
Author-email: "Andrew S. Rosen" <asrosen93@gmail.com>
Maintainer-email: "Andrew S. Rosen" <asrosen93@gmail.com>
License: BSD-3
Project-URL: repository, https://github.com/Quantum-Accelerators/quacc
Project-URL: documentation, https://quantum-accelerators.github.io/quacc/
Project-URL: changelog, https://github.com/Quantum-Accelerators/quacc/blob/main/CHANGELOG.md
Keywords: high-throughput,automated,workflow,dft
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: <3.12,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: ase
Requires-Dist: cclib >=1.8
Requires-Dist: custodian >=2023.6.5
Requires-Dist: emmet-core >=0.51.11
Requires-Dist: maggma >=0.51.18
Requires-Dist: monty >=2023.9.5
Requires-Dist: numpy >=1.24.0
Requires-Dist: pydantic <2
Requires-Dist: pymatgen >=2023.9.2
Requires-Dist: typer[rich] >=0.9.0
Provides-Extra: covalent
Requires-Dist: covalent <=0.226.0rc0 ; extra == 'covalent'
Requires-Dist: covalent-hpc-plugin >=0.0.2 ; extra == 'covalent'
Provides-Extra: defects
Requires-Dist: pymatgen-analysis-defects >=2023.8.22 ; extra == 'defects'
Requires-Dist: shakenbreak >=3.2.0 ; extra == 'defects'
Provides-Extra: dev
Requires-Dist: black >=23.7.0 ; extra == 'dev'
Requires-Dist: isort >=5.12.0 ; extra == 'dev'
Requires-Dist: pytest >=7.4.0 ; extra == 'dev'
Requires-Dist: pytest-cov >=3.0.0 ; extra == 'dev'
Requires-Dist: ruff >=0.0.285 ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: blacken-docs >=1.16.0 ; extra == 'docs'
Requires-Dist: mkdocs-material >=9.1.21 ; extra == 'docs'
Requires-Dist: mkdocstrings[python] >=0.22.0 ; extra == 'docs'
Requires-Dist: mkdocs-gen-files >=0.5.0 ; extra == 'docs'
Requires-Dist: mkdocs-literate-nav >=0.6.0 ; extra == 'docs'
Requires-Dist: pillow >=10.0.0 ; extra == 'docs'
Requires-Dist: cairosvg >=2.7.1 ; extra == 'docs'
Provides-Extra: jobflow
Requires-Dist: jobflow >=0.1.13 ; extra == 'jobflow'
Requires-Dist: fireworks >=2.0.3 ; extra == 'jobflow'
Provides-Extra: newtonnet
Requires-Dist: torch >=2.0.1 ; extra == 'newtonnet'
Requires-Dist: scikit-learn >=1.3.0 ; extra == 'newtonnet'
Provides-Extra: optimizers
Requires-Dist: sella >=2.3.2 ; extra == 'optimizers'
Provides-Extra: parsl
Requires-Dist: parsl >=2023.8.14 ; extra == 'parsl'
Provides-Extra: prefect
Requires-Dist: prefect >=2.10.18 ; extra == 'prefect'
Requires-Dist: prefect-dask >=0.2.4 ; extra == 'prefect'
Requires-Dist: dask-jobqueue >=0.8.2 ; extra == 'prefect'
Provides-Extra: redun
Requires-Dist: redun >=0.16.2 ; extra == 'redun'
Provides-Extra: tblite
Requires-Dist: tblite[ase] >=0.3.0 ; (platform_system == "Linux") and extra == 'tblite'

<div align="center">
  <img src=https://github.com/Quantum-Accelerators/quacc/blob/main/docs/images/quacc_logo_wide.png width="300"><br>
</div>

# quacc – The Quantum Accelerator 🦆

![tests](https://github.com/quantum-accelerators/quacc/actions/workflows/tests.yaml/badge.svg)
[![codecov](https://codecov.io/gh/Quantum-Accelerators/quacc/branch/main/graph/badge.svg?token=OJaOZAH30u)](https://codecov.io/gh/Quantum-Accelerators/quacc)
[![DeepSource](https://app.deepsource.com/gh/Quantum-Accelerators/quacc.svg/?label=active+issues&token=Y1NxOLIuFFEqWdjawIYnJNde)](https://app.deepsource.com/gh/Quantum-Accelerators/quacc/?ref=repository-badge)
![PyPI - Version](https://img.shields.io/pypi/v/quacc?color=blue)
![Python - Version](https://img.shields.io/pypi/pyversions/quacc)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7720998.svg)](https://doi.org/10.5281/zenodo.7720998)

Quacc is a flexible and extensible platform for high-throughput computational materials science and quantum chemistry maintained by the [Rosen Research Group](https://rosen.cbe.princeton.edu/) at Princeton University.

The three main goals of quacc are to:

1. Reduce the barrier for running complex, mixed-code workflows for molecules and materials across distributed compute environments.

2. Promote rapid workflow development and testing via modern [workflow management solutions](https://workflows.community/).

3. Enable a seamless interface between the [Atomic Simulation Environment](https://wiki.fysik.dtu.dk/ase/) and the software infrastructure powering the [Materials Project](https://materialsproject.org).

Quacc currently has [pre-made recipes](https://quantum-accelerators.github.io/quacc/user/recipes/recipes_list.html) for the following packages: DFTB+, Gaussian, GULP, NewtonNet, ORCA, Psi4, Q-Chem, tblite, and VASP. It's simple to add your favorite!

## Documentation

<p align="center">
  📖 <a href="https://quantum-accelerators.github.io/quacc/"><b><i>Learn More Here!</i></b></a> 📖
</p>

Includes the following sections:

- 🏎️ [Quick Start](https://quantum-accelerators.github.io/quacc/start/demo.html)
- 🔧 [Installation Guide](https://quantum-accelerators.github.io/quacc/install/install.html)
- 🧠 [User Guide](https://quantum-accelerators.github.io/quacc/user/recipes/recipes_intro.html)
- 🤝 [Developer Guide](https://quantum-accelerators.github.io/quacc/dev/contributing.html)

## Demonstration ✨

🚀 Demo from the Quick Start guide, using [Covalent](https://github.com/AgnostiqHQ/covalent) as one of the [several supported workflow managers](https://quantum-accelerators.github.io/quacc/user/basics/wflow_overview.html).

![](https://github.com/Quantum-Accelerators/quacc/blob/main/docs/images/start/start.gif)

## Citation

If you use quacc in your work, please cite it as follows:

- quacc – The Quantum Accelerator, https://doi.org/10.5281/zenodo.7720998.

## License ⚖️

Quacc is released under a [BSD 3-Clause license](https://github.com/quantum-accelerators/quacc/blob/main/LICENSE.md).
