How-to Guides#
Practical step-by-step guides for the more experienced user.
- Build the docs using sphinx
- Contribute to the project
- How to check code coverage
- Creating a new beamline
- Creating a new device
- Reusing an existing class
- Writing a device class
- Setup Developer Environment
- How to embed Excalidraw diagrams
- How to Write External IO Devices
- Run linting using pre-commit
- Lock requirements
- Make a release
- Moving code from another repo
- Setting up PyPI publishing
- Running tests
- Run static analysis using pyright or mypy
- How to update to the latest template structure
- Writing Tests in This Python Project
- Zocalo Interaction
- Zocalo Service