Metadata-Version: 2.4
Name: particle-pack-tools
Version: 0.0.15
Summary: A toolkit for processing and visualizing particle pack data.
Author-email: Bogong Wang <bogongwang.dev@outlook.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/bogongwang/particle-pack-tools
Project-URL: Repository, https://github.com/bogongwang/particle-pack-tools
Keywords: particle pack,tools,visualization,data processing,particle pack
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: xarray>=2025.1
Requires-Dist: dask[complete]>=2025.1
Requires-Dist: netCDF4>=1.7.2
Requires-Dist: scikit-image>=0.25.0
Requires-Dist: scipy>=1.15.0
Requires-Dist: numpy>=1.25.0
Requires-Dist: numba>=0.60.0
Requires-Dist: matplotlib>=3.10.0
Requires-Dist: zarr>=3.1.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=7.0; extra == "test"
Dynamic: license-file

# Particle Pack Tools

## Installation
To install the package, run:
```
pip install particle-pack-tools
```

## Usage

### Dataset I/O
Load particle pack datasets using:
```
from pptools.io import load_nc, load_nc_arr
```

### Dataset Preprocessing
Preprocess particle pack datasets with:
```
from pptools.preprocess import crop_3d
# ...additional preprocessing functions...
```

### Dataset Visualization
Visualize particle pack datasets using the `Visualizer` class:
```
from pptools.visualize import Visualizer

# Initialize the visualizer
vis = Visualizer()

# Plot a tomogram
vis.plot_tomo(tomo_img)
vis.show()

# Plot a multi-label mask
vis.plot_mask(mask_img)
vis.show()
```

---

Feel free to report any issues or share suggestions to help improve this toolkit.
