# EstraPy

EstraPy is a synchrotron data analysis framework, built in Python 3.

Synchrotron facilities produce X-ray diffraction and spectroscopy data used in materials science, crystallography, and structural biology research. EstraPy provides a command-line framework for analyzing this data using simple, readable input files.

[Examples](https://github.com/ramsteak/EstraPy/tree/main/example)
[View on GitHub](https://github.com/ramsteak/EstraPy)

---

## Key Features

- **Simple Input Syntax** - Write analysis workflows in plain text `.estra` files
- **Comprehensive Data Handling** - Import, process, and export synchrotron data formats
- **Automated Plotting** - Generate publication-ready visualizations
- **Command-Line Workflow** - Execute analysis scripts with a single command
- **Extensible** - Modular design for custom analysis pipelines

---

## Quick Start

**Requirements:** Python 3.11+

Install EstraPy and run your first analysis:

````bash
pip install estrapy
estrapy analysis.estra
````

See the Quick Start Guide for a complete walkthrough.

---

## About the Project

EstraPy is &copy; 2024-2026 by [Marco Stecca](https://github.com/ramsteak).

### License

EstraPy is distributed under an [MIT license](https://github.com/ramsteak/EstraPy/blob/main/LICENSE).

### Contributing

To report issues with the program, create a new [issue](https://github.com/ramsteak/EstraPy/issues) on GitHub. Please include:

- Your input `.estra` file
- Relevant data files
- The output log file
- Python version and operating system

For feature requests and general discussion, visit the [Discussions](https://github.com/ramsteak/EstraPy/discussions) page.
