@galihru/mnp-mie 0.1.1 → 0.1.3

package/README.md

@@ -1,56 +1,126 @@
-# @galihru/mnp-mie
-
-Rayleigh-limit scattering formulas for small spherical particles.
-JavaScript port of the [mnpbem-mie](https://pypi.org/project/mnpbem-mie/) Python module.
-
-## Implemented Formulations
-
-### Polarizability
-
-![α = 4πa³(εp−εm)/(εp+2εm)](https://latex.codecogs.com/svg.latex?\alpha=4\pi%20a^3\frac{\varepsilon_p-\varepsilon_m}{\varepsilon_p+2\varepsilon_m})
-
-### Wave Number in Medium
-
-![k = (2π/λ)√εm](https://latex.codecogs.com/svg.latex?k=\frac{2\pi}{\lambda}\sqrt{\varepsilon_m})
-
-### Cross Sections
-
-Extinction:
-
-![C_ext = k Im(α)](https://latex.codecogs.com/svg.latex?C_{\mathrm{ext}}=k\,\mathrm{Im}(\alpha))
-
-Scattering:
-
-![C_sca = |k|⁴/(6π)|α|²](https://latex.codecogs.com/svg.latex?C_{\mathrm{sca}}=\frac{|k|^4}{6\pi}|\alpha|^2)
-
-Absorption:
-
-![C_abs = C_ext − C_sca](https://latex.codecogs.com/svg.latex?C_{\mathrm{abs}}=C_{\mathrm{ext}}-C_{\mathrm{sca}})
-
-## Install
-
-```bash
-npm install @galihru/mnp-mie
-```
-
-## API
-
-```js
-import { complex, rayleighPolarizability, rayleighCrossSections } from "@galihru/mnp-mie";
-
-const epsParticle = complex(-5.2, 2.1);
-const epsMedium  = complex(1.77, 0.0);
-
-// Polarizability (radius in nm)
-const alpha = rayleighPolarizability(50, epsParticle, epsMedium);
-
-// Cross sections (wavelength in nm, radius in nm)
-const cs = rayleighCrossSections(548.1, 50, epsParticle, epsMedium);
-console.log(cs); // { ext: ..., sca: ..., abs: ... }
-```
-
-## Author
-
-**GALIH RIDHO UTOMO** — g4lihru@students.unnes.ac.id  
+# @galihru/mnp-mie
+
+Rayleigh quasi-static scattering formulas for spherical metallic nanoparticles in a homogeneous dielectric medium. Computes complex polarizability and electromagnetic cross sections � extinction, scattering, and absorption � within the electric-dipole approximation, valid for particle radius *a* � ?.
+
+---
+
+## Physical Background
+
+In the Rayleigh (quasi-static) limit, the electromagnetic response of a small sphere is fully characterised by its induced electric dipole moment. The key quantity is the complex polarizability a, which encodes both radiative (scattering) and non-radiative (absorption) optical losses. This framework underpins localized surface plasmon resonance (LSPR) spectroscopy, photothermal therapy, and surface-enhanced sensing.
+
+---
+
+## Implemented Formulations
+
+### 1. Quasi-static Polarizability (Clausius�Mossotti)
+
+For a sphere of radius *a* with permittivity e? in an embedding medium with permittivity e?:
+
+![a = 4pa�(ep-em)/(ep+2em)](https://latex.codecogs.com/svg.latex?\alpha=4\pi%20a^3\frac{\varepsilon_p-\varepsilon_m}{\varepsilon_p+2\varepsilon_m}\quad[\mathrm{nm}^3])
+
+The **Fr�hlich resonance** (LSPR condition) occurs when:
+
+![Re(ep + 2em) = 0](https://latex.codecogs.com/svg.latex?\mathrm{Re}(\varepsilon_p+2\varepsilon_m)=0)
+
+---
+
+### 2. Wave Number in the Embedding Medium
+
+![k = (2p/?)vem](https://latex.codecogs.com/svg.latex?k=\frac{2\pi}{\lambda}\sqrt{\varepsilon_m}\quad[\mathrm{nm}^{-1}])
+
+where ? is the free-space wavelength in nanometres.
+
+---
+
+### 3. Electromagnetic Cross Sections
+
+**Extinction cross section** � total power removed from the incident beam:
+
+![Cext = k Im(a)](https://latex.codecogs.com/svg.latex?C_{\mathrm{ext}}=k\,\mathrm{Im}(\alpha)\quad[\mathrm{nm}^2])
+
+**Scattering cross section** � power re-radiated as scattered light:
+
+![Csca = |k|4/(6p)|a|�](https://latex.codecogs.com/svg.latex?C_{\mathrm{sca}}=\frac{|k|^4}{6\pi}|\alpha|^2\quad[\mathrm{nm}^2])
+
+**Absorption cross section** � power dissipated as Ohmic heat:
+
+![Cabs = Cext - Csca](https://latex.codecogs.com/svg.latex?C_{\mathrm{abs}}=C_{\mathrm{ext}}-C_{\mathrm{sca}}\quad[\mathrm{nm}^2])
+
+---
+
+## Install
+
+```bash
+npm install @galihru/mnp-mie
+```
+
+---
+
+## API Reference
+
+### `rayleighPolarizability(radiusNm, epsParticle, epsMedium)`
+
+Returns the complex polarizability a of a sphere.
+
+```js
+import { complex, rayleighPolarizability } from "@galihru/mnp-mie";
+
+const epsParticle = complex(-7.45, 1.23);  // Au at 548 nm
+const epsMedium   = complex(1.769, 0.0);   // water
+
+const alpha = rayleighPolarizability(50, epsParticle, epsMedium);
+// ? { re: ..., im: ... }   [nm�]
+```
+
+---
+
+### `rayleighCrossSections(wavelengthNm, radiusNm, epsParticle, epsMedium)`
+
+Returns extinction, scattering, and absorption cross sections in nm�.
+
+```js
+import { complex, rayleighCrossSections } from "@galihru/mnp-mie";
+
+const epsParticle = complex(-7.45, 1.23);
+const epsMedium   = complex(1.769, 0.0);
+
+// Single wavelength
+const cs = rayleighCrossSections(548.1, 50, epsParticle, epsMedium);
+// ? { cExt: ..., cSca: ..., cAbs: ... }   [nm�]
+
+// Spectral scan (array input)
+const cs = rayleighCrossSections(
+  [400, 450, 500, 548, 600, 700],
+  50,
+  [eps400, eps450, eps500, eps548, eps600, eps700],
+  [em400,  em450,  em500,  em548,  em600,  em700]
+);
+// ? [{ cExt, cSca, cAbs }, ...]
+```
+
+---
+
+### `complex(re, im)`
+
+Constructs a complex number `{ re, im }`.
+
+```js
+import { complex } from "@galihru/mnp-mie";
+
+const z = complex(-5.2, 2.1);
+// ? { re: -5.2, im: 2.1 }
+```
+
+---
+
+## Keywords
+
+mie-scattering � rayleigh � nanoparticle � cross-section � extinction � polarizability � plasmonics � nanophotonics � lspr � absorption
+
+---
+
+## Author
+
+**GALIH RIDHO UTOMO** � g4lihru@students.unnes.ac.id  
+Universitas Negeri Semarang (UNNES)  
 License: GPL-2.0-only
-

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@galihru/mnp-mie",
-  "version": "0.1.1",
-  "description": "Rayleigh-limit scattering formulations for spherical particles.",
+  "version": "0.1.3",
+  "description": "Rayleigh quasi-static scattering: polarizability and electromagnetic cross sections for spherical nanoparticles.",
   "type": "module",
   "main": "./src/index.js",
   "exports": {
@@ -11,6 +11,18 @@
     "src",
     "README.md"
   ],
+  "keywords": [
+    "mie-scattering",
+    "rayleigh",
+    "nanoparticle",
+    "cross-section",
+    "extinction",
+    "polarizability",
+    "plasmonics",
+    "nanophotonics",
+    "scattering",
+    "absorption"
+  ],
   "author": "GALIH RIDHO UTOMO <g4lihru@students.unnes.ac.id>",
   "license": "GPL-2.0-only",
   "repository": {