Metadata-Version: 2.3
Name: beambusters
Version: 3.1.0
Summary: 
Author: Ana Rodrigues
Author-email: anananacr@gmail.com
Requires-Python: >=3.10,<4.0
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
Requires-Dist: abstract (==2022.7.10)
Requires-Dist: base32hex (==1.0.2)
Requires-Dist: bblib (==3.1.0)
Requires-Dist: black (==24.1.1)
Requires-Dist: build (==1.0.3)
Requires-Dist: cachecontrol (==0.14.0)
Requires-Dist: certifi (==2024.2.2)
Requires-Dist: cffi (==1.16.0)
Requires-Dist: charset-normalizer (==3.3.2)
Requires-Dist: cleo (==2.1.0)
Requires-Dist: click (==8.1.7)
Requires-Dist: colouration (==2020.7.26)
Requires-Dist: contourpy (==1.2.0)
Requires-Dist: crashtest (==0.4.1)
Requires-Dist: cryptography (==42.0.5)
Requires-Dist: cycler (==0.12.1)
Requires-Dist: cython (==3.0.8)
Requires-Dist: distlib (==0.3.8)
Requires-Dist: dulwich (==0.21.7)
Requires-Dist: fabio (==2023.10.0)
Requires-Dist: fastjsonschema (==2.19.1)
Requires-Dist: filelock (==3.13.1)
Requires-Dist: fonttools (==4.48.1)
Requires-Dist: graphviz (==0.20.1)
Requires-Dist: h5py (==3.10.0)
Requires-Dist: hdf5plugin (==4.4.0)
Requires-Dist: idna (==3.6)
Requires-Dist: imageio (==2.33.1)
Requires-Dist: importlib-metadata (==7.0.1)
Requires-Dist: installer (==0.7.0)
Requires-Dist: jaraco-classes (==3.3.1)
Requires-Dist: jeepney (==0.8.0)
Requires-Dist: keyring (==24.3.0)
Requires-Dist: kiwisolver (==1.4.5)
Requires-Dist: lazy-loader (==0.3)
Requires-Dist: llvmlite (>=0.44.0,<0.45.0)
Requires-Dist: lxml (==5.1.0)
Requires-Dist: markdown-it-py (==3.0.0)
Requires-Dist: matplotlib (==3.8.2)
Requires-Dist: mdurl (==0.1.2)
Requires-Dist: more-itertools (==10.2.0)
Requires-Dist: msgpack (==1.0.7)
Requires-Dist: msgpack-numpy (==0.4.8)
Requires-Dist: mypy-extensions (==1.0.0)
Requires-Dist: networkx (==3.2.1)
Requires-Dist: numpy (==1.26.4)
Requires-Dist: ondamonitor (==23.8.3)
Requires-Dist: packaging (==23.2)
Requires-Dist: pandas (==2.2.0)
Requires-Dist: pexpect (==4.9.0)
Requires-Dist: pillow (==10.2.0)
Requires-Dist: pkginfo (==1.9.6)
Requires-Dist: platformdirs (==4.2.0)
Requires-Dist: ptyprocess (==0.7.0)
Requires-Dist: pycparser (==2.21)
Requires-Dist: pygments (==2.17.2)
Requires-Dist: pyparsing (==3.1.1)
Requires-Dist: pyproject-hooks (==1.0.0)
Requires-Dist: python-dateutil (==2.8.2)
Requires-Dist: pytz (==2024.1)
Requires-Dist: pyyaml (==6.0.1)
Requires-Dist: pyzmq (==25.1.2)
Requires-Dist: rapidfuzz (==3.6.1)
Requires-Dist: requests (==2.31.0)
Requires-Dist: requests-toolbelt (==1.0.0)
Requires-Dist: rich (==13.7.0)
Requires-Dist: ruamel-yaml (==0.18.6)
Requires-Dist: ruamel-yaml-clib (==0.2.8)
Requires-Dist: scikit-image (==0.22.0)
Requires-Dist: scipy (==1.12.0)
Requires-Dist: secretstorage (==3.3.3)
Requires-Dist: shellingham (==1.5.4)
Requires-Dist: six (==1.16.0)
Requires-Dist: tifffile (==2024.2.12)
Requires-Dist: tomli (==2.0.1)
Requires-Dist: tomlkit (==0.12.3)
Requires-Dist: trove-classifiers (==2024.2.23)
Requires-Dist: typer (==0.9.0)
Requires-Dist: typing-extensions (==4.10.0)
Requires-Dist: tzdata (==2024.1)
Requires-Dist: urllib3 (==2.2.1)
Requires-Dist: virtualenv (==20.25.1)
Requires-Dist: zipp (==3.17.0)
Description-Content-Type: text/markdown

# beambusters

[![PyPI pyversions](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/release/python-3100/)

Beambusters is an application developed to determine the detector center directly from still diffraction patterns collected in serial crystallography experiments.

Beambusters uses the methods implemented in bblib to calculate the detector center shift in each diffraction pattern, according to your initial detector geometry (CrystFEL format).

You can find more information about bblib on [this page](https://anananacr.github.io/bblib/).

## Installation

To install beambusters, run the following command in a terminal:

```bash
pip install beambusters
```

## Usage

To run beambusters, use the following command in your terminal:

```bash
beambusters run_centering /path/to/list/file /path/to/config/file
```

The configuration file uses the YAML format. An example of a configuration file can be found [on this page](https://anananacr.github.io/beambusters/example/config/#example).


## Contact

Ana Carolina Rodrigues led the development of Beambusters from 2021 to 2025 at the Deutsches Elektronen-Synchrotron (DESY) in Hamburg, Germany.

For questions, please contact:

**Email**: sc.anarodrigues@gmail.com

