@galihru/mnp-material 0.1.1 → 0.1.2

package/README.md

@@ -1,7 +1,155 @@
 # @galihru/mnp-material
 
-Scientific dielectric-response models for plasmonic simulations.
-JavaScript port of the [mnpbem-material](https://pypi.org/project/mnpbem-material/) Python module.
+Analytical dielectric-function models for metallic nanoparticles in the framework of plasmonic nanophotonics.
+Provides frequency-dependent permittivity evaluation via the Drude free-electron model, constant dielectric approximation, and wave-number computation — all operating natively in the wavelength domain (λ in nm).
+
+---
+
+## Physical Background
+
+The optical response of a metallic nanoparticle is governed by its frequency-dependent complex dielectric function ε(ω). This package implements three levels of approximation used in nanophotonics electrodynamics.
+
+---
+
+## Implemented Models
+
+### 1. Energy–Wavelength Conversion
+
+All models accept wavelength in nanometres. The photon energy is obtained via:
+
+![ω = C/λ](https://latex.codecogs.com/svg.latex?\omega\,[\mathrm{eV}]=\frac{C}{\lambda\,[\mathrm{nm}]},\quad%20C=1239.84\,\mathrm{eV{\cdot}nm})
+
+---
+
+### 2. Drude Free-Electron Model
+
+The Drude model describes the optical response of free-electron metals:
+
+![ε(ω) = ε∞ - ωp²/(ω(ω+iγ))](https://latex.codecogs.com/svg.latex?\varepsilon(\omega)=\varepsilon_\infty-\frac{\omega_p^2}{\omega(\omega+i\gamma)})
+
+where:
+- **ε∞** — interband (high-frequency) dielectric constant
+- **ωₚ** — bulk plasma frequency, derived from the Wigner–Seitz radius *rₛ*:
+
+![ωp derived from rs](https://latex.codecogs.com/svg.latex?\rho_0=\frac{3}{4\pi%20r_s^3},\quad\omega_p=\sqrt{4\pi\rho_0}\times\mathcal{H})
+
+where *H* = 27.2116 eV (Hartree energy) converts atomic-unit plasma frequency to eV.
+
+- **γ** — phenomenological damping (Drude scattering rate)
+
+#### Built-in Material Parameters
+
+| Material | *rₛ* (a.u.) | ε∞ | γ (eV) | ωₚ (eV) |
+|---|---|---|---|---|
+| `Au` / `gold` | 3.00 | 10.0 | 0.066 | ~9.07 |
+| `Ag` / `silver` | 3.00 | 3.3 | 0.022 | ~9.07 |
+| `Al` / `aluminum` | 2.07 | 1.0 | 1.06 | ~15.8 |
+
+---
+
+### 3. Constant Dielectric Model
+
+For non-dispersive homogeneous embedding media (e.g. glass, water):
+
+![ε(λ) = ε₀](https://latex.codecogs.com/svg.latex?\varepsilon(\lambda)=\varepsilon_0\in\mathbb{C})
+
+---
+
+### 4. Wave Number in Medium
+
+The complex wave number for light propagating in a dielectric medium:
+
+![k(λ) = (2π/λ)√ε](https://latex.codecogs.com/svg.latex?k(\lambda)=\frac{2\pi}{\lambda}\sqrt{\varepsilon(\lambda)})
+
+---
+
+## Install
+
+```bash
+npm install @galihru/mnp-material
+```
+
+---
+
+## API Reference
+
+### `drudeEpsilon(materialName, wavelengthNm)`
+
+Evaluates the Drude dielectric function for a built-in metal.
+
+```js
+import { drudeEpsilon } from "@galihru/mnp-material";
+
+// Single wavelength
+const eps = drudeEpsilon("Au", 548.1);
+// → { re: -7.45, im: 1.23 }
+
+// Array of wavelengths
+const spectra = drudeEpsilon("Ag", [400, 500, 600, 700]);
+// → [{ re, im }, ...]
+```
+
+---
+
+### `makeDrudeMaterial(name)`
+
+Returns raw Drude parameters for a given metal.
+
+```js
+import { makeDrudeMaterial } from "@galihru/mnp-material";
+
+const au = makeDrudeMaterial("Au");
+// → { name: "Au", eps0: 10.0, gammad: 0.066, wp: 9.07 }
+```
+
+---
+
+### `constantEpsilon(value, wavelengthNm)`
+
+Returns a constant complex permittivity independent of frequency.
+
+```js
+import { constantEpsilon } from "@galihru/mnp-material";
+
+// Water: n ≈ 1.33,  ε = n² = 1.769
+const epsWater = constantEpsilon(1.769, 548.1);
+// → { re: 1.769, im: 0 }
+```
+
+---
+
+### `wavenumberInMedium(wavelengthNm, epsilonComplex)`
+
+Computes the complex wave number k = (2π/λ)√ε.
+
+```js
+import { constantEpsilon, wavenumberInMedium } from "@galihru/mnp-material";
+
+const eps = constantEpsilon(1.769, 548.1);
+const k = wavenumberInMedium(548.1, eps);
+// → { re: ..., im: ... }   [nm⁻¹]
+```
+
+---
+
+### Complex Arithmetic Utilities
+
+```js
+import { complex, add, sub, mul, div, sqrtComplex, fromReal } from "@galihru/mnp-material";
+
+const z1 = complex(-5.2, 1.3);   // -5.2 + 1.3i
+const z2 = fromReal(2.0);        // 2.0 + 0i
+const prod = mul(z1, z2);        // → { re: -10.4, im: 2.6 }
+```
+
+---
+
+## Author
+
+**GALIH RIDHO UTOMO** · g4lihru@students.unnes.ac.id  
+University of Semarang State (UNNES)  
+License: GPL-2.0-only
+
 
 ## Features
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@galihru/mnp-material",
-  "version": "0.1.1",
-  "description": "Material dielectric models for plasmonic electrodynamics.",
+  "version": "0.1.2",
+  "description": "Analytical dielectric-function models for metallic nanoparticles in plasmonic nanophotonics.",
   "type": "module",
   "main": "./src/index.js",
   "exports": {
@@ -11,6 +11,18 @@
     "src",
     "README.md"
   ],
+  "keywords": [
+    "plasmonics",
+    "dielectric-function",
+    "drude-model",
+    "nanoparticle",
+    "nanophotonics",
+    "permittivity",
+    "gold",
+    "silver",
+    "electrodynamics",
+    "optics"
+  ],
   "author": "GALIH RIDHO UTOMO <g4lihru@students.unnes.ac.id>",
   "license": "GPL-2.0-only",
   "repository": {