Update README.md

README.md

@@ -1,3 +1,179 @@
----
-license: mit
----
+
+```yaml
+---
+language: 
+  - en
+size_categories:
+  - 50K<n<100K
+license: mit
+task_categories:
+  - tabular-regression
+tags:
+  - photonics
+  - waveguide
+  - optical
+  - dataset
+  - synthetic
+  - thermal-analysis
+dataset_info:
+  features:
+    - name: waveguide_material
+      dtype: string
+    - name: cladding_material
+      dtype: string
+    - name: waveguide_width
+      dtype: float
+    - name: waveguide_height
+      dtype: float
+    - name: temperature_min
+      dtype: float
+    - name: temperature_max
+      dtype: float
+    - name: temperature_step
+      dtype: float
+    - name: thermal_expansion_coefficient
+      dtype: float
+    - name: thermal_conductivity
+      dtype: float
+    - name: refractive_index_core
+      dtype: float
+    - name: refractive_index_cladding
+      dtype: float
+    - name: propagation_loss_min
+      dtype: float
+    - name: propagation_loss_max
+      dtype: float
+    - name: effective_index_min
+      dtype: float
+    - name: effective_index_max
+      dtype: float
+    - name: dn_dT
+      dtype: float
+    - name: thermal_tuning_efficiency
+      dtype: float
+    - name: thermal_stress
+      dtype: float
+    - name: strain_rate
+      dtype: float
+    - name: optical_power_input
+      dtype: float
+    - name: optical_power_output_min
+      dtype: float
+    - name: optical_power_output_max
+      dtype: float
+    - name: wavelength_min
+      dtype: float
+    - name: wavelength_max
+      dtype: float
+    - name: simulation_model
+      dtype: string
+    - name: measurement_uncertainty
+      dtype: float
+dataset_size: 100000
+dataset_version: "1.0.0"
+---
+```
+
+# Thermal Stability Dataset 🔥❄️
+
+> **Description**  
+> This dataset provides **100,000 synthetic rows** of data for analyzing **thermal stability** in photonic waveguides. It tracks key parameters, such as material properties, optical losses, and refractive index changes under varying thermal conditions. Ideal for simulation and optimization of photonic devices.
+
+## Key Highlights ✨
+- **Focus**: Thermal behavior of waveguides under varying environmental conditions.  
+- **Columns**: 26 structured columns capturing material properties, geometric dimensions, and thermal-optical effects.  
+- **Size**: 100,000 rows suitable for training machine learning models or validating designs.  
+- **Use Cases**:  
+  - **Thermal stability analysis** for waveguides and photonic chips.  
+  - **Thermo-optic device optimization**.  
+  - **Simulation of thermal crosstalk** in integrated photonic systems.  
+
+## Dataset Structure 🏗️
+Each row corresponds to a **single simulation or measurement configuration** for a waveguide, including:
+
+1. **Material Properties**  
+   - `waveguide_material`: Core material (e.g., Silicon Nitride).  
+   - `cladding_material`: Cladding material (e.g., Silicon Dioxide).  
+
+2. **Waveguide Dimensions**  
+   - `waveguide_width` (µm): Width of the waveguide core.  
+   - `waveguide_height` (µm): Height of the waveguide core.
+
+3. **Thermal Parameters**  
+   - `temperature_min` (°C): Minimum temperature.  
+   - `temperature_max` (°C): Maximum temperature.  
+   - `temperature_step` (°C): Increment for simulations.  
+   - `thermal_expansion_coefficient` (1/K): Expansion due to temperature.  
+   - `thermal_conductivity` (W/m·K): Heat transfer ability.
+
+4. **Optical Performance**  
+   - `refractive_index_core` and `refractive_index_cladding`: Core and cladding indices at room temperature.  
+   - `propagation_loss_min` and `propagation_loss_max` (dB/cm): Losses at min and max temperatures.  
+   - `effective_index_min` and `effective_index_max`: Mode index at temperature limits.  
+   - `dn_dT` (1/°C): Change in effective index with temperature.  
+   - `thermal_tuning_efficiency` (%): Efficiency of thermal tuning.
+
+5. **Environmental and Operational**  
+   - `thermal_stress` (MPa): Stress induced by temperature changes.  
+   - `strain_rate` (1/°C): Dimensional changes per degree.  
+   - `optical_power_input` (mW): Power at waveguide input.  
+   - `optical_power_output_min` and `optical_power_output_max` (mW): Output power at temperature limits.  
+
+6. **Simulation and Metadata**  
+   - `wavelength_min` and `wavelength_max` (nm): Operating wavelength range.  
+   - `simulation_model`: Method used (e.g., FEM, FDTD).  
+   - `measurement_uncertainty` (%): Error margin.
+
+---
+
+## Example Row
+```text
+waveguide_material            = Silicon Nitride (Si₃N₄)  
+cladding_material             = Silicon Dioxide (SiO₂)  
+waveguide_width               = 1.0  
+waveguide_height              = 0.5  
+temperature_min               = -20.0  
+temperature_max               = 150.0  
+temperature_step              = 5.0  
+thermal_expansion_coefficient = 2.8e-6  
+thermal_conductivity          = 18.5  
+refractive_index_core         = 1.980  
+refractive_index_cladding     = 1.450  
+propagation_loss_min          = 0.15  
+propagation_loss_max          = 0.35  
+effective_index_min           = 1.950  
+effective_index_max           = 1.970  
+dn_dT                         = 0.0002  
+thermal_tuning_efficiency     = 75.0  
+thermal_stress                = 45.0  
+strain_rate                   = 3e-6  
+optical_power_input           = 5.0  
+optical_power_output_min      = 4.8  
+optical_power_output_max      = 4.6  
+wavelength_min                = 1260.0  
+wavelength_max                = 1625.0  
+simulation_model              = FDTD  
+measurement_uncertainty       = 1.5  
+```
+
+## Citation & Acknowledgments 🙌
+If you use this dataset in your research or applications, please cite it as follows:
+
+```bibtex
+@misc{thermal-stability-dataset_2025,
+  title  = {Thermal Stability Dataset (Synthetic)},
+  author = {https://huggingface.co/Taylor658},
+  year   = {2025},
+  how published = {\url{https://huggingface.co/datasets/Taylor658/thermal-stability}}
+}
+```
+---
+
+## License 📄
+This dataset is available under the **MIT License**. Free to use for commercial or academic purposes with attribution.
+
+---
+
+## Contributing ❄️🔥
+- Add features for new waveguide materials.  
+