Metadata-Version: 2.4
Name: aurelia
Version: 0.1.0
Summary: Simulate realistic ARPES spectra with experimental artifacts for analysis and machine-learning applications.
Author: Matteo Michiardi
Author-email: MengXing Na <mengxing.na@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/qmlab-ubc-ca/aurelia
Project-URL: Documentation, https://github.com/qmlab-ubc-ca/aurelia/wiki
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.21
Requires-Dist: matplotlib>=3.5
Requires-Dist: scipy>=1.10
Requires-Dist: h5py>=3.8
Dynamic: license-file

# aurelia
*Simulate realistic ARPES spectra with experimental artifacts for analysis and machine-learning applications.*

Developed by MengXing Na and Matteo Michiardi.  

[![PyPI version](https://badge.fury.io/py/aurelia.svg)](https://pypi.org/project/aurelia/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

---

## Features

- Generate randomized tight-binding band structures — or import your own  
- Compute spectral functions, including Fermi-liquid and electron-boson kink-like self-energies  
- Add experimental effects: offset angles, rotations, flake domains, background, and detector sensitivities  
- Simulate ARPES spectra statistically across many electron events  

## Installation

You can install `aurelia` directly from PyPI:

```bash
pip install aurelia
```
## Usage

See the [examples](examples/) folder for sample scripts to get started.  
Full documentation is available on the [Wiki](https://github.com/qmlab-ubc-ca/aurelia/wiki).

## License

This project is licensed under the MIT License — see the LICENSE file for details.

## Contact

For questions not covered in the documentation, or for collaborations, feel free to reach out: mengxing.na@gmail.com
---




