Metadata-Version: 2.4
Name: msptools
Version: 0.1.3
Summary: Tools for Optical Forces Calculation in Multiple Scattering Problems
Author-email: Joan ronquillo <joan.ronquillo@uam.es>
License: The MIT License (MIT)
        
        Copyright (c) <year> Joan Ronquillo
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: refractiveindex>=1.0.2
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Provides-Extra: gpu
Requires-Dist: cupy; extra == "gpu"
Provides-Extra: plotting
Requires-Dist: matplotlib; extra == "plotting"
Dynamic: license-file

<p align="center">
  <img src="assets/logo_1_white.svg" alt="Project Logo" width="200">
</p>

## Overview

**msptools** is a collection of utilities and scripts designed to facilitate the analysis and processing of Optical Forces in plasmonic particle systems characterized by the Multiple Scattering Problem (MSP). 

## Features

- 

## Requirements
- Python 3.10 or higher
- pip 26.0 or higher

## Installation

To install the package use pip:

```bash
pip install msptools
```

If you want to install the cupy GPU-accelerated version, use:

```bash
pip install msptools[gpu]
```

## Usage

Basic usage example:

## License

This project is liscensed under the MIT License

## Documentation

Further documentation can be found in: https://msptools.readthedocs.io/en/latest/#msptools

## Contact

For questions, issues, or discussions, please use the GitHub Issues page.

![PyPI](https://img.shields.io/pypi/v/msptools)
![Python](https://img.shields.io/pypi/pyversions/msptools)

