Metadata-Version: 2.4
Name: esrf_id10_surf
Version: 0.1.7
Summary: A package for analyzing surface X-ray scattering data from the ID10-SURF beamline at the ESRF.
Author-email: "Egor A. Bersenev" <egor.bersenev@esrf.fr>
Project-URL: Homepage, https://chelberserker.github.io/ESRF_ID10_SURF/
Project-URL: Documentation, https://chelberserker.github.io/ESRF_ID10_SURF/
Project-URL: Repository, https://github.com/chelberserker/ESRF_ID10_SURF
Keywords: X-ray reflectivity,reflectometry,ESRF-ID10-SURF,ESRF ID10,ESRF,ID10,X-ray,reflectivity,GID,XRR,Grazing Incidence Diffraction,GISAXS,GIXS
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: h5py
Requires-Dist: lmfit
Requires-Dist: scipy
Requires-Dist: orsopy
Requires-Dist: PyYAML
Dynamic: license-file

[![PyPI version](https://img.shields.io/pypi/v/esrf_id10_surf.svg)](https://pypi.org/project/esrf_id10_surf/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python Versions](https://img.shields.io/pypi/pyversions/esrf_id10_surf.svg)](https://pypi.org/project/esrf_id10_surf/)

# ESRF ID10-SURF Data Analysis

This package provides a collection of tools for analyzing surface X-ray scattering data from the ID10-SURF beamline at the European Synchrotron Radiation Facility (ESRF).

## Features

*   **XRR (X-ray Reflectivity):** Process and analyze X-ray reflectivity data obtained with a 2D pixel detector
*   **GID (Grazing Incidence Diffraction):** Process and analyze grazing incidence diffraction data taken with a linear detector
*   **GIS(W)AXS (Grazing Incidence Small(Wide)-Angle X-ray Scattering):** (Under development)

## Installation

To install the package use pip:

```bash
pip install esrf-id10-surf
```

If you would like to install the library and modify the code to see the effects immediately:

```bash
git clone https://github.com/chelberserker/ESRF_ID10_SURF
cd ESRF_ID10_SURF
pip install -e .
```

## Usage

Detailed documentation and usage examples can be found here:

https://chelberserker.github.io/ESRF_ID10_SURF/
