Metadata-Version: 2.4
Name: scatter-cli
Version: 0.3.1
Summary: Software for the generation and analysis of synthetic fractal aggregates
Author: Krzysztof Skorupski
License-Expression: AGPL-3.0-or-later
Project-URL: Homepage, https://github.com/light-scattering/scattering.core
Project-URL: Changelog, https://github.com/light-scattering/scattering.core/blob/master/CHANGELOG.md
Project-URL: Repository, https://github.com/light-scattering/scattering.core.git
Project-URL: Author ORCID, https://orcid.org/0000-0002-4833-2819
Keywords: morphological analysis,computational physics,fractal aggregates,light scattering
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# scatter-cli

This is the official Python command-line wrapper for the `scattering.core` scientific Java library.

It provides a convenient way to install and execute the CLI directly from your Python environment or terminal using `pip`.

## Requirements

Because this package bundles and delegates commands to the underlying Java executable, you must have a **Java Runtime Environment** (version 21 or higher) installed and accessible in your system's `PATH`.

## Installation

You can install the CLI directly from PyPI:
```bash
pip install scatter-cli
```

## Usage

Once installed, the `scatter-cli` command is globally available in your terminal. You can pass any standard arguments directly to it:
```bash
scatter-cli --help
```

## Documentation

This Python package is a thin wrapper maintained as part of the larger `scattering.core` repository. For comprehensive documentation, algorithmic details, and advanced usage examples, please refer to:

* **[Project Documentation](https://github.com/light-scattering/scattering.core/blob/master/README.md)**
* **[CLI-Specific Documentation](https://github.com/light-scattering/scattering.core/blob/master/eu.scattering.cli/README.md)**

## License

This project is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**.
