Metadata-Version: 2.4
Name: amorphouspy
Version: 0.5.2
Summary: Workflows for atomistic modeling of oxide glasses
Author-email: Achraf Atila <achraf.atila@bam.de>, Marcel Sadowski <marcel.sadowski@schott.com>, Jan Janssen <janssen@mpie.de>, Leopold Talirz <leopold.talirz@schott.com>
License: BSD 3-Clause License
        
        Copyright (c) 2025, glasagent
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: ase
Requires-Dist: lammpsparser
Requires-Dist: networkx
Requires-Dist: numba
Requires-Dist: pandas
Requires-Dist: pymatgen
Requires-Dist: scikit-image
Requires-Dist: scipy
Provides-Extra: api
Requires-Dist: executorlib; extra == 'api'
Requires-Dist: fastapi; extra == 'api'
Requires-Dist: jinja2; extra == 'api'
Requires-Dist: mcp>=1.6.0; extra == 'api'
Requires-Dist: pysqa; extra == 'api'
Requires-Dist: sqlalchemy; extra == 'api'
Requires-Dist: uvicorn; extra == 'api'
Provides-Extra: executorlib
Requires-Dist: executorlib; extra == 'executorlib'
Description-Content-Type: text/markdown

# amorphouspy

[![PyPI](https://img.shields.io/pypi/v/amorphouspy)](https://pypi.org/project/amorphouspy/)
[![Documentation](https://img.shields.io/badge/docs-glasagent.github.io-blue)](https://glasagent.github.io/amorphouspy/)
[![codecov](https://codecov.io/gh/glasagent/amorphouspy/graph/badge.svg)](https://codecov.io/gh/glasagent/amorphouspy)

    amorphouspy logo

> [!WARNING]
> This project is under active development and is **not yet ready for production use**. APIs and functionality may change without notice. Contributions and feedback are very welcome — feel free to [open an issue](https://github.com/glasagent/amorphouspy/issues) or submit a pull request!

A Python package for atomistic simulations of glasses.

`amorphouspy` provides capabilities in the form of Python functions from generating initial structural models through running molecular dynamics simulations with LAMMPS, all the way to computing material properties and performing detailed structural analysis.

`amorphouspy_api` strings these Python functions together to end-to-end workflows using `executorlib`. It then exposes these workflows through web endpoints, which can e.g. be used by an agent powered by a large language model.

Find the documentation at **[glasagent.github.io/amorphouspy](https://glasagent.github.io/amorphouspy)**.

## Key Features

`amorphouspy`

- **Structure Generation**: Create random oxide glass structures from composition dicts (e.g. `{"SiO2": 75, "Na2O": 15, "CaO": 10}`) with automatic density estimation using Fluegel's empirical model.
- **Interatomic Potentials**: Built-in support for PMMCS (Pedone), BJP (Bouhadja), and SHIK (Sundararaman) classical force fields with automatic LAMMPS input generation. Support for machine-learning interatomic potentials will come later.
- **Melt-Quench Simulations**: Multi-stage heating/cooling protocols with potential-specific temperature programs and ensemble control.
- **Structural Analysis**: RDFs, coordination numbers, Qn distributions, bond angle distributions, ring statistics, cavity analysis.
- **Property Calculations**: Elastic moduli (stress-strain finite differences), viscosity (Green-Kubo formalism), coefficient of thermal expansion (NPT fluctuations).

`amorphouspy_api`

- **End-to-end Workflows**: Submit a composition, get back the glass structure and all of its predicted properties
- **Job management API**: Fully fledged job management API, including results database
- **Visualization**: Interactive Plotly-based visualizations of glass structure and properties




## Installation

Install the bleeding edge version via
```bash
# Install pixi (if not already installed)
curl -fsSL https://pixi.sh/install.sh | bash

# Clone repo and install environment from PyPI/conda-forge
git clone https://github.com/glasagent/amorphouspy.git
cd amorphouspy
pixi install
```

You can also install the `amorphouspy` package into existing environments from PyPI or conda-forge,
see the [Installation guide](https://glasagent.github.io/amorphouspy/how_to_guides/installation) for details.

## Quick Start

See the [Tutorial](https://glasagent.github.io/amorphouspy/tutorial) for a step-by-step introduction.

## Authors

Developed at the [Bundesanstant für Materialforschung und -prüfung (BAM)](https://www.bam.de/Navigation/EN) in collaboration with [SCHOTT AG](https://www.schott.com/) and the [Max Planck Institute for Sustainable Materials](https://www.mpie.de/en).

- **Achraf Atila** — BAM — Core framework, analysis tools, potentials
- **Marcel Sadowski** — Schott AG — CTE simulation module
- **Jan Janssen** — MPIE — pyiron integration, lammpsparser
- **Leopold Talirz** — Schott AG — API layer, project coordination

## Acknowledgement

Supported by the [Federal Ministry of Research, Technology and Space](https://www.bmftr.bund.de/EN) via the [GlasAgent MaterialDigital 3 project](https://www.materialdigital.de/project/28).

     
  
     

## License

BSD 3-Clause. See [LICENSE](LICENSE).

