@galihru/mnp-mie 0.1.1 → 0.1.2

package/README.md

@@ -1,7 +1,124 @@
 # @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.
+Rayleigh quasi-static scattering formulas for spherical metallic nanoparticles in a homogeneous embedding medium.
+Computes complex polarizability and electromagnetic cross sections (extinction, scattering, absorption) within the dipole approximation, valid when the particle radius satisfies *a* ≪ λ.
+
+---
+
+## Physical Background
+
+In the Rayleigh (quasi-static) limit, the electromagnetic response of a small sphere is fully characterised by the induced electric dipole moment, parameterised through the complex polarizability α. This approach is the foundation for single-particle spectroscopy, surface-enhanced sensing, and photothermal applications.
+
+---
+
+## Implemented Formulations
+
+### 1. Quasi-static Polarizability
+
+For a sphere of radius *a* with permittivity εₚ embedded in a medium with permittivity εₘ:
+
+![α = 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})
+
+The Fröhlich resonance condition (localized surface plasmon resonance) occurs when:
+
+![Re(εp + 2εm) = 0](https://latex.codecogs.com/svg.latex?\mathrm{Re}(\varepsilon_p+2\varepsilon_m)=0)
+
+---
+
+### 2. Wave Number in the Embedding Medium
+
+![k = (2π/λ)√εm](https://latex.codecogs.com/svg.latex?k=\frac{2\pi}{\lambda}\sqrt{\varepsilon_m})
+
+where λ is the free-space wavelength in nanometres.
+
+---
+
+### 3. Electromagnetic Cross Sections
+
+**Extinction cross section** (energy removed from the incident beam):
+
+![Cext = k Im(α)](https://latex.codecogs.com/svg.latex?C_{\mathrm{ext}}=k\,\mathrm{Im}(\alpha))
+
+**Scattering cross section** (radiatively re-emitted energy):
+
+![Csca = |k|⁴/(6π)|α|²](https://latex.codecogs.com/svg.latex?C_{\mathrm{sca}}=\frac{|k|^4}{6\pi}|\alpha|^2)
+
+**Absorption cross section** (non-radiative, Ohmic dissipation):
+
+![Cabs = Cext − Csca](https://latex.codecogs.com/svg.latex?C_{\mathrm{abs}}=C_{\mathrm{ext}}-C_{\mathrm{sca}})
+
+All cross sections are expressed in nm².
+
+---
+
+## Install
+
+```bash
+npm install @galihru/mnp-mie
+```
+
+---
+
+## API Reference
+
+### `rayleighPolarizability(radiusNm, epsParticle, epsMedium)`
+
+Returns the complex polarizability α.
+
+```js
+import { complex, rayleighPolarizability } from "@galihru/mnp-mie";
+
+const epsParticle = complex(-7.45, 1.23);  // e.g. 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.
+
+```js
+import { complex, rayleighCrossSections } from "@galihru/mnp-mie";
+
+const epsParticle = complex(-7.45, 1.23);
+const epsMedium   = complex(1.769, 0.0);
+
+const cs = rayleighCrossSections(548.1, 50, epsParticle, epsMedium);
+// → { cExt: ..., cSca: ..., cAbs: ... }   [nm²]
+
+// Array input (wavelength scan)
+const spectra = rayleighCrossSections(
+  [400, 450, 500, 548, 600, 700],
+  50,
+  [eps400, eps450, ...],
+  [em400,  em450,  ...]
+);
+```
+
+---
+
+### `complex(re, im)`
+
+Constructs a complex number.
+
+```js
+import { complex } from "@galihru/mnp-mie";
+
+const z = complex(-5.2, 2.1);  // → { re: -5.2, im: 2.1 }
+```
+
+---
+
+## Author
+
+**GALIH RIDHO UTOMO** · g4lihru@students.unnes.ac.id  
+University of Semarang State (UNNES)  
+License: GPL-2.0-only
+
 
 ## Implemented Formulations
 

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.2",
+  "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": {