Skip to content

Add notebook on how to use the config client inside dodal#1860

Open
jacob720 wants to merge 1 commit intomainfrom
config_server_notebook
Open

Add notebook on how to use the config client inside dodal#1860
jacob720 wants to merge 1 commit intomainfrom
config_server_notebook

Conversation

@jacob720
Copy link
Contributor

@jacob720 jacob720 commented Jan 26, 2026

Fixes #ISSUE

Instructions to reviewer on how to test:

  1. Open up notebook
  2. Check instructions make sense

Checks for reviewer

  • Would the PR title make sense to a scientist on a set of release notes
  • If a new device has been added does it follow the standards
  • If changing the API for a pre-existing device, ensure that any beamlines using this device have updated their Bluesky plans accordingly
  • Have the connection tests for the relevant beamline(s) been run via dodal connect ${BEAMLINE}

@jacob720 jacob720 requested a review from a team as a code owner January 26, 2026 14:24
@codecov
Copy link

codecov bot commented Jan 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.07%. Comparing base (0ce884c) to head (6498fd6).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1860   +/-   ##
=======================================
  Coverage   99.07%   99.07%           
=======================================
  Files         294      294           
  Lines       11254    11254           
=======================================
  Hits        11150    11150           
  Misses        104      104           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Villtord
Copy link
Contributor

Villtord commented Feb 9, 2026

Looks fine except there are no examples of output, e.g. from executing cell with "detector_config.get_column_names()"- is it meant to be so?

@Villtord
Copy link
Contributor

Villtord commented Feb 9, 2026

wait a sec, how to include it in doc build? I did "tox -e docs" but it didn't seem to appear in buld/html/tutorials, so not included in built docs.

"id": "4aa10347",
"metadata": {},
"source": [
"Now we can use the `get_file_contents` method to retrieve a config file's contents. Here you should provide the filepath of the file to read, and your desired return type."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to add what kind of error error message you could get if file doesn't exist or return type doesn't match due to configuration being wrong on daq-config-server or requested the wrong thing on dodal side?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments