Metadata-Version: 2.4
Name: blop
Version: 1.0.0b1
Summary: Beamline optimization with machine learning
Project-URL: Homepage, https://github.com/bluesky/blop
Project-URL: Documentation, https://nsls-ii.github.io/blop
Project-URL: Bug Reports, https://github.com/bluesky/blop/issues
Author-email: Max Rakitin <mrakitin@bnl.gov>, Thomas Morris <tmorris@bnl.gov>, Thomas Hopkins <thopkins1@bnl.gov>
Maintainer-email: Max Rakitin <mrakitin@bnl.gov>, Thomas Morris <tmorris@bnl.gov>, Thomas Hopkins <thopkins1@bnl.gov>, Jessica Moylan <jmoylan1@bnl.gov>, Jennefer Maldonado <jmaldonad@bnl.gov>, Roman Chernikov <rcherniko@bnl.gov>
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: ax-platform<1.3,>=1.1.0
Requires-Dist: bluesky-queueserver-api>=0.0.12
Requires-Dist: bluesky>=1.14.2
Requires-Dist: botorch>=0.16.0
Requires-Dist: gpytorch
Requires-Dist: networkx>=3
Requires-Dist: numpy
Requires-Dist: rich>=13
Requires-Dist: scipy
Requires-Dist: torch
Provides-Extra: cpu
Provides-Extra: dev
Requires-Dist: bluesky-queueserver-api; extra == 'dev'
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: ipykernel; extra == 'dev'
Requires-Dist: nbstripout; extra == 'dev'
Requires-Dist: pandas-stubs; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pyright; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: qs
Requires-Dist: bluesky-queueserver-api; extra == 'qs'
Description-Content-Type: text/markdown

# Blop - Beamline Optimization Package

[![Testing](https://github.com/bluesky/blop/actions/workflows/ci.yml/badge.svg)](https://github.com/bluesky/blop/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/bluesky/blop/branch/main/graph/badge.svg)](https://codecov.io/gh/bluesky/blop)
[![PyPI](https://img.shields.io/pypi/v/blop.svg)](https://pypi.python.org/pypi/blop)
[![Conda](https://img.shields.io/conda/vn/conda-forge/blop.svg)](https://anaconda.org/conda-forge/blop)

- Free software: 3-clause BSD license
- Documentation: <https://NSLS-II.github.io/blop>.

## Installation

```bash
pip install blop
```

or with conda:

```bash
conda install -c conda-forge blop
```

## Development

A devcontainer is available with OpenCode and Pixi pre-installed. To use it:

```bash
./launch-devcontainer.sh
```

Or open in VS Code and select "Reopen in Container".

## Citation

If you use this package in your work, please cite the following paper:

```bibtex
@Article{Morris2024,
  author   = {Morris, Thomas W. and Rakitin, Max and Du, Yonghua and Fedurin, Mikhail and Giles, Abigail C. and Leshchev, Denis and Li, William H. and Romasky, Brianna and Stavitski, Eli and Walter, Andrew L. and Moeller, Paul and Nash, Boaz and Islegen-Wojdyla, Antoine},
  journal  = {Journal of Synchrotron Radiation},
  title    = {{A general Bayesian algorithm for the autonomous alignment of beamlines}},
  year     = {2024},
  month    = {Nov},
  number   = {6},
  pages    = {1446--1456},
  volume   = {31},
  doi      = {10.1107/S1600577524008993},
  keywords = {Bayesian optimization, automated alignment, synchrotron radiation, digital twins, machine learning},
  url      = {https://doi.org/10.1107/S1600577524008993},
}
```
