bluesky / bluesky-webclient

A React Material UI based web client developed in TypeScript to enable acquisition of data on the web with bluesky

Bluesky — An Experiment Specification & Orchestration Engine

Source	https://github.com/bluesky/bluesky
PyPI	pip install bluesky
Documentation	https://bluesky.github.io/bluesky
Releases	https://github.com/bluesky/bluesky/releases

Bluesky is a library for experiment control and collection of scientific data and metadata. It emphasizes the following virtues:

• Live, Streaming Data: Available for inline visualization and processing.
• Rich Metadata: Captured and organized to facilitate reproducibility and searchability.
• Experiment Generality: Seamlessly reuse a procedure on completely different hardware.
• Interruption Recovery: Experiments are "rewindable," recovering cleanly from interruptions.
• Automated Suspend/Resume: Experiments can be run unattended, automatically suspending and resuming if needed.
• Pluggable I/O: Export data (live) into any desired format or database.
• Customizability: Integrate custom experimental procedures and commands, and get the I/O and interruption features for free.
• Integration with Scientific Python: Interface naturally with numpy and Python scientific stack.

Bluesky Documentation.

The Bluesky Project enables experimental science at the lab-bench or facility scale. It is a collection of Python libraries that are co-developed but independently useful and may be adopted a la carte.

Bluesky Project Documentation.

See https://bluesky.github.io/bluesky for more detailed documentation.

bluesky-webclient's Issues

Submitting and running a plan

Now that we have a base it is important to get to a minimum viable product defined by:

• Button to add a plan
• Ability to choose between allowed plans
• Ability to edit some parameters in the plan
• Creation of an acquisition environment
• Starting, pausing, stopping the processing of the queue
• Viewing the currently executing plan

There are other features that must follow, and pretty soon after this it will be useful to sketch this out for a minimal real beamline. This doesn't attempt to visualize any data at this stage, and concentrates on what already appears to be presently available as part of the queueserver API.

Add queue_stop instruction

bluesky/bluesky-queueserver#93 adds an instruction called queue_stop which can be inserted into the queue to pause the queue when it is executed. Let's add support for this on the GUI.

Clicking up/down on items in queue expands

Clicking up/down on items in queue expands the accordion

Parameter inputs don't show up first time

The first time that a plan is selected from the Queue Items list the parameter input widgets are not visible.

Collapse button for items in the History list

We need a "Collapse" button to minimize all open cards in the History list to quickly close potentially a large number of expanded cards.

We discussed with @gwbischof that having an "Expand" button may bring an expensive operation, so at this time we will not be adding it. Alternatively, the "Expand" button may maximize only visible cards. That's an acceptable option.

State isn't totally cleared when switching between plan forms.

State from one plan can get added to another plan

Fix the way pause instructions look in the queue

FIx the way pause instructions look in the queue.
Currently they just show a uid, this isn't very meaningful.

Detailed view of the queue

Make another object like PlanList that also shows detailed information about each queue item without the need to expand.

Button to clear the history

Make the history of plans panel wider + add table

We need better-structured data displayed in the history of plans. The panel should be wider, or expandable, and should contain records in a tabular form, so that not only a uid[:8] is displayed, but also a timestamp and other useful info (scan_id, detectors, motors, etc.)

"Open Environment" button on Home page is misfunctional

When it's pressed on the "Home" page, the following message is appearing in the uvicorn log:

INFO:     127.0.0.1:65479 - "POST /environment/undefined HTTP/1.1" 404 Not Found

It works fine while pressed on the "Acquire" page.

Stream console output from RE worker

Current plan feedback

Display information about the currently running plan.

Establish TypeScript/JavaScript code style conventions

Now that more of us are writing TypeScript/JavaScript code we should establish coding conventions, and maybe look at how we can automatically use some of the conventions. I would suggest using camelCase for functions/variable names, and capitalized CamelCase for class names. I think four spaces is conventional, and we should probably use either lower case filenames or (as seems more prevalent) CamelCase.tsx for classes etc. I already see Python snake_case sneaking in and making things look inconsistent.

Document this solution

This was the solution to difficulties at BMM.

https://stackoverflow.com/a/66450161/1221924

Queue status feedback

Display queue status

Add a button to remove items from parameters list

Currently there is a + button to add an additional value to a parameter that is a list. There should also be a button to reduce the number of items in the list.

Beautify XAS form

Task for the 5LS demo.

General UI polish

Task for 5LS demo.

• Make bluesky-web-client console logging quieter or more configurable
• If anything is in the History, the web app burns 0.5 CPU doing nothing
• More things Tom noticed…

Integrating with facility API - showing useful data

Creating this as a tracker for what the acquisition web client might want to pull from a facility API. These are just initial ideas that could use more input from @stuartcampbell and @JunAishima. Initial ideas:

• Obtain a data_session_id from the facility API for the current set of runs
• Obtain related data to the session such as the proposal_id, saf_id, etc
• Obtain and display useful beamline information in the interface such as name, location, contact details for relevant staff, emergency phone/email in case of issues, current status of ?

Ideally some of these things would be obtainable in prototype API that might be hardwired, along with the link to get it, i.e. the queueserver would certainly know a beamline identifier such as its FXI, HXN, etc, that would then be used to call facility API to get more information to display about the active beamline. The beamline and user identifiers might be enough to get the proposal identifier, etc.

Login

Get login working

Add Bluesky logo

Add the bluesky logo to the GUI

pip installs as UNKNOWN

With pip install git+https://github.com/bluesky/bluesky-webclient, this package installs as UNKNOWN-0.0.0.dist-info.

Since it's not yet on PyPI or a conda package, I mindlessly installed with pip from github, as above. The packaging needs attention. Realize this is pre-release but the concept has captured the attention of the APS now.

Previews using tiled

display the current queue to the user

Display the currently pending queue to the user formatted in a way that is understandable to a human.

This is a pre-requisite to bluesky/bluesky-queueserver#17 .

Provide more details about the items in the queue

Currently we can only see the uid of the item in the queue. I think it would be useful to the more information, similar to the list of historical plans.

Show error message explaining why plan is not accepted by the queue

Edit queue items

Edit items that are already in the queue.

Enable CI for this repo

It would be great to enable CI for this repo (on TravisCI or Azure Pipelines). We'll need the manager/server running to test the client side.

User material-ui component for unordered list

@cryos: "If you look at App.tsx, the unordered list there, I had been meaning to make that into a component that can be reused on multiple pages, and to use the Material-UI list component instead of the default ul, li etc, i.e. https://material-ui.com/components/lists/"

Bulk plan submission

Support addition of items to the queue from an excel sheet

Improve the layout of GenericPlanForm

Improve the layout of the GenericPlanForm so that less scrolling is needed.