Davidia

Create a conda environment called davidia

conda env create --file environment.yml

Activate it:

conda activate davidia

Install Typescript dependencies (read pnpm's installation guide, if needed)

pnpm install

Build web client

pnpm build

Running Python plot server

From the top level of the repository, you can run:

cd server && uvicorn --factory davidia.main:create_app or PYTHONPATH=server python server/davidia/main.py -c

Open localhost:8000/client to view it in the browser. Now test plot server with,

PYTHONPATH=server python server/davidia/simple.py

Benchmarking the plot client

Set the environment variable DVD_BENCHMARK as on or add a -b argument:

DVD_BENCHMARK=on PYTHONPATH=server python server/davidia/main.py

PYTHONPATH=server python server/davidia/main.py -c -b

Run the script to trigger benchmarks:

PYTHONPATH=server python server/davidia/demos/benchmark.py

See its builtin help using the -h argument.

Storybook

View the Storybook here.

To build and run the Storybook locally:

pnpm build:storybook

pnpm start:storybook

Documentation

View the documentation here.

API documentation

View the API documentation here.