Installation#
Requirements#
Python ≥ 3.10
Install from PyPI#
pip install ad_hoc_diffractometer
Install for development#
git clone https://github.com/BCDA-APS/ad_hoc_diffractometer
cd ad_hoc_diffractometer
pip install -e .[dev]
Install documentation dependencies#
pip install -e .[doc]
Install all optional dependencies#
pip install -e .[all]
Build the documentation locally#
cd docs
make html
The built HTML is written to docs/build/html/.
Open docs/build/html/index.html in a browser to view it.
Verify the installation#
After installing, run the short example on the Demonstration Geometries Quick start page to confirm the package is working end-to-end.