Metadata-Version: 2.4
Name: mnpbem-help
Version: 0.1.1
Summary: Reference and educational helper interfaces for MNPBEM Python users.
Author-email: GALIH RIDHO UTOMO <g4lihru@students.unnes.ac.id>
License-Expression: GPL-2.0-only
Project-URL: Homepage, https://pypi.org/project/mnpbem-help/
Project-URL: Repository, https://github.com/galihru/mnpbem/tree/main/mnpbem-help
Project-URL: Source, https://github.com/galihru/mnpbem
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy>=1.24

# mnpbem-help

[![PyPI version](https://img.shields.io/pypi/v/mnpbem-help.svg)](https://pypi.org/project/mnpbem-help/)
[![Python versions](https://img.shields.io/pypi/pyversions/mnpbem-help.svg)](https://pypi.org/project/mnpbem-help/)
[![Publish mnpbem-help](https://github.com/galihru/mnpbem/actions/workflows/mnpbemhelp.yml/badge.svg)](https://github.com/galihru/mnpbem/actions/workflows/mnpbemhelp.yml)

`mnpbem-help` exposes canonical documentation/reference module lists for user navigation.

## Scientific Context
It formalizes an index set of core computational blocks:

$$
\mathcal{M}=\{\text{base},\text{material},\text{mesh2d},\text{mie},\text{greenfun},\text{particles},\text{simulation}\}
$$

## Implementation
- Reference list: `src/mnpbem_help/reference.py`

## Installation
```bash
pip install mnpbem-help
```

## Example
Runnable example:
- `examples/basic_usage.py`

Run:
```bash
python examples/basic_usage.py
```

## Author
- GALIH RIDHO UTOMO
- g4lihru@students.unnes.ac.id
