Metadata-Version: 2.4
Name: pyiron_workflow_atomistics
Version: 0.0.4
Summary: A pyiron module for atomistic simulation workflows
Author-email: pyiron team <pyiron@mpie.de>
License: BSD 3-Clause License
        
        Copyright (c) 2024, Max-Planck-Institut für Nachhaltige Materialien GmbH - Computational Materials Design (CM) Department
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * 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.
        
        * 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.
        
Project-URL: Homepage, https://pyiron.org/
Project-URL: Documentation, https://pyiron_workflow_atomistics.readthedocs.io
Project-URL: Repository, https://github.com/pyiron/pyiron_workflow_atomistics
Keywords: pyiron,atomistics,workflow
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: <3.14,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<1.27.0,>=1.22.0
Requires-Dist: pandas<2.4.0,>=1.3.0
Requires-Dist: matplotlib<3.11.0,>=3.10.6
Requires-Dist: ase<3.27.0,>=3.21.0
Requires-Dist: scipy<1.17.0,>=1.4.0
Requires-Dist: pyiron-workflow<=0.15.2,>=0.14.1
Requires-Dist: pymatgen<2025.7.0,>=2024.8.8
Requires-Dist: pyiron_snippets<=0.2.0,>=0.1.0
Requires-Dist: scikit-learn<1.8.0,>=1.0.0
Dynamic: license-file

# pyiron_workflow_atomistics

## Overview

This repository contains a pyiron module for atomistic simulation workflows, providing tools and utilities for working with atomic structures, grain boundaries, and various atomistic calculations.

## Features

- **Grain Boundary Analysis**: Tools for analyzing and manipulating grain boundaries, including:
  - GB plane detection and analysis
  - Cleavage plane identification
  - Structure manipulation for GB studies

- **Structure Manipulation**: Utilities for working with atomic structures:
  - Bulk structure handling
  - Structure featurization
  - Calculator integration

- **Workflow Integration**: Seamless integration with pyiron workflow system for:
  - Automated structure calculations
  - Data processing and analysis
  - Results visualization

## Installation

The package can be installed via pip:

```bash
pip install pyiron_workflow_atomistics
```

Or via conda:

```bash
conda install -c conda-forge pyiron_workflow_atomistics
```

## Dependencies

The package requires:
- Python >= 3.9, < 3.13
- numpy < 2.0.0
- pandas >= 1.3.0
- matplotlib >= 3.4.0
- ase >= 3.22.0
- scipy >= 1.7.0
- pyiron_workflow
- pymatgen >= 2024.8.8
- pyiron_snippets
- scikit-learn >= 1.0.0

## Usage

### Grain Boundary Analysis

```python
from pyiron_workflow_atomistics.gb.analysis import find_GB_plane
from pyiron_workflow_atomistics.gb.cleavage import cleave_gb_structure

# Find GB plane in a structure
gb_info = find_GB_plane(atoms, featuriser, axis="c")

# Cleave structure at GB
cleaved_structures, cleavage_planes = cleave_gb_structure(
    base_structure=atoms,
    axis_to_cleave="c",
    target_coord=target_coord
)
```

### Structure Calculations

```python
from pyiron_workflow_atomistics.calculator import calculate_structure_node

# Run structure calculations
results = calculate_structure_node(
    structure=atoms,
    calc=calculator,
    output_dir="calculations"
)
```

## Documentation

For detailed documentation, visit our [ReadTheDocs page](https://pyiron_workflow_atomistics.readthedocs.io).

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.rst) for details.

## License

This project is licensed under the BSD License - see the [LICENSE](LICENSE) file for details.

## Citation

If you use this package in your research, please cite:

```bibtex
@software{pyiron_workflow_atomistics,
  author = {pyiron team},
  title = {pyiron_workflow_atomistics},
  year = {2024},
  url = {https://github.com/pyiron/pyiron_workflow_atomistics}
}
```
