Metadata-Version: 2.4
Name: nereids
Version: 0.1.1
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Dist: numpy>=1.26
Requires-Dist: nereids-gui==0.1.1 ; extra == 'gui'
Requires-Dist: fastmcp>=3.0 ; extra == 'mcp'
Provides-Extra: gui
Provides-Extra: mcp
License-File: LICENSE
Summary: Neutron Resonance Imaging Data Analysis Library
Keywords: neutron,resonance,imaging,endf,cross-section,spectroscopy
Author-email: ORNL Neutron Imaging <neutronimaging@ornl.gov>
License-Expression: BSD-3-Clause
Requires-Python: >=3.10
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Homepage, https://github.com/ornlneutronimaging/NEREIDS
Project-URL: Issues, https://github.com/ornlneutronimaging/NEREIDS/issues
Project-URL: Repository, https://github.com/ornlneutronimaging/NEREIDS

# NEREIDS

**N**eutron r**E**sonance **RE**solved **I**maging **D**ata analysis **S**ystem

[![Docs](https://img.shields.io/badge/docs-guide-blue)](https://ornlneutronimaging.github.io/NEREIDS/)
[![API](https://img.shields.io/badge/docs-rustdoc-orange)](https://ornlneutronimaging.github.io/NEREIDS/api/nereids_pipeline/)

A Rust-based library for neutron resonance imaging at the VENUS beamline, SNS, ORNL.

## Documentation

- **[User Guide](https://ornlneutronimaging.github.io/NEREIDS/)** -- Installation, quickstart, architecture
- **[API Reference](https://ornlneutronimaging.github.io/NEREIDS/api/nereids_pipeline/)** -- Rustdoc for all crates

## Overview

NEREIDS provides end-to-end analysis for time-of-flight neutron resonance imaging:
input hyperspectral TOF data, output spatially resolved isotopic/elemental
composition maps.

## Workspace Crates

| Crate | Description |
|-------|-------------|
| `nereids-core` | Core types, physical constants, traits |
| `nereids-endf` | ENDF file retrieval, caching, resonance parameter parsing |
| `nereids-physics` | Cross-section calculation, broadening, transmission model |
| `nereids-io` | TIFF/NeXus data I/O, VENUS normalization |
| `nereids-fitting` | Optimization engine (LM, Poisson/BFGS) |
| `nereids-pipeline` | End-to-end orchestration and spatial mapping |
| `nereids-python` | PyO3 Python bindings for Jupyter |
| `nereids-gui` | egui desktop application |

## Building

```bash
cargo build --workspace
cargo test --workspace
```

## License

BSD-3-Clause. See [LICENSE](LICENSE) for details.

