@galihru/mnp-mie 0.1.0 → 0.1.1

package/README.md

@@ -1,18 +1,31 @@
 # @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:
+## Implemented Formulations
 
-$$
-\alpha = 4\pi a^3\frac{\varepsilon_p-\varepsilon_m}{\varepsilon_p+2\varepsilon_m}
-$$
+### Polarizability
 
-$$
-C_{\mathrm{ext}} = k\,\mathrm{Im}(\alpha),\quad
-C_{\mathrm{sca}} = \frac{|k|^4}{6\pi}|\alpha|^2,\quad
-C_{\mathrm{abs}} = C_{\mathrm{ext}}-C_{\mathrm{sca}}
-$$
+![α = 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
 
@@ -20,12 +33,24 @@ $$
 npm install @galihru/mnp-mie
 ```
 
-## Usage
+## API
 
 ```js
-import { complex, rayleighCrossSections } from "@galihru/mnp-mie";
+import { complex, rayleighPolarizability, rayleighCrossSections } from "@galihru/mnp-mie";
 
 const epsParticle = complex(-5.2, 2.1);
-const epsMedium = complex(1.77, 0.0);
-console.log(rayleighCrossSections(548.1, 50, epsParticle, epsMedium));
+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  
+License: GPL-2.0-only
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galihru/mnp-mie",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Rayleigh-limit scattering formulations for spherical particles.",
   "type": "module",
   "main": "./src/index.js",