From 3286e26072cb0b20dce0a53ff051f26f49969773 Mon Sep 17 00:00:00 2001 From: Padraic Shafer <76011594+padraic-shafer@users.noreply.github.com> Date: Sat, 14 Oct 2023 08:09:58 -0700 Subject: [PATCH 1/4] Create template for related projects --- references/related_projects.md | 89 ++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 references/related_projects.md diff --git a/references/related_projects.md b/references/related_projects.md new file mode 100644 index 0000000..7dd464d --- /dev/null +++ b/references/related_projects.md @@ -0,0 +1,89 @@ +# Related Projects + +An annotated list of related web UI projects in use or under development +for experiment controls or data acquisition/exploration/analysis/visualization. + +Innevitably the commentary here will contain subjective opionions. +Here we should strive to reflect a consensus opinion of the project maintainers, +with an emphasis on the technical aspects of reviewed projects. + +## Experiment Control & Data Browsing + +### Bluesky WebClient + +_Description._ + +| Pros | Cons | +| --- | --- | +| TBA | TBA | + +#### Notes +TBA + +### Daiquiri UI + +_Description._ + +| Pros | Cons | +| --- | --- | +| TBA | TBA | + +#### Notes +TBA + +### Davidia + +_Description._ + +| Pros | Cons | +| --- | --- | +| TBA | TBA | + +#### Notes +TBA + +### Diamond Light Source's Web UI Components + +_Description._ + +| Pros | Cons | +| --- | --- | +| TBA | TBA | + +#### Notes +TBA + +### React Automation Studio + +_Description._ + +| Pros | Cons | +| --- | --- | +| TBA | TBA | + +#### Notes +TBA + +## General Data Dashboards + +### H20 Wave + +_Description._ + +| Pros | Cons | +| --- | --- | +| TBA | TBA | + +#### Notes +TBA + +### Plotly Dash + +_Description._ + +| Pros | Cons | +| --- | --- | +| TBA | TBA | + +#### Notes +TBA From f70c989045f69dee4ad6ee35e572e9cfd81a2290 Mon Sep 17 00:00:00 2001 From: Padraic Shafer <76011594+padraic-shafer@users.noreply.github.com> Date: Sat, 14 Oct 2023 08:24:19 -0700 Subject: [PATCH 2/4] Add content from Issue #1 to related_projects.md --- references/related_projects.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/references/related_projects.md b/references/related_projects.md index 7dd464d..a063a67 100644 --- a/references/related_projects.md +++ b/references/related_projects.md @@ -11,71 +11,76 @@ with an emphasis on the technical aspects of reviewed projects. ### Bluesky WebClient -_Description._ +_TypeScript React app using Material UI for a Bluesky queueserver client. A prototype for data collection._ | Pros | Cons | | --- | --- | | TBA | TBA | #### Notes -TBA +* Project repo: [bluesky/bluesky-webclient](https://github.com/bluesky/bluesky-webclient) ### Daiquiri UI -_Description._ +_Daiquiri UI is the web based javascript User Interface for [Daiquiri](https://gitlab.esrf.fr/ui/daiquiri), the beamline control and data acquisition framework. It is built in React with Redux and is modular in design, allowing it to be adapted to many different beamline setups and requirements._ | Pros | Cons | | --- | --- | | TBA | TBA | #### Notes -TBA +* NOBUGS 2002 [presentation](https://www.youtube.com/watch?v=QdwANxtdLcY) + [slides](https://docs.google.com/presentation/d/e/2PACX-1vTACrCEOHQet3UdppgSIr-Kx5lvs8qzttHTcwyCC3zijSs5q4PYUrjv6hEWoQUmzsz94pItpiwN4_6w/pub?start=false&slide=id.p) by Stu Fisher (ESRF) +* [Daiquiri](https://gitlab.esrf.fr/ui/daiquiri) -- _Daiquiri is a python based framework for beamline control and data acquisition. It is controls system agnostic accessing hardware and scans through interfaces. It exposes a REST and Websockets API that can be consumed via the web or any other client._ ### Davidia -_Description._ +_React component and web endpoints for scientific data visualization._ | Pros | Cons | | --- | --- | | TBA | TBA | #### Notes -TBA +* Project repo: [DiamondLightSource/davidia](https://github.com/DiamondLightSource/davidia) +* A plotting subsystem similar to h5web -### Diamond Light Source's Web UI Components +### Diamond Light Source's Web UI Components Library -_Description._ +_Generic components for React based Diamond web apps._ | Pros | Cons | | --- | --- | | TBA | TBA | #### Notes -TBA +* Project repo: [DiamondLightSource/web-ui-components](https://github.com/DiamondLightSource/web-ui-components) +* Storybook: ### React Automation Studio -_Description._ +_React Automation Studio is a new software platform to enable the control of large scientific equipment through EPICS.._ | Pros | Cons | | --- | --- | | TBA | TBA | #### Notes -TBA +* Project repo: [React-Automation-Studio/React-Automation-Studio](https://github.com/React-Automation-Studio/React-Automation-Studio) +* Presented at ICALEPCS; "FR2BCO01: React Automation Studio: Modern Scientific Control With the Web", ## General Data Dashboards ### H20 Wave -_Description._ +_Realtime Web Apps and Dashboards for Python and R._ +_H2O Wave is a software stack for building beautiful, low-latency, realtime, browser-based applications and dashboards entirely in Python without using HTML, Javascript, or CSS. It excels at capturing data, visualizations, and graphics from multiple sources and broadcasting them live over the web._ | Pros | Cons | | --- | --- | | TBA | TBA | #### Notes -TBA +* Project repo: [h2oai/wave](https://github.com/h2oai/wave) ### Plotly Dash From f9fa462c509240e353789744a12f56749b1757f0 Mon Sep 17 00:00:00 2001 From: Padraic Shafer <76011594+padraic-shafer@users.noreply.github.com> Date: Sat, 21 Oct 2023 17:40:17 -0700 Subject: [PATCH 3/4] Add CS Web to related_projects.md --- references/related_projects.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/references/related_projects.md b/references/related_projects.md index a063a67..9434d40 100644 --- a/references/related_projects.md +++ b/references/related_projects.md @@ -20,6 +20,19 @@ _TypeScript React app using Material UI for a Bluesky queueserver client. A prot #### Notes * Project repo: [bluesky/bluesky-webclient](https://github.com/bluesky/bluesky-webclient) +### CS Web + +_React-based prototype to display control system data on web pages; and an npm library for Control Systems web applications._ + +| Pros | Cons | +| --- | --- | +| TBA | TBA | + +#### Notes +* Project repos: + * [dls-controls/cs-web-proto](https://github.com/dls-controls/cs-web-proto) + * [dls-controls/cs-web-lib](https://github.com/dls-controls/cs-web-lib) + ### Daiquiri UI _Daiquiri UI is the web based javascript User Interface for [Daiquiri](https://gitlab.esrf.fr/ui/daiquiri), the beamline control and data acquisition framework. It is built in React with Redux and is modular in design, allowing it to be adapted to many different beamline setups and requirements._ From dd576f2ef563fa562717a3de3c8fc12e6554a70a Mon Sep 17 00:00:00 2001 From: Padraic Shafer <76011594+padraic-shafer@users.noreply.github.com> Date: Sat, 21 Oct 2023 17:52:14 -0700 Subject: [PATCH 4/4] Add WASM section to related_projects.md --- references/related_projects.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/references/related_projects.md b/references/related_projects.md index 9434d40..730f9a1 100644 --- a/references/related_projects.md +++ b/references/related_projects.md @@ -105,3 +105,9 @@ _Description._ #### Notes TBA + +## WASM Output from General GUI Libraries + +### [WebGui]([url](https://github.com/jnmaloney/WebGui)) (IMGUI) + +_An example project showing how to use [Dear ImGui]([url](https://github.com/ocornut/imgui)https://github.com/ocornut/imgui) in a web browser_