https://github.com/diamondlightsource/davidia
React component and web endpoints for scientific data visualization.
https://github.com/diamondlightsource/davidia
cli fastapi gui python react
Last synced: 4 months ago
JSON representation
React component and web endpoints for scientific data visualization.
- Host: GitHub
- URL: https://github.com/diamondlightsource/davidia
- Owner: DiamondLightSource
- License: mit
- Created: 2022-07-18T08:39:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-09-26T09:49:27.000Z (5 months ago)
- Last Synced: 2025-09-26T11:35:06.582Z (5 months ago)
- Topics: cli, fastapi, gui, python, react
- Language: TypeScript
- Homepage: https://diamondlightsource.github.io/davidia/
- Size: 8.75 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Davidia
Davidia comprises two parts: a plot server and a set of React components including a connected plot. The plot server has a REST api that allows clients to visualize data in connected plots in React applications.
## Demonstrating Davidia
Prepare a clean Python 3.10+ installation (this may be a conda or a virtual environment) then install the Davidia Python package with
### `pip install "davidia[all]"`
To start the demo, run
### `dvd-demo`
This starts the plot server, opens a browser window and runs a demo script that shows different plots. Note there are host and port settings available - read the builtin help with `dvd-demo -h`
## Running Python plot server (with bundled example client)
### `dvd-server -c`
Open [localhost:8000](http://localhost:8000) to view it in the browser. Now test plot server with,
### `python -m davidia.demos`
## Benchmarking the plot client
Set the environment variable `DVD_BENCHMARK` as `on` or add a `-b` argument:
### `dvd-server -c -b`
Run the script to trigger benchmarks:
### `dvd-benchmark`
See its builtin help using the `-h` argument.
## Storybook
View the Storybook [here](https://diamondlightsource.github.io/davidia).
## Frontend documentation
View the frontend Typescript documentation [here](https://diamondlightsource.github.io/davidia/typedocs/index.html).
## REST API documentation
View the REST API documentation [here](https://diamondlightsource.github.io/davidia/?path=/docs/api-documentation--docs).