Metadata-Version: 2.1
Name: slagg
Version: 0.1
Summary: A tool for generating optimized decompositions of gridded geometries for simulation
Home-page: https://github.com/JarrodLeddy/slagg
Author: Jarrod Leddy
Author-email: jleddy@txcorp.com
License: MIT
Project-URL: Source, https://github.com/JarrodLeddy/slagg
Project-URL: Tracker, https://github.com/JarrodLeddy/slagg/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy (>=1.8)
Requires-Dist: scipy (>=1.6.3)
Requires-Dist: matplotlib (>=3.4.2)
Requires-Dist: numpy-stl (>=3.0)
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: docs
Requires-Dist: sphinx (>=4.0.2) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest (>=3.3.0) ; extra == 'tests'
Requires-Dist: pytest-cov (>=3.0.0) ; extra == 'tests'

# SLAGG - Simplified Load-balancing Algorithm for General Geometries

<!---
[![Documentation Status](https://readthedocs.org/projects/inference-tools/badge/?version=stable)](https://inference-tools.readthedocs.io/en/stable/?badge=stable)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/inference-tools?color=purple)](https://pypi.org/project/inference-tools/)
[![DOI](https://zenodo.org/badge/149741362.svg)](https://zenodo.org/badge/latestdoi/149741362)
-->
[![GitHub license](https://img.shields.io/github/license/JarrodLeddy/slagg)](https://github.com/JarrodLeddy/slagg/blob/main/LICENSE)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/slagg)

This package provides a set of Python-based tools for creating load-balanced
domain decompositions that can be used for numerical simulations.

## Features

 - Ability to specify Grid, Geometry as STL, and desired Decomp slabs
 
 - Basic Decomposition can be augmented with refinements to load-balance and reduce memory usage

## Installation

slagg is available from [PyPI](https://pypi.org/project/slagg/), 
so can be easily installed using [pip](https://pip.pypa.io/en/stable/) as follows:
```bash
pip install slagg
```

## Documentation
<!---
Full documentation is available at [inference-tools.readthedocs.io](https://inference-tools.readthedocs.io/en/stable/).
-->
