@galihru/mnp 0.1.0 → 0.1.2

package/README.md

@@ -1,11 +1,119 @@
 # @galihru/mnp
 
-Main integrated package that composes:
+Integrated computational package for the electromagnetic response of metallic nanoparticles in the Rayleigh quasi-static limit.
+Composes dielectric-function evaluation (`@galihru/mnp-material`) with polarizability and cross-section computation (`@galihru/mnp-mie`) to deliver a complete, self-contained simulation API.
 
-- `@galihru/mnp-material`
-- `@galihru/mnp-mie`
+---
 
-This package provides a unified scientific API for fast nanoparticle-response estimates.
+## Physical Scope
+
+This package addresses the **single-nanoparticle optical response problem**: given a metallic sphere of radius *a* ≪ λ embedded in a dielectric host, compute the complex permittivity ε(λ), polarizability α, and electromagnetic cross sections (Cₑₓₜ, Cₛ꜀ₐ, Cₐ꜀ₛ) as a function of illumination wavelength.
+
+The approach combines:
+1. **Drude free-electron dielectric model** — *ε(ω) = ε∞ − ωₚ²/[ω(ω + iγ)]*
+2. **Clausius–Mossotti quasi-static polarizability** — *α = 4πa³(εₚ − εₘ)/(εₚ + 2εₘ)*
+3. **Optical theorem cross sections** — Cₑₓₜ, Cₛ꜀ₐ, Cₐ꜀ₛ from the induced dipole
+
+---
+
+## Packages Composed
+
+| Package | Description |
+|---|---|
+| [`@galihru/mnp-material`](https://www.npmjs.com/package/@galihru/mnp-material) | Drude dielectric model — Au, Ag, Al; constant ε; wave number |
+| [`@galihru/mnp-mie`](https://www.npmjs.com/package/@galihru/mnp-mie) | Rayleigh polarizability and extinction / scattering / absorption cross sections |
+
+---
+
+## Install
+
+```bash
+npm install @galihru/mnp
+```
+
+---
+
+## API Reference
+
+### High-level: `simulateSphereResponse(options)`
+
+Computes the full nanoparticle optical response in one call.
+
+```js
+import { simulateSphereResponse } from "@galihru/mnp";
+
+const result = simulateSphereResponse({
+  material:             "Au",   // "Au" | "Ag" | "Al"
+  wavelengthNm:         548.1,  // nm, also accepts Array for spectral scan
+  radiusNm:             50,     // nm
+  mediumRefractiveIndex: 1.33   // dimensionless (water)
+});
+
+console.log(result.epsParticle);  // { re: -7.45, im: 1.23 }
+console.log(result.alpha);        // { re: ..., im: ... }  [nm³]
+console.log(result.crossSection); // { cExt, cSca, cAbs }  [nm²]
+```
+
+**Return value:**
+
+| Field | Type | Description |
+|---|---|---|
+| `inputs` | object | Echo of input parameters |
+| `epsParticle` | `{re, im}` | Dielectric function of the metal |
+| `epsMedium` | `{re, im}` | Permittivity of embedding medium |
+| `alpha` | `{re, im}` | Complex polarizability (nm³) |
+| `crossSection` | `{cExt, cSca, cAbs}` | Optical cross sections (nm²) |
+
+---
+
+### Low-level re-exports
+
+All functions from sub-packages are directly accessible:
+
+```js
+import {
+  // from @galihru/mnp-material
+  drudeEpsilon, makeDrudeMaterial, constantEpsilon, wavenumberInMedium,
+  complex, add, sub, mul, div, sqrtComplex, fromReal,
+  EV_TO_NM, HARTREE_EV,
+
+  // from @galihru/mnp-mie
+  rayleighPolarizability, rayleighCrossSections
+} from "@galihru/mnp";
+```
+
+---
+
+## Example — Spectral Scan
+
+```js
+import { drudeEpsilon, constantEpsilon, rayleighCrossSections } from "@galihru/mnp";
+
+const wavelengths = [400, 450, 500, 548, 600, 700];
+const epsAu = drudeEpsilon("Au", wavelengths);
+const epsH2O = wavelengths.map(w => constantEpsilon(1.769, w));
+
+const spectra = rayleighCrossSections(wavelengths, 50, epsAu, epsH2O);
+spectra.forEach((cs, i) =>
+  console.log(`${wavelengths[i]} nm — Cext: ${cs.cExt.toFixed(2)} nm²`)
+);
+```
+
+---
+
+## Author
+
+**GALIH RIDHO UTOMO** · g4lihru@students.unnes.ac.id  
+University of Semarang State (UNNES)  
+License: GPL-2.0-only
+
+
+## Packages Included
+
+| Package | Description |
+|---|---|
+| [`@galihru/mnp-material`](https://www.npmjs.com/package/@galihru/mnp-material) | Dielectric models (Drude, constant, tabulated) |
+| [`@galihru/mnp-mie`](https://www.npmjs.com/package/@galihru/mnp-mie) | Rayleigh scattering cross sections |
 
 ## Install
 
@@ -15,6 +123,8 @@ npm install @galihru/mnp
 
 ## Usage
 
+### High-level API
+
 ```js
 import { simulateSphereResponse } from "@galihru/mnp";
 
@@ -25,5 +135,24 @@ const result = simulateSphereResponse({
   mediumRefractiveIndex: 1.33
 });
 
-console.log(result.crossSection);
+console.log(result.crossSection); // { ext, sca, abs }
+console.log(result.epsParticle);  // { re, im }
 ```
+
+### Low-level API
+
+All exports from sub-packages are re-exported:
+
+```js
+import {
+  drudeEpsilon, constantEpsilon, wavenumberInMedium,
+  rayleighCrossSections, rayleighPolarizability,
+  complex
+} from "@galihru/mnp";
+```
+
+## Author
+
+**GALIH RIDHO UTOMO** — g4lihru@students.unnes.ac.id  
+License: GPL-2.0-only
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@galihru/mnp",
-  "version": "0.1.0",
-  "description": "Main integrated scientific package for MNP material and Mie formulations.",
+  "version": "0.1.2",
+  "description": "Integrated electromagnetic response of metallic nanoparticles: Drude dielectric model combined with Rayleigh quasi-static scattering.",
   "type": "module",
   "main": "./src/index.js",
   "exports": {
@@ -12,11 +12,23 @@
     "examples",
     "README.md"
   ],
+  "keywords": [
+    "nanoparticle",
+    "plasmonics",
+    "nanophotonics",
+    "mie-scattering",
+    "drude-model",
+    "localized-surface-plasmon",
+    "lspr",
+    "cross-section",
+    "electrodynamics",
+    "simulation"
+  ],
   "author": "GALIH RIDHO UTOMO <g4lihru@students.unnes.ac.id>",
   "license": "GPL-2.0-only",
   "dependencies": {
-    "@galihru/mnp-material": "0.1.0",
-    "@galihru/mnp-mie": "0.1.0"
+    "@galihru/mnp-material": "0.1.2",
+    "@galihru/mnp-mie": "0.1.2"
   },
   "repository": {
     "type": "git",