NSLS-II Beamline Support Library

The NSLS-II Beamline Support Library (nbs-bl) provides core functionality for beamline operation and control at NSLS-II.

Features

• Beamline configuration management

• Device control and monitoring

• Scan plans and utilities

• Simulation capabilities

Getting Started

To install nbs-bl:

pip install -e .

Documentation

Contents:

• Overview of nbs-bl
  • What is nbs-bl?
  • Beamline Components
  • Core Functionality
  • Ecosystem Integration
  • Key Advantages
  • Use Cases
• Getting Started with nbs-bl
  • Prerequisites
  • Installation
  • First Steps
  • Next Steps
  • Common Issues
  • Where to Go Next
  • Note
• Beamline Configuration Reference
  • Overview
  • beamline.toml Reference
  • devices.toml Reference
  • Best Practices
  • Configuration Validation
  • Common Issues and Solutions

Configuration

The library uses TOML configuration files to define beamline devices and settings:

• Beamline Configuration Reference - Detailed guide to configuring your beamline

• Beamline Template - Template for beamline.toml

• Devices Template - Template for devices.toml

Development

This project is part of the xraygui organization on GitHub.