Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API documentation for non-spreadsheet runs #20

Open
pbeaucage opened this issue Mar 1, 2023 · 3 comments
Open

API documentation for non-spreadsheet runs #20

pbeaucage opened this issue Mar 1, 2023 · 3 comments
Assignees

Comments

@pbeaucage
Copy link
Collaborator

It is frequently desired or required to run RSoXS scans outside the context of a spreadsheet, for example:

  • when using user-supplied holders in the TEM port
  • (hypothetical) when using user-supplied sample holders in the traditional positioning port
  • performing alignment-type scans that are outside the envisioned scope of the rsoxs_scans package, for example grazing incidence, CDSAXS-style rotation series, HDR exposure series for DAFS-style RSoXS measurements, etc.

This is presently medium-level supported by the existing scan scheme, full_carbon_scan, etc.

Is API-level access to this package possible?
If so, can some documentation be generated of how rsoxs_scans is used to interactively conduct scans from an ipython session or similar, rather than through spreadsheets?
If not, will API support for the legacy RSoXS scans be maintained indefinitely?

@EliotGann
Copy link
Member

yes, there are plans which wrap these in the rsoxs module. do_rsoxs, do_spiral, do_nexafs. each with kwargs of the column names should work just the same as from the spreadsheet. the legacy RSoXS scans have been removed and there is no plan to allow them back currently.

@EliotGann
Copy link
Member

https://github.com/NSLS-II-SST/rsoxs/blob/new-scan-scheme/rsoxs/Functions/rsoxs_plans.py is the integration of the beamline code to this repo

@EliotGann
Copy link
Member

I understand that this is essentially blueskyifying bluesky ... we need a message bus to run our message bus to run our message bus ...

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

No branches or pull requests

3 participants