README.md

# Multi-Modal Materials Characterization Pipeline

This repository contains a **Gradio app for Hugging Face Spaces** that provides automated analysis of multi-modal materials characterization data using the Universal Fiber Bundle framework.

## Features

- **XRD Analysis**: Phase identification, crystallite size, microstrain
- **VSM Analysis**: Coercivity, remanence, magnetic phase detection
- **UV-Vis Analysis**: Bandgap estimation, absorption edge analysis
- **PL Analysis**: Emission peak detection, defect state analysis
- **TEM/SEM Analysis**: Particle size distribution, morphology
- **Cross-Modal Correlations**: Quantum confinement, defect-magnetism relationships
- **Community Dataset**: Anonymized results contribute to a public dataset

## Data Requirements

### XRD, VSM, UV-Vis, PL
- CSV files with columns:
  - XRD: `2theta`, `intensity`
  - VSM: `H`, `M`
  - UV-Vis: `wavelength`, `absorption`
  - PL: `wavelength`, `intensity`

### TEM/SEM
- Image files (PNG, JPG, TIFF) with scale bar (1 pixel = 1 nm assumed)

## Deployment

1. Create a Hugging Face account and dataset repository
2. Update `HF_DATASET_REPO` in `app.py`
3. Deploy to Hugging Face Spaces

## Usage

1. Upload your data files
2. Provide a sample name
3. Click "Analyze Sample"
4. View the scientific report and plots
5. Optionally contribute results to the public dataset

## Citation

If you use this tool in your research, please cite: