@galihru/mnp 0.1.0 → 0.1.1

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 +29 -5
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,11 +1,14 @@
1
1
  # @galihru/mnp
2
2
 
3
- Main integrated package that composes:
3
+ Integrated JavaScript package for nanoparticle plasmonic response estimation.
4
+ Composes `@galihru/mnp-material` and `@galihru/mnp-mie` into a single unified API.
4
5
 
5
- - `@galihru/mnp-material`
6
- - `@galihru/mnp-mie`
6
+ ## Packages Included
7
7
 
8
- This package provides a unified scientific API for fast nanoparticle-response estimates.
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 |
9
12
 
10
13
  ## Install
11
14
 
@@ -15,6 +18,8 @@ npm install @galihru/mnp
15
18
 
16
19
  ## Usage
17
20
 
21
+ ### High-level API
22
+
18
23
  ```js
19
24
  import { simulateSphereResponse } from "@galihru/mnp";
20
25
 
@@ -25,5 +30,24 @@ const result = simulateSphereResponse({
25
30
  mediumRefractiveIndex: 1.33
26
31
  });
27
32
 
28
- console.log(result.crossSection);
33
+ console.log(result.crossSection); // { ext, sca, abs }
34
+ console.log(result.epsParticle); // { re, im }
29
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
52
+ License: GPL-2.0-only
53
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@galihru/mnp",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Main integrated scientific package for MNP material and Mie formulations.",
5
5
  "type": "module",
6
6
  "main": "./src/index.js",
@@ -15,8 +15,8 @@
15
15
  "author": "GALIH RIDHO UTOMO <g4lihru@students.unnes.ac.id>",
16
16
  "license": "GPL-2.0-only",
17
17
  "dependencies": {
18
- "@galihru/mnp-material": "0.1.0",
19
- "@galihru/mnp-mie": "0.1.0"
18
+ "@galihru/mnp-material": "0.1.1",
19
+ "@galihru/mnp-mie": "0.1.1"
20
20
  },
21
21
  "repository": {
22
22
  "type": "git",