@galihru/mnp 0.1.1 → 0.1.3

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 +121 -52
  2. package/package.json +16 -4
package/README.md CHANGED
@@ -1,53 +1,122 @@
1
- # @galihru/mnp
2
-
3
- Integrated JavaScript package for nanoparticle plasmonic response estimation.
4
- Composes `@galihru/mnp-material` and `@galihru/mnp-mie` into a single unified API.
5
-
6
- ## Packages Included
7
-
8
- | Package | Description |
9
- |---|---|
10
- | [`@galihru/mnp-material`](https://www.npmjs.com/package/@galihru/mnp-material) | Dielectric models (Drude, constant, tabulated) |
11
- | [`@galihru/mnp-mie`](https://www.npmjs.com/package/@galihru/mnp-mie) | Rayleigh scattering cross sections |
12
-
13
- ## Install
14
-
15
- ```bash
16
- npm install @galihru/mnp
17
- ```
18
-
19
- ## Usage
20
-
21
- ### High-level API
22
-
23
- ```js
24
- import { simulateSphereResponse } from "@galihru/mnp";
25
-
26
- const result = simulateSphereResponse({
27
- material: "Au",
28
- wavelengthNm: 548.1,
29
- radiusNm: 50,
30
- mediumRefractiveIndex: 1.33
31
- });
32
-
33
- console.log(result.crossSection); // { ext, sca, abs }
34
- console.log(result.epsParticle); // { re, im }
35
- ```
36
-
37
- ### Low-level API
38
-
39
- All exports from sub-packages are re-exported:
40
-
41
- ```js
42
- import {
43
- drudeEpsilon, constantEpsilon, wavenumberInMedium,
44
- rayleighCrossSections, rayleighPolarizability,
45
- complex
46
- } from "@galihru/mnp";
47
- ```
48
-
49
- ## Author
50
-
51
- **GALIH RIDHO UTOMO** — g4lihru@students.unnes.ac.id
1
+ # @galihru/mnp
2
+
3
+ Integrated computational package for the single-nanoparticle electromagnetic response in the Rayleigh quasi-static limit. Composes dielectric-function evaluation with polarizability and optical cross-section computation into a unified, self-consistent simulation API.
4
+
5
+ ---
6
+
7
+ ## Physical Scope
8
+
9
+ This package solves the **single-nanoparticle optical response problem**: given a metallic sphere of radius *a* � ? embedded in a dielectric host medium, compute as functions of illumination wavelength:
10
+
11
+ 1. Complex permittivity via the **Drude free-electron model**:
12
+ ![e(?) = e8 - ?p�/(?(?+i?))](https://latex.codecogs.com/svg.latex?\varepsilon(\omega)=\varepsilon_\infty-\frac{\omega_p^2}{\omega(\omega+i\gamma)})
13
+
14
+ 2. Complex polarizability via the **Clausius�Mossotti relation**:
15
+ ![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})
16
+
17
+ 3. Electromagnetic **cross sections** from the optical theorem:
18
+ ![Cext, Csca, Cabs](https://latex.codecogs.com/svg.latex?C_{\mathrm{ext}}=k\,\mathrm{Im}(\alpha),\quad%20C_{\mathrm{sca}}=\frac{|k|^4}{6\pi}|\alpha|^2,\quad%20C_{\mathrm{abs}}=C_{\mathrm{ext}}-C_{\mathrm{sca}})
19
+
20
+ ---
21
+
22
+ ## Composed Packages
23
+
24
+ | Package | Description |
25
+ |---|---|
26
+ | [`@galihru/mnp-material`](https://www.npmjs.com/package/@galihru/mnp-material) | Drude dielectric model for Au, Ag, Al; constant e; complex wave number |
27
+ | [`@galihru/mnp-mie`](https://www.npmjs.com/package/@galihru/mnp-mie) | Rayleigh polarizability; extinction, scattering, and absorption cross sections |
28
+
29
+ ---
30
+
31
+ ## Install
32
+
33
+ ```bash
34
+ npm install @galihru/mnp
35
+ ```
36
+
37
+ ---
38
+
39
+ ## API Reference
40
+
41
+ ### `simulateSphereResponse(options)` � High-level
42
+
43
+ Computes the complete optical response of a metallic nanosphere in a single call.
44
+
45
+ ```js
46
+ import { simulateSphereResponse } from "@galihru/mnp";
47
+
48
+ const result = simulateSphereResponse({
49
+ material: "Au", // "Au" | "Ag" | "Al"
50
+ wavelengthNm: 548.1, // nm � scalar or Array for spectral scan
51
+ radiusNm: 50, // nm
52
+ mediumRefractiveIndex: 1.33 // dimensionless refractive index of host medium
53
+ });
54
+ ```
55
+
56
+ **Return value:**
57
+
58
+ | Field | Unit | Description |
59
+ |---|---|---|
60
+ | `inputs` | � | Echo of all input parameters |
61
+ | `epsParticle` | `{re, im}` | Complex permittivity of the metal particle |
62
+ | `epsMedium` | `{re, im}` | Permittivity of the embedding medium |
63
+ | `alpha` | `{re, im}` nm� | Quasi-static complex polarizability |
64
+ | `crossSection.cExt` | nm� | Extinction cross section |
65
+ | `crossSection.cSca` | nm� | Scattering cross section |
66
+ | `crossSection.cAbs` | nm� | Absorption cross section |
67
+
68
+ ---
69
+
70
+ ### Low-level Re-exports
71
+
72
+ All functions from sub-packages are re-exported directly:
73
+
74
+ ```js
75
+ import {
76
+ // Dielectric models
77
+ drudeEpsilon, makeDrudeMaterial, constantEpsilon, wavenumberInMedium,
78
+ // Scattering
79
+ rayleighPolarizability, rayleighCrossSections,
80
+ // Complex arithmetic
81
+ complex, add, sub, mul, div, sqrtComplex, fromReal,
82
+ // Constants
83
+ EV_TO_NM, HARTREE_EV
84
+ } from "@galihru/mnp";
85
+ ```
86
+
87
+ ---
88
+
89
+ ## Example � Spectral Scan
90
+
91
+ ```js
92
+ import { drudeEpsilon, constantEpsilon, rayleighCrossSections } from "@galihru/mnp";
93
+
94
+ const wavelengths = [400, 450, 500, 548, 600, 700];
95
+
96
+ // Au permittivity across wavelengths
97
+ const epsAu = drudeEpsilon("Au", wavelengths);
98
+
99
+ // Host medium: water (n = 1.33, e = n�)
100
+ const epsH2O = wavelengths.map(w => constantEpsilon(1.769, w));
101
+
102
+ // Cross sections for a 50 nm radius Au sphere
103
+ const spectra = rayleighCrossSections(wavelengths, 50, epsAu, epsH2O);
104
+
105
+ spectra.forEach((cs, i) =>
106
+ console.log(`${wavelengths[i]} nm Cext=${cs.cExt.toFixed(1)} nm� Cabs=${cs.cAbs.toFixed(1)} nm�`)
107
+ );
108
+ ```
109
+
110
+ ---
111
+
112
+ ## Keywords
113
+
114
+ nanoparticle � plasmonics � nanophotonics � mie-scattering � drude-model � lspr � localized-surface-plasmon � cross-section � electrodynamics � simulation
115
+
116
+ ---
117
+
118
+ ## Author
119
+
120
+ **GALIH RIDHO UTOMO** � g4lihru@students.unnes.ac.id
121
+ Universitas Negeri Semarang (UNNES)
52
122
  License: GPL-2.0-only
53
-
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.3",
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.3",
31
+ "@galihru/mnp-mie": "0.1.3"
20
32
  },
21
33
  "repository": {
22
34
  "type": "git",