Skip to content

New ESS instruments docs page#111

Merged
nvaytet merged 8 commits intomainfrom
new-instruments-docs-page
Dec 11, 2025
Merged

New ESS instruments docs page#111
nvaytet merged 8 commits intomainfrom
new-instruments-docs-page

Conversation

@nvaytet
Copy link
Copy Markdown
Member

@nvaytet nvaytet commented Dec 10, 2025

No description provided.

Comment thread docs/ess-instruments.ipynb Outdated
"\n",
"instruments = {\n",
" \"Odin\": {\n",
" \"facility\": \"ess-odin\",\n",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
" \"facility\": \"ess-odin\",\n",
" \"facility\": \"ess\",\n",

?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

No, odin has a specific source that was measured in mcstas at the entrance of the beamport which is called ess-odin.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ok, I would have expected that to be separate from 'facility'. But if you have no need for encoding a facility itself, then that should be fine.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Maybe i'll just make a single source for everyone, will reduce notebook build time.
ess or ess-odin won't make a difference for this notebook.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

But it is important to show that there is a dedicated source for odin. And people should probably use that one, right?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Would it help if I documented the facility argument better in the docstring, or make a docs page listing the available sources?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Both would be useful. I think people are more likely to find the new docs page, so I'd focus on that.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The old pages had a lot more content, e.g., examples of computing wavelength. Why did you remove those?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes, but that info is also in the https://scipp.github.io/tof/wfm.html notebook, so it felt very redundant...

@nvaytet nvaytet merged commit fa7a784 into main Dec 11, 2025
4 checks passed
@nvaytet nvaytet deleted the new-instruments-docs-page branch December 11, 2025 15:12
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.

2 participants