docs: clean dataset card metadata

CITATION.cff

@@ -1,15 +1,15 @@
 cff-version: 1.2.0
-message: "If you use NanoPhotoNet-MPM, please cite the archived Zenodo release."
-title: "iabdul-aal/NanoPhotoNet-MPM: NanoPhotoNet-MPM V1 (PINN)"
-type: software
+message: "If you use the NanoPhotoNet-MPM dataset, please cite the dataset DOI."
+title: "NanoPhotoNet-MPM Dataset"
+type: dataset
 authors:
   - family-names: Abdulaal
     given-names: Islam I.
 version: "1.0.0"
-doi: 10.5281/zenodo.XXXXXXX
-repository-code: "https://github.com/iabdul-aal/NanoPhotoNet-MPM"
-url: "https://doi.org/10.5281/zenodo.XXXXXXX"
+doi: 10.57967/hf/9066
+url: "https://doi.org/10.57967/hf/9066"
 license: "CC-BY-4.0"
 abstract: >-
-  Physics-informed inverse design of modal phase-matched spontaneous parametric
-  down-conversion in NbOCl2 ridge waveguides with swept ridge width and height.
+  FDE modal tables, measured dispersion data, and consolidated vector-field
+  tensors for physics-informed inverse design of modal phase-matched SPDC in
+  NbOCl2 ridge waveguides.

README.md

@@ -8,163 +8,92 @@ tags:
 - spdc
 - quantum-optics
 pretty_name: NanoPhotoNet-MPM Dataset
-repository: https://github.com/iabdul-aal/NanoPhotoNet-MPM
 ---
 
