@galihru/mnp 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +107 -2
  2. package/package.json +16 -4
package/README.md CHANGED
@@ -1,7 +1,112 @@
1
1
  # @galihru/mnp
2
2
 
3
- Integrated JavaScript package for nanoparticle plasmonic response estimation.
4
- Composes `@galihru/mnp-material` and `@galihru/mnp-mie` into a single unified API.
3
+ Integrated computational package for the electromagnetic response of metallic nanoparticles in the Rayleigh quasi-static limit.
4
+ Composes dielectric-function evaluation (`@galihru/mnp-material`) with polarizability and cross-section computation (`@galihru/mnp-mie`) to deliver a complete, self-contained simulation API.
5
+
6
+ ---
7
+
8
+ ## Physical Scope
9
+
10
+ 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.
11
+
12
+ The approach combines:
13
+ 1. **Drude free-electron dielectric model** — *ε(ω) = ε∞ − ωₚ²/[ω(ω + iγ)]*
14
+ 2. **Clausius–Mossotti quasi-static polarizability** — *α = 4πa³(εₚ − εₘ)/(εₚ + 2εₘ)*
15
+ 3. **Optical theorem cross sections** — Cₑₓₜ, Cₛ꜀ₐ, Cₐ꜀ₛ from the induced dipole
16
+
17
+ ---
18
+
19
+ ## Packages Composed
20
+
21
+ | Package | Description |
22
+ |---|---|
23
+ | [`@galihru/mnp-material`](https://www.npmjs.com/package/@galihru/mnp-material) | Drude dielectric model — Au, Ag, Al; constant ε; wave number |
24
+ | [`@galihru/mnp-mie`](https://www.npmjs.com/package/@galihru/mnp-mie) | Rayleigh polarizability and extinction / scattering / absorption cross sections |
25
+
26
+ ---
27
+
28
+ ## Install
29
+
30
+ ```bash
31
+ npm install @galihru/mnp
32
+ ```
33
+
34
+ ---
35
+
36
+ ## API Reference
37
+
38
+ ### High-level: `simulateSphereResponse(options)`
39
+
40
+ Computes the full nanoparticle optical response in one call.
41
+
42
+ ```js
43
+ import { simulateSphereResponse } from "@galihru/mnp";
44
+
45
+ const result = simulateSphereResponse({
46
+ material: "Au", // "Au" | "Ag" | "Al"
47
+ wavelengthNm: 548.1, // nm, also accepts Array for spectral scan
48
+ radiusNm: 50, // nm
49
+ mediumRefractiveIndex: 1.33 // dimensionless (water)
50
+ });
51
+
52
+ console.log(result.epsParticle); // { re: -7.45, im: 1.23 }
53
+ console.log(result.alpha); // { re: ..., im: ... } [nm³]
54
+ console.log(result.crossSection); // { cExt, cSca, cAbs } [nm²]
55
+ ```
56
+
57
+ **Return value:**
58
+
59
+ | Field | Type | Description |
60
+ |---|---|---|
61
+ | `inputs` | object | Echo of input parameters |
62
+ | `epsParticle` | `{re, im}` | Dielectric function of the metal |
63
+ | `epsMedium` | `{re, im}` | Permittivity of embedding medium |
64
+ | `alpha` | `{re, im}` | Complex polarizability (nm³) |
65
+ | `crossSection` | `{cExt, cSca, cAbs}` | Optical cross sections (nm²) |
66
+
67
+ ---
68
+
69
+ ### Low-level re-exports
70
+
71
+ All functions from sub-packages are directly accessible:
72
+
73
+ ```js
74
+ import {
75
+ // from @galihru/mnp-material
76
+ drudeEpsilon, makeDrudeMaterial, constantEpsilon, wavenumberInMedium,
77
+ complex, add, sub, mul, div, sqrtComplex, fromReal,
78
+ EV_TO_NM, HARTREE_EV,
79
+
80
+ // from @galihru/mnp-mie
81
+ rayleighPolarizability, rayleighCrossSections
82
+ } from "@galihru/mnp";
83
+ ```
84
+
85
+ ---
86
+
87
+ ## Example — Spectral Scan
88
+
89
+ ```js
90
+ import { drudeEpsilon, constantEpsilon, rayleighCrossSections } from "@galihru/mnp";
91
+
92
+ const wavelengths = [400, 450, 500, 548, 600, 700];
93
+ const epsAu = drudeEpsilon("Au", wavelengths);
94
+ const epsH2O = wavelengths.map(w => constantEpsilon(1.769, w));
95
+
96
+ const spectra = rayleighCrossSections(wavelengths, 50, epsAu, epsH2O);
97
+ spectra.forEach((cs, i) =>
98
+ console.log(`${wavelengths[i]} nm — Cext: ${cs.cExt.toFixed(2)} nm²`)
99
+ );
100
+ ```
101
+
102
+ ---
103
+
104
+ ## Author
105
+
106
+ **GALIH RIDHO UTOMO** · g4lihru@students.unnes.ac.id
107
+ University of Semarang State (UNNES)
108
+ License: GPL-2.0-only
109
+
5
110
 
6
111
  ## Packages Included
7
112
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@galihru/mnp",
3
- "version": "0.1.1",
4
- "description": "Main integrated scientific package for MNP material and Mie formulations.",
3
+ "version": "0.1.2",
4
+ "description": "Integrated electromagnetic response of metallic nanoparticles: Drude dielectric model combined with Rayleigh quasi-static scattering.",
5
5
  "type": "module",
6
6
  "main": "./src/index.js",
7
7
  "exports": {
@@ -12,11 +12,23 @@
12
12
  "examples",
13
13
  "README.md"
14
14
  ],
15
+ "keywords": [
16
+ "nanoparticle",
17
+ "plasmonics",
18
+ "nanophotonics",
19
+ "mie-scattering",
20
+ "drude-model",
21
+ "localized-surface-plasmon",
22
+ "lspr",
23
+ "cross-section",
24
+ "electrodynamics",
25
+ "simulation"
26
+ ],
15
27
  "author": "GALIH RIDHO UTOMO <g4lihru@students.unnes.ac.id>",
16
28
  "license": "GPL-2.0-only",
17
29
  "dependencies": {
18
- "@galihru/mnp-material": "0.1.1",
19
- "@galihru/mnp-mie": "0.1.1"
30
+ "@galihru/mnp-material": "0.1.2",
31
+ "@galihru/mnp-mie": "0.1.2"
20
32
  },
21
33
  "repository": {
22
34
  "type": "git",