-# NanoPhotoNet-MPM: Physics-Informed Neural Surrogate Dataset
+# NanoPhotoNet-MPM Dataset
 
 [![License: CC BY 4.0](https://img.shields.io/badge/License-CC_BY_4.0-blue.svg)](https://creativecommons.org/licenses/by/4.0/)
-[![Hugging Face Dataset](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Dataset-orange.svg)](https://huggingface.co/datasets/iabdul-aal/NanoPhotoNet-MPM)
-[![Hugging Face Model](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Model-orange.svg)](https://huggingface.co/iabdul-aal/NanoPhotoNet-MPM)
-[![GitHub Repository](https://img.shields.io/badge/GitHub-Repository-blue?logo=github)](https://github.com/iabdul-aal/NanoPhotoNet-MPM)
-[![DOI](https://img.shields.io/badge/DOI-10.57967%2Fhf%2F9066-blue.svg)](https://doi.org/10.57967/hf/9066)
-[![Model DOI](https://img.shields.io/badge/DOI-10.57967%2Fhf%2F9068-blue.svg)](https://doi.org/10.57967/hf/9068)
+[![Dataset DOI](https://img.shields.io/badge/Dataset%20DOI-10.57967%2Fhf%2F9066-blue.svg)](https://doi.org/10.57967/hf/9066)
+[![Model DOI](https://img.shields.io/badge/Model%20DOI-10.57967%2Fhf%2F9068-orange.svg)](https://doi.org/10.57967/hf/9068)
+[![Code DOI](https://img.shields.io/badge/Code%20DOI-10.5281%2Fzenodo.18653064-blue.svg)](https://doi.org/10.5281/zenodo.18653064)
 
 > **Copyright © 2026 Islam I. Abdulaal and Omar A. M. Abdelraouf.**
-> Code is released under the [MIT License](https://github.com/iabdul-aal/NanoPhotoNet-MPM/blob/main/LICENSE). Dataset is released under [CC BY 4.0](LICENSE).
-> **Paper:** See the accompanying preprint at [arXiv:2411.18733](https://arxiv.org/abs/2411.18733).
+> Dataset artifacts are released under [CC BY 4.0](LICENSE-DATA).
+> **Paper:** forthcoming.
 
-This repository hosts the raw tabulated modal database, measured dispersion indices, and consolidated vector field profile tensors for **NanoPhotoNet-MPM**, a physics-informed neural surrogate model for the inverse design of modal phase-matched Spontaneous Parametric Down-Conversion (SPDC) in monoclinic niobium oxychloride (\\(\\text{NbOCl}_2\\)) ridge waveguides.
+This dataset contains the Finite Difference Eigenmode (FDE) tables, measured dispersion-index files, and consolidated vector-field tensors used by **NanoPhotoNet-MPM**, a physics-informed neural surrogate for modal phase-matched SPDC inverse design in monoclinic NbOCl2 ridge waveguides.
 
-This dataset is utilized to train the **EigenmodeDeepONet** transverse mode solver and calibrate index dispersion relations.
+The paired model release is available at [DOI 10.57967/hf/9068](https://doi.org/10.57967/hf/9068). The archived code release is available at [DOI 10.5281/zenodo.18653064](https://doi.org/10.5281/zenodo.18653064).
 
 ---
 
-## Technical Architecture Overview
-
-The NanoPhotoNet-MPM framework uses this dataset to bypass expensive Finite Difference Eigenmode (FDE) solvers:
-
-```mermaid
-graph TD
-    subgraph Inputs ["Inputs"]
-        G["Geometry: w, h"] --> TM["Transverse Solver: EigenmodeDeepONet"]
-        C["Coordinates: x, y"] --> TM
-        W["Wavelengths: λ_p, λ_s"] --> TM
-    end
-
-    subgraph Transverse_Module ["Transverse Module — Stage 1"]
-        TM --> |"Predicts"| F["Vector Fields: E_q"]
-        TM --> |"Predicts"| N["Effective Index: n_eff"]
-    end
-
-    subgraph Physics_Processing ["Physics Processing Layer"]
-        F --> |"Coupling Integral"| K["Overlap Proxy: K"]
-        N --> |"Dispersion Relation"| DB["Phase Mismatch: Δβ"]
-    end
-
-    subgraph Longitudinal_Module ["Longitudinal Module — Stage 2"]
-        K --> Prop["Longitudinal Propagator: CWE-PINN"]
-        DB --> Prop
-        Loss["Propagation Loss: α"] --> Prop
-        Prop --> |"Integrates"| Env["Envelopes: A_p, A_s, A_i"]
-    end
-
-    subgraph GA_Loop ["Inverse Design GA Loop"]
-        Env --> |"Fitness Evaluation"| Fit["GA Optimization Cost"]
-        Fit --> |"Mutate / Selection"| G
-    end
-```
+## Files
 
----
+| File | Description |
+| :--- | :--- |
+| `data/NbOCl2x-measured-index.txt` | Measured refractive indices for monoclinic NbOCl2 over the modeled wavelength range |
+| `data/SiO2-measured-index.txt` | Measured refractive indices for the SiO2 substrate |
+| `data/neff_775.mat` | Effective-index table for pump modes at 775 nm |
+| `data/neff_1550.mat` | Effective-index table for signal/idler modes at 1550 nm |
+| `data/fde_profiles_128x128.npy` | Consolidated full-vector electric-field profile tensor |
+| `data/fde_profiles_mask.npy` | Spatial mask tensor for boundary/crop handling during training |
 
-## Dataset Manifest & File Descriptions
+---
 
-The dataset consists of the following files, which should be placed inside a local `data/` directory for code execution:
+## Schema
 
-### 1. Dispersion Data (Measured Indices)
-- **`data/NbOCl2x-measured-index.txt`**: Tabulated experimental refractive indices (\\(n_x, n_y, n_z\\)) for monoclinic \\(\\text{NbOCl}_2\\) across a spectral range of wavelengths (in \\(\\mu\\text{m}\\)).
-- **`data/SiO2-measured-index.txt`**: Tabulated experimental refractive indices for the silicon dioxide substrate.
+`data/fde_profiles_128x128.npy` stores a NumPy tensor with shape `(280, 6, 16384)`:
 
-### 2. Transverse Vector Field Profiles
-- **`data/fde_profiles_128x128.npy`**: Consolidated NumPy tensor representing full-vectorial electric field profiles (\\(E_x, E_y, E_z\\)) on a \\(128 \\times 128\\) spatial grid.
-  - **Shape**: `(280, 6, 16384)`
-    - `280` represents the waveguide geometry configurations.
-    - `6` represents the field components (real and imaginary components of \\(E_x, E_y, E_z\\)).
-    - `16384` is the flattened spatial grid (\\(128 \times 128\\)).
-- **`data/fde_profiles_mask.npy`**: A spatial mask coordinate tensor used to define boundary points and crop grids during neural network training.
+| Axis | Meaning |
+| :--- | :--- |
+| `280` | Paired waveguide geometry samples |
+| `6` | Real and imaginary parts of Ex, Ey, and Ez |
+| `16384` | Flattened 128 x 128 transverse grid |
 
-### 3. Effective Indices (\\(n_{\mathrm{eff}}\\))
-- **`data/neff_775.mat`**: MATLAB data file containing calculated effective indices (\\(n_{\mathrm{eff}}\\)) for pump modes (\\(\\lambda_p = 775\\,\text{nm}\\)) across varying waveguide widths (\\(w\\)) and heights (\\(h\\)).
-- **`data/neff_1550.mat`**: MATLAB data file containing calculated effective indices (\\(n_{\mathrm{eff}}\\)) for signal/idler modes (\\(\\lambda_s = 1550\\,\text{nm}\\)) across varying waveguide widths (\\(w\\)) and heights (\\(h\\)).
+The `.mat` files contain effective-index grids over swept waveguide widths and heights. The measured-index text files provide dispersion inputs for material interpolation.
 
 ---
 
-## Data Schema & Generation
-
-The dataset was generated using a full-vectorial Finite Difference Eigenmode (FDE) solver:
-- **Geometry sweep**: Waveguide widths (\\(w\\)) and heights (\\(h\\)) were swept in the range of \\(100\\,\text{nm}\\) to \\(1000\\,\text{nm}\\) in steps of \\(50\\,\text{nm}\\).
-- **Modes tracked**: 
-  - Pump mode (\\(\\lambda = 775\\,\text{nm}\\)): Quasi-TE (fundamental) mode.
-  - Signal/Idler mode (\\(\\lambda = 1550\\,\text{nm}\\)): Quasi-TM (fundamental) mode.
-
----
-
-## Usage & Loading Example (Python)
-
-To load and inspect the dataset files, you can run the following Python script:
+## Loading Example
 
 ```python
 import numpy as np
 import scipy.io as sio
 
-# 1. Load effective indices
-neff_775_data = sio.loadmat('data/neff_775.mat')
-neff_1550_data = sio.loadmat('data/neff_1550.mat')
+neff_775 = sio.loadmat("data/neff_775.mat")
+neff_1550 = sio.loadmat("data/neff_1550.mat")
+profiles = np.load("data/fde_profiles_128x128.npy")
+mask = np.load("data/fde_profiles_mask.npy")
 
-# Accessing raw arrays
-print("neff_775 keys:", neff_775_data.keys())
-print("neff_775 width array:", neff_775_data['w_arr'])
-print("neff_775 height array:", neff_775_data['h_arr'])
-print("neff_775 index matrix shape:", neff_775_data['neff_mat'].shape)
+print("neff_775 keys:", sorted(neff_775.keys()))
+print("neff_1550 keys:", sorted(neff_1550.keys()))
+print("profiles shape:", profiles.shape)
+print("mask shape:", mask.shape)
+```
 
-# 2. Load electric field profiles
-profiles = np.load('data/fde_profiles_128x128.npy')
-print("Field profiles shape:", profiles.shape)  # Expected: (280, 6, 16384)
+---
 
-# 3. Load measured indices
-with open('data/NbOCl2x-measured-index.txt', 'r') as f:
-    for _ in range(5):
-        print(f.readline().strip())
-```
+## Generation Summary
+
+The dataset was generated with a full-vectorial FDE workflow over ridge-waveguide width and height sweeps from 100 nm to 1000 nm. Pump samples target 775 nm quasi-TE modes, while signal/idler samples target 1550 nm quasi-TM modes. The consolidated tensor is intended for supervised transverse-field training and downstream physics-informed validation.
 
 ---
 
-## Citations
+## Limitations
 
-If you use this dataset in your research, please cite the paper, dataset, and model:
+The dataset is scoped to the simulated NbOCl2 ridge-waveguide design space and the material-index inputs included here. Extrapolation outside the documented geometry, wavelength, or material range should be validated with an independent electromagnetic solver.
 
-### Article
-```bibtex
-@misc{abdulaal2024surrogate,
-      title={Surrogate-Assisted Inverse Design of Integrated Intermodal-Phase-Matched
-             NbOCl2 Biphoton Quantum Light Sources using Physics-Informed Deep Learning},
-      author={Islam I. Abdulaal and Omar A. M. Abdelraouf},
-      year={2024},
-      eprint={2411.18733},
-      archivePrefix={arXiv},
-      primaryClass={quant-ph},
-      url={https://arxiv.org/abs/2411.18733}
-}
-```
+---
 
-### Dataset (DOI: 10.57967/hf/9066)
-```bibtex
-@misc{abdulaal2026nanophotonet_dataset,
-    author       = {Islam I. Abdulaal},
-    title        = {{NanoPhotoNet-MPM} Dataset},
-    year         = 2026,
-    doi          = {10.57967/hf/9066},
-    publisher    = {Hugging Face}
-}
-```
+## Citation
 
-### Model Weights (DOI: 10.57967/hf/9068)
 ```bibtex
-@misc{abdulaal2026nanophotonet_model,
-    author       = {Islam I. Abdulaal},
-    title        = {NanoPhotoNet-MPM Model Checkpoints},
-    year         = 2026,
-    doi          = {10.57967/hf/9068},
-    publisher    = {Hugging Face}
+@misc{abdulaal2026nanophotonet_dataset,
+  author    = {Islam I. Abdulaal},
+  title     = {{NanoPhotoNet-MPM} Dataset},
+  year      = {2026},
+  publisher = {Hugging Face},
+  doi       = {10.57967/hf/9066},
+  url       = {https://doi.org/10.57967/hf/9066}
 }
 ```